From 24a0c1ea66c384f6b10a8c198088d489098d105d Mon Sep 17 00:00:00 2001 From: Sam Hemelryk Date: Wed, 13 Apr 2011 15:01:05 +0800 Subject: [PATCH] MDL-23532 enrol-manual - manual enrolments now manages its own enrolment editing and unenrolment --- enrol/manual/editenrolment.php | 103 ++++++++++++++++++++++++++ enrol/manual/editenrolment_form.php | 81 ++++++++++++++++++++ enrol/manual/lang/en/enrol_manual.php | 3 + enrol/manual/lib.php | 24 ++++++ enrol/manual/unenroluser.php | 93 +++++++++++++++++++++++ 5 files changed, 304 insertions(+) create mode 100644 enrol/manual/editenrolment.php create mode 100644 enrol/manual/editenrolment_form.php create mode 100644 enrol/manual/unenroluser.php diff --git a/enrol/manual/editenrolment.php b/enrol/manual/editenrolment.php new file mode 100644 index 0000000000000..f22baa6b7611e --- /dev/null +++ b/enrol/manual/editenrolment.php @@ -0,0 +1,103 @@ +. + +/** + * Manual user enrolment edit script. + * + * This page allows the current user to edit a manual user enrolment. + * It is not compatible with the frontpage. + * + * @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"); // Required for the course enrolment manager table +require_once("$CFG->dirroot/enrol/manual/editenrolment_form.php"); + +$ueid = required_param('ue', PARAM_INT); // user enrolment id +$filter = optional_param('ifilter', 0, PARAM_INT); + +// 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 its not the front page course +if ($course->id == SITEID) { + redirect(new moodle_url('/')); +} + +// Obviously +require_login($course); +// Make sure the user can manage manual enrolments for this course +require_capability("enrol/manual: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/manual/editenrolment.php', $returnurl->params()); + +$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_manage($instance) || $instance->enrol != 'manual' || !($plugin instanceof enrol_manual_plugin)) { + print_error('erroreditenrolment', 'enrol'); +} + +$mform = new enrol_manual_user_enrolment_form($url, array('user'=>$user, 'course'=>$course, 'ue'=>$ue)); +$mform->set_data($PAGE->url->params()); +$data = $mform->get_data(); +if ($mform->is_cancelled() || ($data && $manager->edit_enrolment($ue, $data))) { + redirect($returnurl); +} + +$fullname = fullname($user); +$title = get_string('editenrolment', '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); +$mform->display(); +echo $OUTPUT->footer(); \ No newline at end of file diff --git a/enrol/manual/editenrolment_form.php b/enrol/manual/editenrolment_form.php new file mode 100644 index 0000000000000..b57321208d15b --- /dev/null +++ b/enrol/manual/editenrolment_form.php @@ -0,0 +1,81 @@ +. + +/** + * Contains the form used to edit manual enrolments for a user. + * + * @package enrol + * @subpackage manual + * @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_manual_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; + } +} \ No newline at end of file diff --git a/enrol/manual/lang/en/enrol_manual.php b/enrol/manual/lang/en/enrol_manual.php index 7d375b3240185..62a49c7da3ca1 100644 --- a/enrol/manual/lang/en/enrol_manual.php +++ b/enrol/manual/lang/en/enrol_manual.php @@ -27,6 +27,7 @@ $string['assignrole'] = 'Assignrole'; $string['defaultperiod'] = 'Default enrolment period'; $string['defaultperiod_desc'] = 'Default length of the default enrolment period setting (in seconds).'; //TODO: fixme +$string['editenrolment'] = 'Edit enrolment'; $string['enrolledincourserole'] = 'Enrolled in "{$a->course}" as "{$a->role}"'; $string['enrolusers'] = 'Enrol users'; $string['manual:config'] = 'Configure manual enrol instances'; @@ -41,4 +42,6 @@ $string['status_help'] = 'This setting determines whether users can be enrolled manually, via a link in the course administration settings, by a user with appropriate permissions such as a teacher.'; $string['statusenabled'] = 'Enabled'; $string['statusdisabled'] = 'Disabled'; +$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}"?'; diff --git a/enrol/manual/lib.php b/enrol/manual/lib.php index de21ec61e0c79..2f2a410db3e95 100644 --- a/enrol/manual/lib.php +++ b/enrol/manual/lib.php @@ -240,6 +240,30 @@ public function get_manual_enrol_button(course_enrolment_manager $manager) { return $button; } + + /** + * 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/manual:unenrol", $context)) { + $url = new moodle_url('/enrol/manual/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)) { + $url = new moodle_url('/enrol/manual/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; + } } /** diff --git a/enrol/manual/unenroluser.php b/enrol/manual/unenroluser.php new file mode 100644 index 0000000000000..0d208e6759ee6 --- /dev/null +++ b/enrol/manual/unenroluser.php @@ -0,0 +1,93 @@ +. + +/** + * Unenrol a user who was enrolled through a manual enrolment. + * + * @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 ($confirm && $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(); \ No newline at end of file