moodle/local_webhooks
0
Fork 0
Code Issues Releases Activity

External function to get service data

Browse Source 
Signed-off-by: Valentin Popov <info@valentineus.link>
This commit is contained in:
Valentin Popov
2018-10-29 02:18:56 +04:00
parent 00309285ba
commit 6c31017c8d
1 changed files with 64 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
externallib.php
View File

@@ -24,6 +24,7 @@
defined('MOODLE_INTERNAL') || die();
require_once($CFG->dirroot . '/local/webhooks/lib.php');
require_once($CFG->libdir . '/externallib.php');
/**
@@ -34,4 +35,67 @@ require_once($CFG->libdir . '/externallib.php');
* @package local_webhooks
*/
class local_webhooks_external extends external_api {
/**
* Returns description of method parameters.
*
* @return \external_function_parameters
*
* @since Moodle 2.2
* @since Moodle 2.9 Options available
*/
public static function get_service_parameters() {
return new external_function_parameters(
array(
'serviceid' => new external_value(PARAM_INT, 'Service ID.'),
)
);
}
/**
* Get information about the service.
*
* @param $serviceid
*
* @return array
*
* @since Moodle 2.2
* @since Moodle 2.9 Options available
*
* @throws \dml_exception
* @throws \invalid_parameter_exception
* @throws \moodle_exception
* @throws \restricted_context_exception
*/
public static function get_service($serviceid) {
$parameters = self::validate_parameters(self::get_service_parameters(), array('serviceid' => $serviceid));
$context = context_system::instance();
self::validate_context($context);
return (array) local_webhooks_api::get_service($parameters['serviceid']);
}
/**
* Returns description of method result value.
*
* @return \external_single_structure
*
* @since Moodle 2.2
* @since Moodle 2.9 Options available
*/
public static function get_service_returns() {
return new external_single_structure(
array(
'id' => new external_value(PARAM_INT, 'Service ID.'),
'header' => new external_value(PARAM_RAW, 'Type of outgoing header.'),
'name' => new external_value(PARAM_RAW, 'Name of the service.'),
'point' => new external_value(PARAM_URL, 'Point of delivery of notifications.'),
'status' => new external_value(PARAM_BOOL, 'Current status of the service.'),
'token' => new external_value(PARAM_RAW, 'Token for verification of requests.'),
'events' => new external_multiple_structure(
new external_value(PARAM_RAW, 'Event name.'), 'List of events.'
),
)
);
}
}