Ignore:
Timestamp:
May 2, 2016, 12:09:23 PM (3 years ago)
Author:
jrpelegrina
Message:

Updated to moodle 3.0.3

File:
1 edited

Legend:

Unmodified
Added
Removed
  • moodle/trunk/fuentes/enrol/manual/externallib.php

    r136 r1331  
    157157    }
    158158
     159    /**
     160     * Returns description of method parameters.
     161     *
     162     * @return external_function_parameters
     163     */
     164    public static function unenrol_users_parameters() {
     165        return new external_function_parameters(array(
     166            'enrolments' => new external_multiple_structure(
     167                new external_single_structure(
     168                    array(
     169                        'userid' => new external_value(PARAM_INT, 'The user that is going to be unenrolled'),
     170                        'courseid' => new external_value(PARAM_INT, 'The course to unenrol the user from'),
     171                        'roleid' => new external_value(PARAM_INT, 'The user role', VALUE_OPTIONAL),
     172                    )
     173                )
     174            )
     175        ));
     176    }
     177
     178    /**
     179     * Unenrolment of users.
     180     *
     181     * @param array $enrolments an array of course user and role ids
     182     * @throws coding_exception
     183     * @throws dml_transaction_exception
     184     * @throws invalid_parameter_exception
     185     * @throws moodle_exception
     186     * @throws required_capability_exception
     187     * @throws restricted_context_exception
     188     */
     189    public static function unenrol_users($enrolments) {
     190        global $CFG, $DB;
     191        $params = self::validate_parameters(self::unenrol_users_parameters(), array('enrolments' => $enrolments));
     192        require_once($CFG->libdir . '/enrollib.php');
     193        $transaction = $DB->start_delegated_transaction(); // Rollback all enrolment if an error occurs.
     194        $enrol = enrol_get_plugin('manual');
     195        if (empty($enrol)) {
     196            throw new moodle_exception('manualpluginnotinstalled', 'enrol_manual');
     197        }
     198
     199        foreach ($params['enrolments'] as $enrolment) {
     200            $context = context_course::instance($enrolment['courseid']);
     201            self::validate_context($context);
     202            require_capability('enrol/manual:unenrol', $context);
     203            $instance = $DB->get_record('enrol', array('courseid' => $enrolment['courseid'], 'enrol' => 'manual'));
     204            if (!$instance) {
     205                throw new moodle_exception('wsnoinstance', 'enrol_manual', $enrolment);
     206            }
     207            $user = $DB->get_record('user', array('id' => $enrolment['userid']));
     208            if (!$user) {
     209                throw new invalid_parameter_exception('User id not exist: '.$enrolment['userid']);
     210            }
     211            if (!$enrol->allow_unenrol($instance)) {
     212                throw new moodle_exception('wscannotunenrol', 'enrol_manual', '', $enrolment);
     213            }
     214            $enrol->unenrol_user($instance, $enrolment['userid']);
     215        }
     216        $transaction->allow_commit();
     217    }
     218
     219    /**
     220     * Returns description of method result value.
     221     *
     222     * @return null
     223     */
     224    public static function unenrol_users_returns() {
     225        return null;
     226    }
     227
    159228}
    160229
     
    208277    }
    209278
     279    /**
     280     * Marking the method as deprecated.
     281     *
     282     * @return bool
     283     */
     284    public static function manual_enrol_users_is_deprecated() {
     285        return true;
     286    }
    210287}
Note: See TracChangeset for help on using the changeset viewer.