[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\external\custom_report_columns_sorting_exporter;
  28  
  29  /**
  30   * External method for retrieving report column sorting
  31   *
  32   * @package     core_reportbuilder
  33   * @copyright   2021 Paul Holden <paulh@moodle.com>
  34   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class get extends external_api {
  37  
  38      /**
  39       * External method parameters
  40       *
  41       * @return external_function_parameters
  42       */
  43      public static function execute_parameters(): external_function_parameters {
  44          return new external_function_parameters([
  45              'reportid' => new external_value(PARAM_INT, 'Report ID'),
  46          ]);
  47      }
  48  
  49      /**
  50       * External method execution
  51       *
  52       * @param int $reportid
  53       * @return array
  54       */
  55      public static function execute(int $reportid): array {
  56          global $PAGE;
  57  
  58          [
  59              'reportid' => $reportid,
  60          ] = self::validate_parameters(self::execute_parameters(), [
  61              'reportid' => $reportid,
  62          ]);
  63  
  64          $report = manager::get_report_from_id($reportid);
  65  
  66          self::validate_context($report->get_context());
  67          permission::require_can_edit_report($report->get_report_persistent());
  68  
  69          $exporter = new custom_report_columns_sorting_exporter(null, [
  70              'report' => $report,
  71          ]);
  72  
  73          return (array) $exporter->export($PAGE->get_renderer('core'));
  74      }
  75  
  76      /**
  77       * External method return value
  78       *
  79       * @return external_single_structure
  80       */
  81      public static function execute_returns(): external_single_structure {
  82          return custom_report_columns_sorting_exporter::get_read_structure();
  83      }
  84  }