Paul Holden
ab596ec11a
Report conditions allow report creators to limit which data is displayed when the report is viewed. Users viewing the report cannot override these condition values.
107 lines
3.4 KiB
PHP
107 lines
3.4 KiB
PHP
<?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\conditions;
|
|
|
|
use external_api;
|
|
use external_function_parameters;
|
|
use external_single_structure;
|
|
use external_value;
|
|
use core_reportbuilder\manager;
|
|
use core_reportbuilder\permission;
|
|
use core_reportbuilder\external\custom_report_conditions_exporter;
|
|
use core_reportbuilder\local\helpers\report;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
global $CFG;
|
|
require_once("{$CFG->libdir}/externallib.php");
|
|
|
|
/**
|
|
* External method for re-ordering report conditions
|
|
*
|
|
* @package core_reportbuilder
|
|
* @copyright 2021 Paul Holden <paulh@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class reorder 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'),
|
|
'conditionid' => new external_value(PARAM_INT, 'Condition ID'),
|
|
'position' => new external_value(PARAM_INT, 'New condition position')
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* External method execution
|
|
*
|
|
* @param int $reportid
|
|
* @param int $conditionid
|
|
* @param int $position
|
|
* @return array
|
|
*/
|
|
public static function execute(int $reportid, int $conditionid, int $position): array {
|
|
global $PAGE, $OUTPUT;
|
|
|
|
[
|
|
'reportid' => $reportid,
|
|
'conditionid' => $conditionid,
|
|
'position' => $position,
|
|
] = self::validate_parameters(self::execute_parameters(), [
|
|
'reportid' => $reportid,
|
|
'conditionid' => $conditionid,
|
|
'position' => $position,
|
|
]);
|
|
|
|
$report = manager::get_report_from_id($reportid);
|
|
|
|
self::validate_context($report->get_context());
|
|
permission::require_can_edit_report($report->get_report_persistent());
|
|
|
|
report::reorder_report_condition($reportid, $conditionid, $position);
|
|
|
|
// Set current URL and force bootstrap_renderer to initiate moodle page.
|
|
$PAGE->set_url('/');
|
|
$OUTPUT->header();
|
|
$PAGE->start_collecting_javascript_requirements();
|
|
|
|
$exporter = new custom_report_conditions_exporter(null, ['report' => $report]);
|
|
|
|
$export = $exporter->export($PAGE->get_renderer('core'));
|
|
$export->javascript = $PAGE->requires->get_end_code();
|
|
|
|
return (array) $export;
|
|
}
|
|
|
|
/**
|
|
* External method return value
|
|
*
|
|
* @return external_value
|
|
*/
|
|
public static function execute_returns(): external_single_structure {
|
|
return custom_report_conditions_exporter::get_read_structure();
|
|
}
|
|
}
|