| 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\reports;
|
|
|
20 |
|
|
|
21 |
use core_external\external_api;
|
|
|
22 |
use core_external\external_value;
|
|
|
23 |
use core_external\external_single_structure;
|
|
|
24 |
use core_external\external_function_parameters;
|
|
|
25 |
use core_external\external_warnings;
|
|
|
26 |
use core_reportbuilder\manager;
|
|
|
27 |
use core_reportbuilder\permission;
|
|
|
28 |
use core_reportbuilder\event\report_viewed;
|
|
|
29 |
|
|
|
30 |
/**
|
|
|
31 |
* External method to record the viewing of a report
|
|
|
32 |
*
|
|
|
33 |
* @package core_reportbuilder
|
|
|
34 |
* @copyright 2022 Paul Holden <paulh@moodle.com>
|
|
|
35 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
36 |
*/
|
|
|
37 |
class view 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 |
]);
|
|
|
48 |
}
|
|
|
49 |
|
|
|
50 |
/**
|
|
|
51 |
* External method execution
|
|
|
52 |
*
|
|
|
53 |
* @param int $reportid
|
|
|
54 |
* @return array
|
|
|
55 |
*/
|
|
|
56 |
public static function execute(int $reportid): array {
|
|
|
57 |
[
|
|
|
58 |
'reportid' => $reportid,
|
|
|
59 |
] = self::validate_parameters(self::execute_parameters(), [
|
|
|
60 |
'reportid' => $reportid,
|
|
|
61 |
]);
|
|
|
62 |
|
|
|
63 |
$report = manager::get_report_from_id($reportid);
|
|
|
64 |
self::validate_context($report->get_context());
|
|
|
65 |
|
|
|
66 |
$persistent = $report->get_report_persistent();
|
|
|
67 |
permission::require_can_view_report($persistent);
|
|
|
68 |
|
|
|
69 |
// Trigger the report viewed event.
|
|
|
70 |
report_viewed::create_from_object($persistent)->trigger();
|
|
|
71 |
|
|
|
72 |
return [
|
|
|
73 |
'status' => true,
|
|
|
74 |
'warnings' => [],
|
|
|
75 |
];
|
|
|
76 |
}
|
|
|
77 |
|
|
|
78 |
/**
|
|
|
79 |
* External method return value
|
|
|
80 |
*
|
|
|
81 |
* @return external_single_structure
|
|
|
82 |
*/
|
|
|
83 |
public static function execute_returns(): external_single_structure {
|
|
|
84 |
return new external_single_structure([
|
|
|
85 |
'status' => new external_value(PARAM_BOOL, 'Success'),
|
|
|
86 |
'warnings' => new external_warnings(),
|
|
|
87 |
]);
|
|
|
88 |
}
|
|
|
89 |
}
|