reportbuilder/amd/src/local/repository/columns.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.  * Module to handle column AJAX requests
  18.  *
  19.  * @module      core_reportbuilder/local/repository/columns
  20.  * @copyright   2021 Paul Holden <paulh@moodle.com>
  21.  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22.  */
  24. import Ajax from 'core/ajax';
  26. /**
  27.  * Add column to given report
  28.  *
  29.  * @param {Number} reportId
  30.  * @param {String} uniqueIdentifier
  31.  * @return {Promise}
  32.  */
  33. export const addColumn = (reportId, uniqueIdentifier) => {
  34.     const request = {
  35.         methodname: 'core_reportbuilder_columns_add',
  36.         args: {reportid: reportId, uniqueidentifier: uniqueIdentifier}
  37.     };
  39.     return Ajax.call([request])[0];
  40. };
  42. /**
  43.  * Remove column from given report
  44.  *
  45.  * @param {Number} reportId
  46.  * @param {Number} columnId
  47.  * @return {Promise}
  48.  */
  49. export const deleteColumn = (reportId, columnId) => {
  50.     const request = {
  51.         methodname: 'core_reportbuilder_columns_delete',
  52.         args: {reportid: reportId, columnid: columnId}
  53.     };
  55.     return Ajax.call([request])[0];
  56. };
  58. /**
  59.  * Re-order column within a report
  60.  *
  61.  * @param {Number} reportId
  62.  * @param {Number} columnId
  63.  * @param {Number} position
  64.  * @return {Promise}
  65.  */
  66. export const reorderColumn = (reportId, columnId, position) => {
  67.     const request = {
  68.         methodname: 'core_reportbuilder_columns_reorder',
  69.         args: {reportid: reportId, columnid: columnId, position: position}
  70.     };
  72.     return Ajax.call([request])[0];
  73. };