mirror of
https://github.com/moodle/moodle.git
synced 2025-03-09 18:30:03 +01:00
be9bf94e4a
1. core_enrol_get_course_enrolment_methods() which returns all enrolment method instances which implement get_enrol_info() 2. enrol_self_get_instance_info() will return information about self enrolment instance.
101 lines
3.6 KiB
PHP
101 lines
3.6 KiB
PHP
<?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/>.
|
|
|
|
/**
|
|
* Self enrol plugin external functions
|
|
*
|
|
* @package enrol_self
|
|
* @copyright 2013 Rajesh Taneja <rajesh@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
require_once("$CFG->libdir/externallib.php");
|
|
|
|
/**
|
|
* Self enrolment external functions.
|
|
*
|
|
* @package enrol_self
|
|
* @copyright 2012 Rajesh Taneja <rajesh@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @since Moodle 2.6
|
|
*/
|
|
class enrol_self_external extends external_api {
|
|
|
|
/**
|
|
* Returns description of get_instance_info() parameters.
|
|
*
|
|
* @return external_function_parameters
|
|
*/
|
|
public static function get_instance_info_parameters() {
|
|
return new external_function_parameters(
|
|
array('instanceid' => new external_value(PARAM_INT, 'instance id of self enrolment plugin.'))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Return self-enrolment instance information.
|
|
*
|
|
* @param int $instanceid instance id of self enrolment plugin.
|
|
* @return array instance information.
|
|
*/
|
|
public static function get_instance_info($instanceid) {
|
|
global $DB, $CFG;
|
|
|
|
require_once($CFG->libdir . '/enrollib.php');
|
|
|
|
$params = self::validate_parameters(self::get_instance_info_parameters(), array('instanceid' => $instanceid));
|
|
|
|
// Retrieve self enrolment plugin.
|
|
$enrolplugin = enrol_get_plugin('self');
|
|
if (empty($enrolplugin)) {
|
|
throw new moodle_exception('invaliddata', 'error');
|
|
}
|
|
|
|
$enrolinstance = $DB->get_record('enrol', array('id' => $params['instanceid']), '*', MUST_EXIST);
|
|
$coursecontext = context_course::instance($enrolinstance->courseid);
|
|
$categorycontext = $coursecontext->get_parent_context();
|
|
self::validate_context($categorycontext);
|
|
|
|
$instanceinfo = (array) $enrolplugin->get_enrol_info($enrolinstance);
|
|
if (isset($instanceinfo['requiredparam']->enrolpassword)) {
|
|
$instanceinfo['enrolpassword'] = $instanceinfo['requiredparam']->enrolpassword;
|
|
}
|
|
unset($instanceinfo->requiredparam);
|
|
|
|
return $instanceinfo;
|
|
}
|
|
|
|
/**
|
|
* Returns description of get_instance_info() result value.
|
|
*
|
|
* @return external_description
|
|
*/
|
|
public static function get_instance_info_returns() {
|
|
return new external_single_structure(
|
|
array(
|
|
'id' => new external_value(PARAM_INT, 'id of course enrolment instance'),
|
|
'courseid' => new external_value(PARAM_INT, 'id of course'),
|
|
'type' => new external_value(PARAM_PLUGIN, 'type of enrolment plugin'),
|
|
'name' => new external_value(PARAM_RAW, 'name of enrolment plugin'),
|
|
'status' => new external_value(PARAM_RAW, 'status of enrolment plugin'),
|
|
'enrolpassword' => new external_value(PARAM_RAW, 'password required for enrolment', VALUE_OPTIONAL),
|
|
)
|
|
);
|
|
}
|
|
}
|