MDL-23532 enrol-self - Self enrolments now manages its own enrolment …

…editing and unenrolment

enrol/self/editenrolment.php

@@ -0,0 +1,107 @@
+<?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 user enrolment edit script.
+ *
+ * This page allows the current user to edit a self user enrolment.
+ * It is not compatible with the frontpage.
+ *
+ * @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"); // Required for the course enrolment manager
+require_once("$CFG->dirroot/enrol/renderer.php"); // Required for the course enrolment users table
+require_once("$CFG->dirroot/enrol/self/editenrolment_form.php"); // Forms for this page
+
+$ueid   = required_param('ue', PARAM_INT); // user enrolment id
+$filter = optional_param('ifilter', 0, PARAM_INT); // table filter for return url
+
+// 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 the course isn't the front page
+if ($course->id == SITEID) {
+    redirect(new moodle_url('/'));
+}
+
+// Obvioulsy
+require_login($course);
+// The user must be able to manage self enrolments within the course
+require_capability("enrol/self:manage", get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST));
+
+// 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/editenrolment.php', $returnurl->params());
+
+$PAGE->set_url($url);
+$PAGE->set_pagelayout('admin');
+navigation_node::override_active_url($usersurl);
+
+// Gets the compontents of the user enrolment
+list($instance, $plugin) = $manager->get_user_enrolment_components($ue);
+// Check that the user can manage this instance, and that the instance is of the correct type
+if (!$plugin->allow_manage($instance) || $instance->enrol != 'self' || !($plugin instanceof enrol_self_plugin)) {
+    print_error('erroreditenrolment', 'enrol');
+}
+
+// Get the self enrolment edit form
+$mform = new enrol_self_user_enrolment_form($url, array('user'=>$user, 'course'=>$course, 'ue'=>$ue));
+$mform->set_data($PAGE->url->params());
+$data = $mform->get_data();
+// Process the form and edit the enrolment if required.
+if ($mform->is_cancelled() || ($data && $manager->edit_enrolment($ue, $data))) {
+    redirect($returnurl);
+}
+
+$fullname = fullname($user);
+$title = get_string('editenrolment', '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);
+$mform->display();
+echo $OUTPUT->footer();

enrol/self/editenrolment_form.php

@@ -0,0 +1,81 @@
+<?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/>.
+
+/**
+ * Contains the form used to edit self enrolments for a user.
+ *
+ * @package    enrol
+ * @subpackage self
+ * @copyright  2011 Sam Hemelryk
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once("$CFG->libdir/formslib.php");
+
+class enrol_self_user_enrolment_form extends moodleform {
+    function definition() {
+        global $CFG, $DB;
+
+        $mform = $this->_form;
+
+        $user   = $this->_customdata['user'];
+        $course = $this->_customdata['course'];
+        $ue     = $this->_customdata['ue'];
+
+        $mform->addElement('header','general', '');
+
+        $options = array(ENROL_USER_ACTIVE    => get_string('participationactive', 'enrol'),
+                         ENROL_USER_SUSPENDED => get_string('participationsuspended', 'enrol'));
+        if (isset($options[$ue->status])) {
+            $mform->addElement('select', 'status', get_string('participationstatus', 'enrol'), $options);
+        }
+
+        $mform->addElement('date_selector', 'timestart', get_string('enroltimestart', 'enrol'), array('optional' => true));
+
+        $mform->addElement('date_selector', 'timeend', get_string('enroltimeend', 'enrol'), array('optional' => true));
+
+        $mform->addElement('hidden', 'ue');
+        $mform->setType('ue', PARAM_INT);
+
+        $mform->addElement('hidden', 'ifilter');
+        $mform->setType('ifilter', PARAM_ALPHA);
+
+        $this->add_action_buttons();
+
+        $this->set_data(array(
+            'ue' => $ue->id,
+            'status' => $ue->status,
+            'timestart' => $ue->timestart,
+            'timeend' => $ue->timeend
+        ));
+    }
+
+    function validation($data, $files) {
+        $errors = parent::validation($data, $files);
+
+        if (!empty($data['timestart']) and !empty($data['timeend'])) {
+            if ($data['timestart'] >= $data['timeend']) {
+                $errors['timestart'] = get_string('error');
+                $errors['timeend'] = get_string('error');
+            }
+        }
+
+        return $errors;
+    }
+}

enrol/self/lang/en/enrol_self.php

@@ -27,6 +27,7 @@
 $string['customwelcomemessage'] = 'Custom welcome message';
 $string['defaultrole'] = 'Default role assignment';
 $string['defaultrole_desc'] = 'Select role which should be assigned to users during self enrolment';
+$string['editenrolment'] = 'Edit enrolment';
 $string['enrolenddate'] = 'End date';
 $string['enrolenddaterror'] = 'Enrolment end date cannot be earlier than start date';
 $string['enrolme'] = 'Enrol me';
@@ -68,7 +69,9 @@
 $string['status'] = 'Allow self enrolments';
 $string['status_desc'] = 'Allow users to self enrol into course by default.';
 $string['status_help'] = 'This setting determines whether a user can enrol (and also unenrol if they have the appropriate permission) themselves from the course.';
+$string['unenrol'] = 'Unenrol user';
 $string['unenrolselfconfirm'] = 'Do you really want to unenrol yourself from course "{$a}"?';
+$string['unenroluser'] = 'Do you really want to unenrol "{$a->user}" from course "{$a->course}"?';
 $string['usepasswordpolicy'] = 'Use password policy';
 $string['usepasswordpolicy_desc'] = 'Use standard password policy for enrolment keys.';
 $string['welcometocourse'] = 'Welcome to {$a}';

enrol/self/lib.php

@@ -357,6 +357,30 @@ public function cron() {
 
         flush();
     }
+
+     /**
+     * Gets an array of the user enrolment actions
+     *
+     * @param course_enrolment_manager $manager
+     * @param stdClass $ue A user enrolment object
+     * @return array An array of user_enrolment_actions
+     */
+    public function get_user_enrolment_actions(course_enrolment_manager $manager, $ue) {
+        $actions = array();
+        $context = $manager->get_context();
+        $instance = $ue->enrolmentinstance;
+        $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);
+            $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)) {
+            $url = new moodle_url('/enrol/self/editenrolment.php', $params);
+            $actions[] = new user_enrolment_action(new pix_icon('t/edit', ''), get_string('edit'), $url, array('class'=>'editenrollink', 'rel'=>$ue->id));
+        }
+        return $actions;
+    }
 }
 
 /**

enrol/self/unenroluser.php

@@ -0,0 +1,100 @@
+<?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 ($confirm && $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();