mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 06:18:28 +01:00
210 lines
8.0 KiB
PHP
210 lines
8.0 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/>.
|
|
|
|
/**
|
|
* External course participation api.
|
|
*
|
|
* This api is mostly read only, the actual enrol and unenrol
|
|
* support is in each enrol plugin.
|
|
*
|
|
* @package enrol_manual
|
|
* @category external
|
|
* @copyright 2011 Jerome Mouneyrac
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
require_once("$CFG->libdir/externallib.php");
|
|
|
|
/**
|
|
* Manual enrolment external functions.
|
|
*
|
|
* @package enrol_manual
|
|
* @category external
|
|
* @copyright 2011 Jerome Mouneyrac
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @since Moodle 2.2
|
|
*/
|
|
class enrol_manual_external extends external_api {
|
|
|
|
/**
|
|
* Returns description of method parameters.
|
|
*
|
|
* @return external_function_parameters
|
|
* @since Moodle 2.2
|
|
*/
|
|
public static function enrol_users_parameters() {
|
|
return new external_function_parameters(
|
|
array(
|
|
'enrolments' => new external_multiple_structure(
|
|
new external_single_structure(
|
|
array(
|
|
'roleid' => new external_value(PARAM_INT, 'Role to assign to the user'),
|
|
'userid' => new external_value(PARAM_INT, 'The user that is going to be enrolled'),
|
|
'courseid' => new external_value(PARAM_INT, 'The course to enrol the user role in'),
|
|
'timestart' => new external_value(PARAM_INT, 'Timestamp when the enrolment start', VALUE_OPTIONAL),
|
|
'timeend' => new external_value(PARAM_INT, 'Timestamp when the enrolment end', VALUE_OPTIONAL),
|
|
'suspend' => new external_value(PARAM_INT, 'set to 1 to suspend the enrolment', VALUE_OPTIONAL)
|
|
)
|
|
)
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Enrolment of users.
|
|
*
|
|
* Function throw an exception at the first error encountered.
|
|
* @param array $enrolments An array of user enrolment
|
|
* @since Moodle 2.2
|
|
*/
|
|
public static function enrol_users($enrolments) {
|
|
global $DB, $CFG;
|
|
|
|
require_once($CFG->libdir . '/enrollib.php');
|
|
|
|
$params = self::validate_parameters(self::enrol_users_parameters(),
|
|
array('enrolments' => $enrolments));
|
|
|
|
$transaction = $DB->start_delegated_transaction(); // Rollback all enrolment if an error occurs
|
|
// (except if the DB doesn't support it).
|
|
|
|
// Retrieve the manual enrolment plugin.
|
|
$enrol = enrol_get_plugin('manual');
|
|
if (empty($enrol)) {
|
|
throw new moodle_exception('manualpluginnotinstalled', 'enrol_manual');
|
|
}
|
|
|
|
foreach ($params['enrolments'] as $enrolment) {
|
|
// Ensure the current user is allowed to run this function in the enrolment context.
|
|
$context = context_course::instance($enrolment['courseid'], IGNORE_MISSING);
|
|
self::validate_context($context);
|
|
|
|
// Check that the user has the permission to manual enrol.
|
|
require_capability('enrol/manual:enrol', $context);
|
|
|
|
// Throw an exception if user is not able to assign the role.
|
|
$roles = get_assignable_roles($context);
|
|
if (!array_key_exists($enrolment['roleid'], $roles)) {
|
|
$errorparams = new stdClass();
|
|
$errorparams->roleid = $enrolment['roleid'];
|
|
$errorparams->courseid = $enrolment['courseid'];
|
|
$errorparams->userid = $enrolment['userid'];
|
|
throw new moodle_exception('wsusercannotassign', 'enrol_manual', '', $errorparams);
|
|
}
|
|
|
|
// Check manual enrolment plugin instance is enabled/exist.
|
|
$enrolinstances = enrol_get_instances($enrolment['courseid'], true);
|
|
foreach ($enrolinstances as $courseenrolinstance) {
|
|
if ($courseenrolinstance->enrol == "manual") {
|
|
$instance = $courseenrolinstance;
|
|
break;
|
|
}
|
|
}
|
|
if (empty($instance)) {
|
|
$errorparams = new stdClass();
|
|
$errorparams->courseid = $enrolment['courseid'];
|
|
throw new moodle_exception('wsnoinstance', 'enrol_manual', $errorparams);
|
|
}
|
|
|
|
// Check that the plugin accept enrolment (it should always the case, it's hard coded in the plugin).
|
|
if (!$enrol->allow_enrol($instance)) {
|
|
$errorparams = new stdClass();
|
|
$errorparams->roleid = $enrolment['roleid'];
|
|
$errorparams->courseid = $enrolment['courseid'];
|
|
$errorparams->userid = $enrolment['userid'];
|
|
throw new moodle_exception('wscannotenrol', 'enrol_manual', '', $errorparams);
|
|
}
|
|
|
|
// Finally proceed the enrolment.
|
|
$enrolment['timestart'] = isset($enrolment['timestart']) ? $enrolment['timestart'] : 0;
|
|
$enrolment['timeend'] = isset($enrolment['timeend']) ? $enrolment['timeend'] : 0;
|
|
$enrolment['status'] = (isset($enrolment['suspend']) && !empty($enrolment['suspend'])) ?
|
|
ENROL_USER_SUSPENDED : ENROL_USER_ACTIVE;
|
|
|
|
$enrol->enrol_user($instance, $enrolment['userid'], $enrolment['roleid'],
|
|
$enrolment['timestart'], $enrolment['timeend'], $enrolment['status']);
|
|
|
|
}
|
|
|
|
$transaction->allow_commit();
|
|
}
|
|
|
|
/**
|
|
* Returns description of method result value.
|
|
*
|
|
* @return null
|
|
* @since Moodle 2.2
|
|
*/
|
|
public static function enrol_users_returns() {
|
|
return null;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Deprecated manual enrolment external functions.
|
|
*
|
|
* @package enrol_manual
|
|
* @copyright 2011 Jerome Mouneyrac
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @since Moodle 2.0
|
|
* @deprecated Moodle 2.2 MDL-29106 - Please do not use this class any more.
|
|
* @see enrol_manual_external
|
|
*/
|
|
class moodle_enrol_manual_external extends external_api {
|
|
|
|
/**
|
|
* Returns description of method parameters.
|
|
*
|
|
* @return external_function_parameters
|
|
* @since Moodle 2.0
|
|
* @deprecated Moodle 2.2 MDL-29106 - Please do not call this function any more.
|
|
* @see enrol_manual_external::enrol_users_parameters()
|
|
*/
|
|
public static function manual_enrol_users_parameters() {
|
|
return enrol_manual_external::enrol_users_parameters();
|
|
}
|
|
|
|
/**
|
|
* Enrolment of users
|
|
* Function throw an exception at the first error encountered.
|
|
*
|
|
* @param array $enrolments An array of user enrolment
|
|
* @since Moodle 2.0
|
|
* @deprecated Moodle 2.2 MDL-29106 - Please do not call this function any more.
|
|
* @see enrol_manual_external::enrol_users()
|
|
*/
|
|
public static function manual_enrol_users($enrolments) {
|
|
return enrol_manual_external::enrol_users($enrolments);
|
|
}
|
|
|
|
/**
|
|
* Returns description of method result value.
|
|
*
|
|
* @return nul
|
|
* @since Moodle 2.0
|
|
* @deprecated Moodle 2.2 MDL-29106 - Please do not call this function any more.
|
|
* @see enrol_manual_external::enrol_users_returns()
|
|
*/
|
|
public static function manual_enrol_users_returns() {
|
|
return enrol_manual_external::enrol_users_returns();
|
|
}
|
|
|
|
}
|