moodle/enrol/self/classes/deleteselectedusers_operation.php
2018-04-04 08:55:54 +08:00

99 lines
3.4 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/>.
/**
* A bulk operation for the self enrolment plugin to delete selected users enrolments.
*
* @package enrol_self
* @copyright 2018 Farhan Karmali
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/**
* A bulk operation for the self enrolment plugin to delete selected users enrolments.
*
* @package enrol_self
* @copyright 2018 Farhan Karmali
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class enrol_self_deleteselectedusers_operation extends enrol_bulk_enrolment_operation {
/**
* Returns the title to display for this bulk operation.
*
* @return string
*/
public function get_identifier() {
return 'deleteselectedusers';
}
/**
* Returns the identifier for this bulk operation. This is the key used when the plugin
* returns an array containing all of the bulk operations it supports.
*
* @return string
*/
public function get_title() {
return get_string('deleteselectedusers', 'enrol_manual');
}
/**
* Returns a enrol_bulk_enrolment_operation extension form to be used
* in collecting required information for this operation to be processed.
*
* @param string|moodle_url|null $defaultaction
* @param mixed $defaultcustomdata
* @return enrol_manual_editselectedusers_form
*/
public function get_form($defaultaction = null, $defaultcustomdata = null) {
if (!array($defaultcustomdata)) {
$defaultcustomdata = array();
}
$defaultcustomdata['title'] = $this->get_title();
$defaultcustomdata['message'] = get_string('confirmbulkdeleteenrolment', 'enrol_self');
$defaultcustomdata['button'] = get_string('unenrolusers', 'enrol_self');
return new enrol_self_deleteselectedusers_form($defaultaction, $defaultcustomdata);
}
/**
* Processes the bulk operation request for the given userids with the provided properties.
*
* @param course_enrolment_manager $manager
* @param array $users
* @param stdClass $properties The data returned by the form.
*/
public function process(course_enrolment_manager $manager, array $users, stdClass $properties) {
if (!has_capability("enrol/self:unenrol", $manager->get_context())) {
return false;
}
foreach ($users as $user) {
foreach ($user->enrolments as $enrolment) {
$plugin = $enrolment->enrolmentplugin;
$instance = $enrolment->enrolmentinstance;
if ($plugin->allow_unenrol_user($instance, $enrolment)) {
$plugin->unenrol_user($instance, $user->id);
}
}
}
return true;
}
}