| 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 core_external;
|
|
|
18 |
|
|
|
19 |
/**
|
|
|
20 |
* Standard Moodle web service warnings.
|
|
|
21 |
*
|
|
|
22 |
* @package core_external
|
|
|
23 |
* @copyright 2012 Jerome Mouneyrac
|
|
|
24 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
25 |
*/
|
|
|
26 |
class external_warnings extends external_multiple_structure {
|
|
|
27 |
|
|
|
28 |
/**
|
|
|
29 |
* Constructor
|
|
|
30 |
*
|
|
|
31 |
* @param string $itemdesc
|
|
|
32 |
* @param string $itemiddesc
|
|
|
33 |
* @param string $warningcodedesc
|
|
|
34 |
*/
|
|
|
35 |
public function __construct(
|
|
|
36 |
$itemdesc = 'item',
|
|
|
37 |
$itemiddesc = 'item id',
|
|
|
38 |
$warningcodedesc = 'the warning code can be used by the client app to implement specific behaviour'
|
|
|
39 |
) {
|
|
|
40 |
parent::__construct(
|
|
|
41 |
new external_single_structure([
|
|
|
42 |
'item' => new external_value(PARAM_TEXT, $itemdesc, VALUE_OPTIONAL),
|
|
|
43 |
'itemid' => new external_value(PARAM_INT, $itemiddesc, VALUE_OPTIONAL),
|
|
|
44 |
'warningcode' => new external_value(PARAM_ALPHANUM, $warningcodedesc),
|
|
|
45 |
'message' => new external_value(PARAM_RAW, 'untranslated english message to explain the warning'),
|
|
|
46 |
], 'warning'),
|
|
|
47 |
'list of warnings',
|
|
|
48 |
VALUE_OPTIONAL
|
|
|
49 |
);
|
|
|
50 |
}
|
|
|
51 |
}
|