See Release Notes
Long Term Support Release
Differences Between: [Versions 401 and 402] [Versions 401 and 403]
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 external_api; 22 use external_function_parameters; 23 use external_single_structure; 24 use external_value; 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 defined('MOODLE_INTERNAL') || die(); 31 32 global $CFG; 33 require_once("{$CFG->libdir}/externallib.php"); 34 35 /** 36 * External method for toggling report column sorting 37 * 38 * @package core_reportbuilder 39 * @copyright 2021 Paul Holden <paulh@moodle.com> 40 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 41 */ 42 class toggle extends external_api { 43 44 /** 45 * External method parameters 46 * 47 * @return external_function_parameters 48 */ 49 public static function execute_parameters(): external_function_parameters { 50 return new external_function_parameters([ 51 'reportid' => new external_value(PARAM_INT, 'Report ID'), 52 'columnid' => new external_value(PARAM_INT, 'Column ID'), 53 'enabled' => new external_value(PARAM_BOOL, 'Sort enabled'), 54 'direction' => new external_value(PARAM_INT, 'Sort direction', VALUE_DEFAULT, SORT_ASC), 55 ]); 56 } 57 58 /** 59 * External method execution 60 * 61 * @param int $reportid 62 * @param int $columnid 63 * @param bool $enabled 64 * @param int $direction 65 * @return array 66 */ 67 public static function execute(int $reportid, int $columnid, bool $enabled, int $direction = SORT_ASC): array { 68 global $PAGE; 69 70 [ 71 'reportid' => $reportid, 72 'columnid' => $columnid, 73 'enabled' => $enabled, 74 'direction' => $direction, 75 ] = self::validate_parameters(self::execute_parameters(), [ 76 'reportid' => $reportid, 77 'columnid' => $columnid, 78 'enabled' => $enabled, 79 'direction' => $direction, 80 ]); 81 82 $report = manager::get_report_from_id($reportid); 83 84 self::validate_context($report->get_context()); 85 permission::require_can_edit_report($report->get_report_persistent()); 86 87 report::toggle_report_column_sorting($reportid, $columnid, $enabled, $direction); 88 89 $exporter = new custom_report_columns_sorting_exporter(null, [ 90 'report' => $report, 91 ]); 92 93 return (array) $exporter->export($PAGE->get_renderer('core')); 94 } 95 96 /** 97 * External method return value 98 * 99 * @return external_single_structure 100 */ 101 public static function execute_returns(): external_single_structure { 102 return custom_report_columns_sorting_exporter::get_read_structure(); 103 } 104 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body