Permalink
Browse files

MDL-30945 add support for unenrolling of individual users + code cleanup

  • Loading branch information...
1 parent a36531d commit 6357d61912bc84fe179a7344fe6bf21d85ecc391 @skodak skodak committed with stronk7 Dec 28, 2011
View
2 enrol/ajax.php
@@ -63,7 +63,7 @@
case 'unenrol':
$ue = $DB->get_record('user_enrolments', array('id'=>required_param('ue', PARAM_INT)), '*', MUST_EXIST);
list ($instance, $plugin) = $manager->get_user_enrolment_components($ue);
- if (!$instance || !$plugin || !$plugin->allow_unenrol($instance) || !has_capability("enrol/$instance->enrol:unenrol", $manager->get_context()) || !$manager->unenrol_user($ue)) {
+ if (!$instance || !$plugin || !$plugin->allow_unenrol_user($instance, $ue) || !has_capability("enrol/$instance->enrol:unenrol", $manager->get_context()) || !$manager->unenrol_user($ue)) {
throw new enrol_ajax_exception('unenrolnotpermitted');
}
break;
View
2 enrol/bulkchange.php
@@ -31,7 +31,7 @@
$id = required_param('id', PARAM_INT); // course id
$bulkuserop = required_param('bulkuserop', PARAM_ALPHANUMEXT);
-$userids = required_param('bulkuser', PARAM_INT);
+$userids = required_param_array('bulkuser', PARAM_INT);
$action = optional_param('action', '', PARAM_ACTION);
$filter = optional_param('ifilter', 0, PARAM_INT);
View
2 enrol/locallib.php
@@ -506,7 +506,7 @@ public function get_all_groups() {
public function unenrol_user($ue) {
global $DB;
list ($instance, $plugin) = $this->get_user_enrolment_components($ue);
- if ($instance && $plugin && $plugin->allow_unenrol($instance) && has_capability("enrol/$instance->enrol:unenrol", $this->context)) {
+ if ($instance && $plugin && $plugin->allow_unenrol_user($instance, $ue) && has_capability("enrol/$instance->enrol:unenrol", $this->context)) {
$plugin->unenrol_user($instance, $ue->userid);
return true;
}
View
8 enrol/manual/lib.php
@@ -79,7 +79,8 @@ public function get_manual_enrol_link($instance) {
*
* By defaults looks for manage.php file and tests for manage capability.
*
- * @param object $instance
+ * @param navigation_node $instancesnode
+ * @param stdClass $instance
* @return moodle_url;
*/
public function add_course_navigation($instancesnode, stdClass $instance) {
@@ -263,8 +264,8 @@ public function get_user_enrolment_actions(course_enrolment_manager $manager, $u
$instance = $ue->enrolmentinstance;
$params = $manager->get_moodlepage()->url->params();
$params['ue'] = $ue->id;
- if ($this->allow_unenrol($instance) && has_capability("enrol/manual:unenrol", $context)) {
- $url = new moodle_url('/enrol/manual/unenroluser.php', $params);
+ if ($this->allow_unenrol_user($instance, $ue) && has_capability("enrol/manual:unenrol", $context)) {
+ $url = new moodle_url('/enrol/unenroluser.php', $params);
$actions[] = new user_enrolment_action(new pix_icon('t/delete', ''), get_string('unenrol', 'enrol'), $url, array('class'=>'unenrollink', 'rel'=>$ue->id));
}
if ($this->allow_manage($instance) && has_capability("enrol/manual:manage", $context)) {
@@ -276,6 +277,7 @@ public function get_user_enrolment_actions(course_enrolment_manager $manager, $u
/**
* The manual plugin has several bulk operations that can be performed
+ * @param course_enrolment_manager $manager
* @return array
*/
public function get_bulk_operations(course_enrolment_manager $manager) {
View
2 enrol/manual/locallib.php
@@ -348,7 +348,7 @@ public function process(course_enrolment_manager $manager, array $users, stdClas
foreach ($user->enrolments as $enrolment) {
$plugin = $enrolment->enrolmentplugin;
$instance = $enrolment->enrolmentinstance;
- if ($plugin->allow_unenrol($instance)) {
+ if ($plugin->allow_unenrol_user($instance, $enrolment)) {
$plugin->unenrol_user($instance, $user->id);
}
}
View
96 enrol/manual/unenroluser.php
@@ -1,96 +0,0 @@
-<?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/>.
-
-/**
- * Unenrol a user who was enrolled through a manual enrolment.
- *
- * Please note when unenrolling a user all of their grades are removed as well.
- *
- * @package enrol
- * @subpackage manual
- * @copyright 2011 Sam Hemelryk
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-require('../../config.php');
-require_once("$CFG->dirroot/enrol/locallib.php");
-require_once("$CFG->dirroot/enrol/renderer.php");
-
-$ueid = required_param('ue', PARAM_INT); // user enrolment id
-$filter = optional_param('ifilter', 0, PARAM_INT);
-$confirm = optional_param('confirm', false, PARAM_BOOL);
-
-// Get the user enrolment object
-$ue = $DB->get_record('user_enrolments', array('id' => $ueid), '*', MUST_EXIST);
-// Get the user for whom the enrolment is
-$user = $DB->get_record('user', array('id'=>$ue->userid), '*', MUST_EXIST);
-// Get the course the enrolment is to
-list($ctxsql, $ctxjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
-$sql = "SELECT c.* $ctxsql
- FROM {course} c
- LEFT JOIN {enrol} e ON e.courseid = c.id
- $ctxjoin
- WHERE e.id = :enrolid";
-$params = array('enrolid' => $ue->enrolid);
-$course = $DB->get_record_sql($sql, $params, MUST_EXIST);
-context_instance_preload($course);
-
-if ($course->id == SITEID) {
- redirect(new moodle_url('/'));
-}
-
-require_login($course);
-require_capability("enrol/manual:unenrol", get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST));
-
-$manager = new course_enrolment_manager($PAGE, $course, $filter);
-$table = new course_enrolment_users_table($manager, $PAGE);
-
-// The URL of the enrolled users page for the course.
-$usersurl = new moodle_url('/enrol/users.php', array('id' => $course->id));
-// The URl to return the user too after this screen.
-$returnurl = new moodle_url($usersurl, $manager->get_url_params()+$table->get_url_params());
-// The URL of this page
-$url = new moodle_url('/enrol/manual/unenroluser.php', $returnurl->params());
-$url->param('ue', $ueid);
-
-$PAGE->set_url($url);
-$PAGE->set_pagelayout('admin');
-navigation_node::override_active_url($usersurl);
-
-list($instance, $plugin) = $manager->get_user_enrolment_components($ue);
-if (!$plugin->allow_unenrol($instance) || $instance->enrol != 'manual' || !($plugin instanceof enrol_manual_plugin)) {
- print_error('erroreditenrolment', 'enrol');
-}
-
-// If the unenrolment has been confirmed and the sesskey is valid unenrol the user.
-if ($confirm && confirm_sesskey() && $manager->unenrol_user($ue)) {
- redirect($returnurl);
-}
-
-$yesurl = new moodle_url($PAGE->url, array('confirm'=>1, 'sesskey'=>sesskey()));
-$message = get_string('unenroluser', 'enrol_manual', array('user'=>fullname($user, true), 'course'=>format_string($course->fullname)));
-$fullname = fullname($user);
-$title = get_string('unenrol', 'enrol_manual');
-
-$PAGE->set_title($title);
-$PAGE->set_heading($title);
-$PAGE->navbar->add($title);
-$PAGE->navbar->add($fullname);
-
-echo $OUTPUT->header();
-echo $OUTPUT->heading($fullname);
-echo $OUTPUT->confirm($message, $yesurl, $returnurl);
-echo $OUTPUT->footer();
View
2 enrol/self/lib.php
@@ -363,7 +363,7 @@ public function get_user_enrolment_actions(course_enrolment_manager $manager, $u
$params = $manager->get_moodlepage()->url->params();
$params['ue'] = $ue->id;
if ($this->allow_unenrol($instance) && has_capability("enrol/self:unenrol", $context)) {
- $url = new moodle_url('/enrol/self/unenroluser.php', $params);
+ $url = new moodle_url('/enrol/unenroluser.php', $params);
$actions[] = new user_enrolment_action(new pix_icon('t/delete', ''), get_string('unenrol', 'enrol'), $url, array('class'=>'unenrollink', 'rel'=>$ue->id));
}
if ($this->allow_manage($instance) && has_capability("enrol/self:manage", $context)) {
View
101 enrol/self/unenroluser.php
@@ -1,101 +0,0 @@
-<?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/>.
-
-/**
- * Unenrol a user who was enrolled through a self enrolment.
- *
- * @package enrol
- * @subpackage self
- * @copyright 2011 Sam Hemelryk
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-require('../../config.php');
-require_once("$CFG->dirroot/enrol/locallib.php");
-require_once("$CFG->dirroot/enrol/renderer.php");
-
-$ueid = required_param('ue', PARAM_INT); // user enrolment id
-$filter = optional_param('ifilter', 0, PARAM_INT);
-$confirm = optional_param('confirm', false, PARAM_BOOL);
-
-// Get the user enrolment object
-$ue = $DB->get_record('user_enrolments', array('id' => $ueid), '*', MUST_EXIST);
-// Get the user for whom the enrolment is
-$user = $DB->get_record('user', array('id'=>$ue->userid), '*', MUST_EXIST);
-// Get the course the enrolment is to
-list($ctxsql, $ctxjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
-$sql = "SELECT c.* $ctxsql
- FROM {course} c
- LEFT JOIN {enrol} e ON e.courseid = c.id
- $ctxjoin
- WHERE e.id = :enrolid";
-$params = array('enrolid' => $ue->enrolid);
-$course = $DB->get_record_sql($sql, $params, MUST_EXIST);
-context_instance_preload($course);
-
-// Make sure it's not the front page
-if ($course->id == SITEID) {
- redirect(new moodle_url('/'));
-}
-
-// Obviously
-require_login($course);
-// Make sure the user can unenrol self enrolled users.
-require_capability("enrol/self:unenrol", get_context_instance(CONTEXT_COURSE, $course->id));
-
-// Get the enrolment manager for this course
-$manager = new course_enrolment_manager($PAGE, $course, $filter);
-// Get an enrolment users table object. Doign this will automatically retrieve the the URL params
-// relating to table the user was viewing before coming here, and allows us to return the user to the
-// exact page of the users screen they can from.
-$table = new course_enrolment_users_table($manager, $PAGE);
-
-// The URL of the enrolled users page for the course.
-$usersurl = new moodle_url('/enrol/users.php', array('id' => $course->id));
-// The URl to return the user too after this screen.
-$returnurl = new moodle_url($usersurl, $manager->get_url_params()+$table->get_url_params());
-// The URL of this page
-$url = new moodle_url('/enrol/self/unenroluser.php', $returnurl->params());
-$url->param('ue', $ueid);
-
-$PAGE->set_url($url);
-$PAGE->set_pagelayout('admin');
-navigation_node::override_active_url($usersurl);
-
-list($instance, $plugin) = $manager->get_user_enrolment_components($ue);
-if (!$plugin->allow_unenrol($instance) || $instance->enrol != 'self' || !($plugin instanceof enrol_self_plugin)) {
- print_error('erroreditenrolment', 'enrol');
-}
-
-// If the unenrolment has been confirmed and the sesskey is valid unenrol the user.
-if ($confirm && confirm_sesskey() && $manager->unenrol_user($ue)) {
- redirect($returnurl);
-}
-
-$yesurl = new moodle_url($PAGE->url, array('confirm'=>1, 'sesskey'=>sesskey()));
-$message = get_string('unenroluser', 'enrol_self', array('user' => fullname($user, true), 'course' => format_string($course->fullname)));
-$fullname = fullname($user);
-$title = get_string('unenrol', 'enrol_self');
-
-$PAGE->set_title($title);
-$PAGE->set_heading($title);
-$PAGE->navbar->add($title);
-$PAGE->navbar->add($fullname);
-
-echo $OUTPUT->header();
-echo $OUTPUT->heading($fullname);
-echo $OUTPUT->confirm($message, $yesurl, $returnurl);
-echo $OUTPUT->footer();
View
87 enrol/unenroluser.php
@@ -0,0 +1,87 @@
+<?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/>.
+
+/**
+ * Completely unenrol a user from a course.
+ *
+ * Please note when unenrolling a user all of their grades are removed as well,
+ * most ppl actually expect enrolments to be suspended only...
+ *
+ * @package core
+ * @subpackage enrol
+ * @copyright 2011 Petr skoda
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+require('../config.php');
+require_once("$CFG->dirroot/enrol/locallib.php");
+require_once("$CFG->dirroot/enrol/renderer.php");
+
+$ueid = required_param('ue', PARAM_INT); // user enrolment id
+$confirm = optional_param('confirm', false, PARAM_BOOL);
+$filter = optional_param('ifilter', 0, PARAM_INT);
+
+$ue = $DB->get_record('user_enrolments', array('id' => $ueid), '*', MUST_EXIST);
+$user = $DB->get_record('user', array('id'=>$ue->userid), '*', MUST_EXIST);
+$instance = $DB->get_record('enrol', array('id'=>$ue->enrolid), '*', MUST_EXIST);
+$course = $DB->get_record('course', array('id'=>$instance->courseid), '*', MUST_EXIST);
+
+$context = context_course::instance($course->id);
+
+// set up PAGE url first!
+$PAGE->set_url('/enrol/unenroluser.php', array('ue'=>$ueid, 'ifilter'=>$filter));
+
+require_login($course);
+
+if (!enrol_is_enabled($instance->enrol)) {
+ print_error('erroreditenrolment', 'enrol');
+}
+
+$plugin = enrol_get_plugin($instance->enrol);
+
+if (!$plugin->allow_unenrol_user($instance, $ue) or !has_capability("enrol/$instance->enrol:unenrol", $context)) {
+ print_error('erroreditenrolment', 'enrol');
+}
+
+$manager = new course_enrolment_manager($PAGE, $course, $filter);
+$table = new course_enrolment_users_table($manager, $PAGE);
+
+$returnurl = new moodle_url('/enrol/users.php', array('id' => $course->id)+$manager->get_url_params()+$table->get_url_params());
+$usersurl = new moodle_url('/enrol/users.php', array('id' => $course->id));
+
+$PAGE->set_pagelayout('admin');
+navigation_node::override_active_url($usersurl);
+
+// If the unenrolment has been confirmed and the sesskey is valid unenrol the user.
+if ($confirm && confirm_sesskey()) {
+ $plugin->unenrol_user($instance, $ue->userid);
+ redirect($returnurl);
+}
+
+$yesurl = new moodle_url($PAGE->url, array('confirm'=>1, 'sesskey'=>sesskey()));
+$message = get_string('unenrolconfirm', 'core_enrol', array('user'=>fullname($user, true), 'course'=>format_string($course->fullname)));
+$fullname = fullname($user);
+$title = get_string('unenrol', 'core_enrol');
+
+$PAGE->set_title($title);
+$PAGE->set_heading($title);
+$PAGE->navbar->add($title);
+$PAGE->navbar->add($fullname);
+
+echo $OUTPUT->header();
+echo $OUTPUT->heading($fullname);
+echo $OUTPUT->confirm($message, $yesurl, $returnurl);
+echo $OUTPUT->footer();
View
25 lib/enrollib.php
@@ -1088,25 +1088,40 @@ public function roles_protected() {
* @param stdClass $instance course enrol instance
* All plugins allowing this must implement 'enrol/xxx:enrol' capability
*
- * @return bool - true means user with 'enrol/xxx:enrol' may enrol others freely, trues means nobody may add more enrolments manually
+ * @return bool - true means user with 'enrol/xxx:enrol' may enrol others freely, false means nobody may add more enrolments manually
*/
public function allow_enrol(stdClass $instance) {
return false;
}
/**
- * Does this plugin allow manual unenrolments?
- *
- * @param stdClass $instance course enrol instance
+ * Does this plugin allow manual unenrolment of all users?
* All plugins allowing this must implement 'enrol/xxx:unenrol' capability
*
- * @return bool - true means user with 'enrol/xxx:unenrol' may unenrol others freely, trues means nobody may touch user_enrolments
+ * @param stdClass $instance course enrol instance
+ * @return bool - true means user with 'enrol/xxx:unenrol' may unenrol others freely, false means nobody may touch user_enrolments
*/
public function allow_unenrol(stdClass $instance) {
return false;
}
/**
+ * Does this plugin allow manual unenrolment of a specific user?
+ * All plugins allowing this must implement 'enrol/xxx:unenrol' capability
+ *
+ * This is useful especially for synchronisation plugins that
+ * do suspend instead of full unenrolment.
+ *
+ * @param stdClass $instance course enrol instance
+ * @param stdClass $ue record from user_enrolments table, specifies user
+ *
+ * @return bool - true means user with 'enrol/xxx:unenrol' may unenrol this user, false means nobody may touch this user enrolment
+ */
+ public function allow_unenrol_user(stdClass $instance, stdClass $ue) {
+ return $this->allow_unenrol($instance);
+ }
+
+ /**
* Does this plugin allow manual changes in user_enrolments table?
*
* All plugins allowing this must implement 'enrol/xxx:manage' capability

0 comments on commit 6357d61

Please sign in to comment.