| 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 |
namespace tiny_autosave\external;
|
|
|
18 |
|
|
|
19 |
use core_external\external_api;
|
|
|
20 |
use core_external\external_function_parameters;
|
|
|
21 |
use core_external\external_single_structure;
|
|
|
22 |
use core_external\external_value;
|
|
|
23 |
|
|
|
24 |
/**
|
|
|
25 |
* Web Service to resume an autosave session.
|
|
|
26 |
*
|
|
|
27 |
* @package tiny_autosave
|
|
|
28 |
* @category external
|
|
|
29 |
* @copyright 2022 Andrew Lyons <andrew@nicols.co.uk>
|
|
|
30 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
31 |
*/
|
|
|
32 |
class resume_autosave_session extends external_api {
|
|
|
33 |
/**
|
|
|
34 |
* Returns description of method parameters
|
|
|
35 |
*
|
|
|
36 |
* @return external_function_parameters
|
|
|
37 |
*/
|
|
|
38 |
public static function execute_parameters(): external_function_parameters {
|
|
|
39 |
return new external_function_parameters([
|
|
|
40 |
'contextid' => new external_value(PARAM_INT, 'The context id that owns the editor', VALUE_REQUIRED),
|
|
|
41 |
'pagehash' => new external_value(PARAM_ALPHANUMEXT, 'The page hash', VALUE_REQUIRED),
|
|
|
42 |
'pageinstance' => new external_value(PARAM_ALPHANUMEXT, 'The page instance', VALUE_REQUIRED),
|
|
|
43 |
'elementid' => new external_value(PARAM_RAW, 'The ID of the element', VALUE_REQUIRED),
|
|
|
44 |
'draftid' => new external_value(
|
|
|
45 |
PARAM_INT,
|
|
|
46 |
'The new draft item id to resume files to',
|
|
|
47 |
VALUE_REQUIRED,
|
|
|
48 |
null,
|
|
|
49 |
NULL_ALLOWED
|
|
|
50 |
),
|
|
|
51 |
]);
|
|
|
52 |
}
|
|
|
53 |
|
|
|
54 |
/**
|
|
|
55 |
* Reset the autosave entry for this autosave instance.
|
|
|
56 |
*
|
|
|
57 |
* If not matching autosave area could be found, the function will
|
|
|
58 |
* silently return and this is not treated as an error condition.
|
|
|
59 |
*
|
|
|
60 |
* @param int $contextid The context id of the owner
|
|
|
61 |
* @param string $pagehash The hash of the page
|
|
|
62 |
* @param string $pageinstance The instance id of the page
|
|
|
63 |
* @param string $elementid The id of the element
|
|
|
64 |
* @param int $draftid The id of the draftid to resume to
|
|
|
65 |
* @return null
|
|
|
66 |
*/
|
|
|
67 |
public static function execute(
|
|
|
68 |
int $contextid,
|
|
|
69 |
string $pagehash,
|
|
|
70 |
string $pageinstance,
|
|
|
71 |
string $elementid,
|
|
|
72 |
?int $draftid
|
|
|
73 |
): array {
|
|
|
74 |
|
|
|
75 |
[
|
|
|
76 |
'contextid' => $contextid,
|
|
|
77 |
'pagehash' => $pagehash,
|
|
|
78 |
'pageinstance' => $pageinstance,
|
|
|
79 |
'elementid' => $elementid,
|
|
|
80 |
'draftid' => $draftid,
|
|
|
81 |
] = self::validate_parameters(self::execute_parameters(), [
|
|
|
82 |
'contextid' => $contextid,
|
|
|
83 |
'pagehash' => $pagehash,
|
|
|
84 |
'pageinstance' => $pageinstance,
|
|
|
85 |
'elementid' => $elementid,
|
|
|
86 |
'draftid' => $draftid,
|
|
|
87 |
]);
|
|
|
88 |
|
|
|
89 |
$drafttext = '';
|
|
|
90 |
|
|
|
91 |
// May have been called by a non-logged in user.
|
|
|
92 |
if (isloggedin() && !isguestuser()) {
|
|
|
93 |
$manager = new \tiny_autosave\autosave_manager($contextid, $pagehash, $pageinstance, $elementid);
|
|
|
94 |
$drafttext = $manager->resume_autosave_session($draftid)->drafttext;
|
|
|
95 |
}
|
|
|
96 |
return [
|
|
|
97 |
'drafttext' => $drafttext,
|
|
|
98 |
];
|
|
|
99 |
}
|
|
|
100 |
|
|
|
101 |
/**
|
|
|
102 |
* Describe the return structure of the external service.
|
|
|
103 |
*
|
|
|
104 |
* @return external_single_structure
|
|
|
105 |
*/
|
|
|
106 |
public static function execute_returns(): external_single_structure {
|
|
|
107 |
return new external_single_structure([
|
|
|
108 |
'drafttext' => new external_value(PARAM_RAW, 'The draft text'),
|
|
|
109 |
]);
|
|
|
110 |
}
|
|
|
111 |
}
|