[Summary view]

Differences Between: [Versions 400 and 402] [Versions 401 and 402]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  declare(strict_types=1);
  18  
  19  namespace core_reportbuilder\external\columns\sort;
  20  
  21  use core_external\external_api;
  22  use core_external\external_value;
  23  use core_external\external_single_structure;
  24  use core_external\external_function_parameters;
  25  use core_reportbuilder\manager;
  26  use core_reportbuilder\permission;
  27  use core_reportbuilder\local\helpers\report;
  28  use core_reportbuilder\external\custom_report_columns_sorting_exporter;
  29  
  30  /**
  31   * External method for re-ordering report column sorting
  32   *
  33   * @package     core_reportbuilder
  34   * @copyright   2021 Paul Holden <paulh@moodle.com>
  35   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class reorder extends external_api {
  38  
  39      /**
  40       * External method parameters
  41       *
  42       * @return external_function_parameters
  43       */
  44      public static function execute_parameters(): external_function_parameters {
  45          return new external_function_parameters([
  46              'reportid' => new external_value(PARAM_INT, 'Report ID'),
  47              'columnid' => new external_value(PARAM_INT, 'Column ID'),
  48              'position' => new external_value(PARAM_INT, 'New column sort position'),
  49          ]);
  50      }
  51  
  52      /**
  53       * External method execution
  54       *
  55       * @param int $reportid
  56       * @param int $columnid
  57       * @param int $position
  58       * @return array
  59       */
  60      public static function execute(int $reportid, int $columnid, int $position): array {
  61          global $PAGE;
  62  
  63          [
  64              'reportid' => $reportid,
  65              'columnid' => $columnid,
  66              'position' => $position,
  67          ] = self::validate_parameters(self::execute_parameters(), [
  68              'reportid' => $reportid,
  69              'columnid' => $columnid,
  70              'position' => $position,
  71          ]);
  72  
  73          $report = manager::get_report_from_id($reportid);
  74  
  75          self::validate_context($report->get_context());
  76          permission::require_can_edit_report($report->get_report_persistent());
  77  
  78          report::reorder_report_column_sorting($reportid, $columnid, $position);
  79  
  80          $exporter = new custom_report_columns_sorting_exporter(null, [
  81              'report' => $report,
  82          ]);
  83  
  84          return (array) $exporter->export($PAGE->get_renderer('core'));
  85      }
  86  
  87      /**
  88       * External method return value
  89       *
  90       * @return external_single_structure
  91       */
  92      public static function execute_returns(): external_single_structure {
  93          return custom_report_columns_sorting_exporter::get_read_structure();
  94      }
  95  }