mirrored from git://git.moodle.org/moodle.git
/
external.php
107 lines (93 loc) · 3.28 KB
/
external.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* IMSCP external API
*
* @package mod_imscp
* @category external
* @copyright 2015 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.0
*/
defined('MOODLE_INTERNAL') || die;
require_once("$CFG->libdir/externallib.php");
/**
* IMSCP external functions
*
* @package mod_imscp
* @category external
* @copyright 2015 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.0
*/
class mod_imscp_external extends external_api {
/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 3.0
*/
public static function view_imscp_parameters() {
return new external_function_parameters(
array(
'imscpid' => new external_value(PARAM_INT, 'imscp instance id')
)
);
}
/**
* Simulate the imscp/view.php web interface page: trigger events, completion, etc...
*
* @param int $imscpid the imscp instance id
* @return array of warnings and status result
* @since Moodle 3.0
* @throws moodle_exception
*/
public static function view_imscp($imscpid) {
global $DB, $CFG;
require_once($CFG->dirroot . "/mod/imscp/lib.php");
$params = self::validate_parameters(self::view_imscp_parameters(),
array(
'imscpid' => $imscpid
));
$warnings = array();
// Request and permission validation.
$imscp = $DB->get_record('imscp', array('id' => $params['imscpid']), '*', MUST_EXIST);
list($course, $cm) = get_course_and_cm_from_instance($imscp, 'imscp');
$context = context_module::instance($cm->id);
self::validate_context($context);
require_capability('mod/imscp:view', $context);
// Call the imscp/lib API.
imscp_view($imscp, $course, $cm, $context);
$result = array();
$result['status'] = true;
$result['warnings'] = $warnings;
return $result;
}
/**
* Returns description of method result value
*
* @return external_description
* @since Moodle 3.0
*/
public static function view_imscp_returns() {
return new external_single_structure(
array(
'status' => new external_value(PARAM_BOOL, 'status: true if success'),
'warnings' => new external_warnings()
)
);
}
}