-
Notifications
You must be signed in to change notification settings - Fork 1
/
externallib.php
138 lines (124 loc) · 4.9 KB
/
externallib.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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<?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/>.
/**
* External webservice template.
*
* @package local_pluginsfetcher
* @copyright 2019 Adrian Perez <[email protected]> {@link https://adrianperez.me}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir . '/externallib.php');
/**
* External webservice functions.
*
* @package local_pluginsfetcher
* @copyright 2019 Adrian Perez <[email protected]> {@link https://adrianperez.me}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class local_pluginsfetcher_external extends external_api {
/**
* Returns description of method parameters.
*
* @return external_function_parameters
*/
public static function get_information_parameters() {
return new external_function_parameters(
array(
'type' => new external_value(PARAM_TEXT, 'The type of plugins to retrieve (optional).', VALUE_DEFAULT, null),
'contribonly' => new external_value(PARAM_INT, 'Get only additional installed (optional)..', VALUE_DEFAULT, null)
)
);
}
/**
* Returns plugins information.
*
* @param string|null $type The plugin type.
* @param int|null $contribonly Include contributed plugins.
* @return array|\core\plugininfo\base[]|string
* @throws dml_exception
* @throws invalid_parameter_exception
* @throws required_capability_exception
*/
public static function get_information(?string $type, ?int $contribonly) {
$syscontext = context_system::instance();
require_capability('moodle/site:config', $syscontext);
$params = self::validate_parameters(self::get_information_parameters(),
array(
'type' => $type,
'contribonly' => $contribonly
)
);
$pluginman = core_plugin_manager::instance();
if (!empty($params['type'])) {
if (!empty($params['contribonly'])) {
// Get additional plugins by type and contrib.
$plugininfo = self::get_plugins_by_parameters($pluginman, $type);
} else {
// Get all plugins by type.
$plugininfo = $pluginman->get_plugins_of_type($type);
}
} else {
if (!empty($params['contribonly'])) {
// Get all plugins by contrib.
$plugininfo = self::get_plugins_by_parameters($pluginman);
} else {
// Get all plugins.
$plugininfo = self::get_plugins_by_parameters($pluginman, null, true);
}
}
return $plugininfo;
}
/**
* Returns description of method result value
*
* @return external_description
*/
public static function get_information_returns() {
return new external_multiple_structure(
new external_single_structure(
array(
'type' => new external_value(PARAM_TEXT, 'The type'),
'name' => new external_value(PARAM_TEXT, 'The name'),
'versiondb' => new external_value(PARAM_TEXT, 'The installed version'),
'release' => new external_value(PARAM_TEXT, 'The installed release')
), 'plugins'
)
);
}
/**
* Retrieves plugin data based on type and contrib.
*
* @param object $pluginman The core plugin manager singleton instance.
* @param string|null $type The plugin type.
* @param bool $contribonly Include contributed plugins.
* @return array
*/
protected static function get_plugins_by_parameters(object $pluginman, $type = null, $contribonly = false): array {
$plugins = array();
$plugininfo = $pluginman->get_plugins();
foreach ($plugininfo as $plugintype => $pluginnames) {
foreach ($pluginnames as $pluginname => $plugin) {
if ($contribonly || ($plugin->type == $type && !$plugin->is_standard()) ||
(is_null($type) && !$plugin->is_standard())) {
$key = $plugintype . '_' . $pluginname;
$plugins[$key] = $plugin;
}
}
}
return $plugins;
}
}