Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

declare(strict_types=1);

namespace core_reportbuilder\external\columns\sort;

< use external_api; < use external_function_parameters; < use external_single_structure; < use external_value;
> use core_external\external_api; > use core_external\external_value; > use core_external\external_single_structure; > use core_external\external_function_parameters;
use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\local\helpers\report; use core_reportbuilder\external\custom_report_columns_sorting_exporter;
< < defined('MOODLE_INTERNAL') || die(); < < global $CFG; < require_once("{$CFG->libdir}/externallib.php");
/** * External method for toggling report column sorting * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class toggle extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'columnid' => new external_value(PARAM_INT, 'Column ID'), 'enabled' => new external_value(PARAM_BOOL, 'Sort enabled'), 'direction' => new external_value(PARAM_INT, 'Sort direction', VALUE_DEFAULT, SORT_ASC), ]); } /** * External method execution * * @param int $reportid * @param int $columnid * @param bool $enabled * @param int $direction * @return array */ public static function execute(int $reportid, int $columnid, bool $enabled, int $direction = SORT_ASC): array { global $PAGE; [ 'reportid' => $reportid, 'columnid' => $columnid, 'enabled' => $enabled, 'direction' => $direction, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'columnid' => $columnid, 'enabled' => $enabled, 'direction' => $direction, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); report::toggle_report_column_sorting($reportid, $columnid, $enabled, $direction); $exporter = new custom_report_columns_sorting_exporter(null, [ 'report' => $report, ]); return (array) $exporter->export($PAGE->get_renderer('core')); } /** * External method return value * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return custom_report_columns_sorting_exporter::get_read_structure(); } }