Proyectos de Subversion Moodle

Rev

| Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
1 efrain 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\filters;
20
 
21
use core_external\external_api;
22
use core_external\external_value;
23
use core_external\external_function_parameters;
24
use core_reportbuilder\manager;
25
use core_reportbuilder\permission;
26
use core_reportbuilder\local\helpers\user_filter_manager;
27
 
28
/**
29
 * External method for resetting report filters
30
 *
31
 * @package     core_reportbuilder
32
 * @copyright   2021 Paul Holden <paulh@moodle.com>
33
 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34
 */
35
class reset extends external_api {
36
 
37
    /**
38
     * External method parameters
39
     *
40
     * @return external_function_parameters
41
     */
42
    public static function execute_parameters(): external_function_parameters {
43
        return new external_function_parameters([
44
            'reportid' => new external_value(PARAM_INT, 'Report ID'),
45
            'parameters' => new external_value(PARAM_RAW, 'JSON encoded report parameters', VALUE_DEFAULT, ''),
46
        ]);
47
    }
48
 
49
    /**
50
     * External method execution
51
     *
52
     * @param int $reportid
53
     * @param string $parameters JSON encoded parameters used to re-create the report, for instance for those reports that
54
     *      require parameters as part of their {@see \core_reportbuilder\system_report::can_view} implementation
55
     * @return bool
56
     */
57
    public static function execute(int $reportid, string $parameters = ''): bool {
58
        [
59
            'reportid' => $reportid,
60
            'parameters' => $parameters,
61
        ] = self::validate_parameters(self::execute_parameters(), [
62
            'reportid' => $reportid,
63
            'parameters' => $parameters,
64
        ]);
65
 
66
        $report = manager::get_report_from_id($reportid, (array) json_decode($parameters));
67
        self::validate_context($report->get_context());
68
 
69
        // System report permission is implicitly handled, we need to make sure custom report can be viewed.
70
        $persistent = $report->get_report_persistent();
71
        if ($persistent->get('type') === $report::TYPE_CUSTOM_REPORT) {
72
            permission::require_can_view_report($persistent);
73
        }
74
 
75
        return user_filter_manager::reset_all($reportid);
76
    }
77
 
78
    /**
79
     * External method return value
80
     *
81
     * @return external_value
82
     */
83
    public static function execute_returns(): external_value {
84
        return new external_value(PARAM_BOOL, 'Success');
85
    }
86
}