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