3e43ac949659115167a89f8bc62f763b346e60d1
[moodle.git] / lib / table / amd / src / local / dynamic / repository.js
1 // This file is part of Moodle - http://moodle.org/
2 //
3 // Moodle is free software: you can redistribute it and/or modify
4 // it under the terms of the GNU General Public License as published by
5 // the Free Software Foundation, either version 3 of the License, or
6 // (at your option) any later version.
7 //
8 // Moodle is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 // GNU General Public License for more details.
12 //
13 // You should have received a copy of the GNU General Public License
14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 /**
17  * A javascript module to handle calendar ajax actions.
18  *
19  * @module     core_calendar/repository
20  * @class      repository
21  * @package    core_calendar
22  * @copyright  2017 Simey Lameze <lameze@moodle.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
25 import {call as fetchMany} from 'core/ajax';
27 /**
28  * Fetch table view.
29  *
30  * @method fetch
31  * @param {String} component The component
32  * @param {String} handler The name of the handler
33  * @param {String} uniqueid The unique id of the table
34  * @param {Object} options The options to use when updating the table
35  * @param {Array} options.sortData The list of columns to sort by
36  * @param {Number} options.joinType The filterset join type
37  * @param {Object} options.filters The filters to apply when searching
38  * @param {String} options.firstinitial The first name initial to filter on
39  * @param {String} options.lastinitial The last name initial to filter on
40  * @param {String} options.pageNumber The page number
41  * @param {Number} options.pageSize The page size
42  * @param {Object} options.hiddenColumns The columns to hide
43  * @param {Bool} resetPreferences
44  * @return {Promise} Resolved with requested table view
45  */
46 export const fetch = (component, handler, uniqueid, {
47         sortData = [],
48         joinType = null,
49         filters = {},
50         firstinitial = null,
51         lastinitial = null,
52         pageNumber = null,
53         pageSize = null,
54         hiddenColumns = {}
55     } = {}, resetPreferences = false) => {
56     return fetchMany([{
57         methodname: `core_table_dynamic_fetch`,
58         args: {
59             component,
60             handler,
61             uniqueid,
62             sortdata: sortData,
63             jointype: joinType,
64             filters,
65             firstinitial,
66             lastinitial,
67             pagenumber: pageNumber,
68             pagesize: pageSize,
69             hiddencolumns: hiddenColumns,
70             resetpreferences: resetPreferences
71         },
72     }])[0];
73 };