MDL-37184 refactor enrolment editing code to be shared by plugins

AMOS BEGIN
 MOV [editenrolment,enrol_self],[editenrolment,core_enrol]
AMOS END

enrol/self/editenrolment.php → enrol/editenrolment.php

@@ -15,50 +15,46 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Self user enrolment edit script.
+ * User enrolment edit script.
  *
- * This page allows the current user to edit a self user enrolment.
+ * This page allows the current user to edit a user enrolment.
  * It is not compatible with the frontpage.
  *
- * @package    enrol_self
+ * NOTE: plugins are free to implement own edit scripts with extra logic.
+ *
+ * @package    core_enrol
  * @copyright  2011 Sam Hemelryk
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-require('../../config.php');
+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.
+require_once("$CFG->dirroot/enrol/editenrolment_form.php"); // Forms for this page.
 
 $ueid   = required_param('ue', PARAM_INT);
 $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.
-$sql = "SELECT c.*
-          FROM {course} c
-          JOIN {enrol} e ON e.courseid = c.id
-         WHERE e.id = :enrolid";
-$params = array('enrolid' => $ue->enrolid);
-$course = $DB->get_record_sql($sql, $params, MUST_EXIST);
-
-// Make sure the course isn't the front page.
-if ($course->id == SITEID) {
-    redirect(new moodle_url('/'));
-}
+$instance = $DB->get_record('enrol', array('id'=>$ue->enrolid), '*', MUST_EXIST);
+$course = $DB->get_record('course', array('id'=>$instance->courseid), '*', MUST_EXIST);
+
+// The URL of the enrolled users page for the course.
+$usersurl = new moodle_url('/enrol/users.php', array('id' => $course->id));
 
-// Do not allow any changes if plugin disabled.
-if (!enrol_is_enabled('self')) {
-    redirect(new moodle_url('/course/view.php', array('id'=>$course->id)));
+// Do not allow any changes if plugin disabled, not available or not suitable.
+if (!$plugin = enrol_get_plugin($instance->enrol)) {
+    redirect($usersurl);
+}
+if (!$plugin->allow_manage($instance)) {
+    redirect($usersurl);
 }
 
 // Obviously.
 require_login($course);
-// The user must be able to manage self enrolments within the course.
-require_capability("enrol/self:manage", context_course::instance($course->id, MUST_EXIST));
+// The user must be able to manage enrolments within the course.
+require_capability('enrol/'.$instance->enrol.':manage', context_course::instance($course->id, MUST_EXIST));
 
 // Get the enrolment manager for this course.
 $manager = new course_enrolment_manager($PAGE, $course, $filter);
@@ -67,26 +63,17 @@
 // 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());
+$url = new moodle_url('/enrol/editenrolment.php', $returnurl->params());
 
 $PAGE->set_url($url);
 $PAGE->set_pagelayout('admin');
 navigation_node::override_active_url($usersurl);
 
-// Gets the components 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));
+// Get the enrolment edit form.
+$mform = new enrol_user_enrolment_form($url, array('user'=>$user, 'course'=>$course, 'ue'=>$ue));
 $mform->set_data($PAGE->url->params());
 
 if ($mform->is_cancelled()) {
@@ -99,7 +86,7 @@
 }
 
 $fullname = fullname($user);
-$title = get_string('editenrolment', 'enrol_self');
+$title = get_string('editenrolment', 'core_enrol');
 
 $PAGE->set_title($title);
 $PAGE->set_heading($title);

enrol/self/editenrolment_form.php → enrol/editenrolment_form.php

@@ -15,9 +15,9 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Contains the form used to edit self enrolments for a user.
+ * Contains the form used to edit enrolments for a user.
  *
- * @package    enrol_self
+ * @package    core_enrol
  * @copyright  2011 Sam Hemelryk
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -26,7 +26,7 @@
 
 require_once("$CFG->libdir/formslib.php");
 
-class enrol_self_user_enrolment_form extends moodleform {
+class enrol_user_enrolment_form extends moodleform {
     function definition() {
         global $CFG, $DB;
 

enrol/manual/lang/en/enrol_manual.php

@@ -31,7 +31,6 @@
 $string['defaultperiod_desc'] = 'Default length of time that the enrolment is valid. If set to zero, the enrolment duration will be unlimited by default.';
 $string['defaultperiod_help'] = 'Default length of time that the enrolment is valid, starting with the moment the user is enrolled. If disabled, the enrolment duration will be unlimited by default.';
 $string['deleteselectedusers'] = 'Delete selected user enrolments';
-$string['editenrolment'] = 'Edit enrolment';
 $string['editselectedusers'] = 'Edit selected user enrolments';
 $string['enrolledincourserole'] = 'Enrolled in "{$a->course}" as "{$a->role}"';
 $string['enrolusers'] = 'Enrol users';

enrol/manual/lib.php

@@ -421,7 +421,7 @@ public function get_user_enrolment_actions(course_enrolment_manager $manager, $u
             $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);
+            $url = new moodle_url('/enrol/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/lang/en/enrol_self.php

@@ -34,7 +34,6 @@
 * Link to user\'s profile page {$a->profileurl}';
 $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['enrolenddate_help'] = 'If enabled, users can enrol themselves until this date only.';
 $string['enrolenddaterror'] = 'Enrolment end date cannot be earlier than start date';

enrol/self/lib.php

@@ -543,7 +543,7 @@ public function get_user_enrolment_actions(course_enrolment_manager $manager, $u
             $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);
+            $url = new moodle_url('/enrol/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;

lang/en/enrol.php

@@ -40,6 +40,7 @@
 Are you sure you want to continue?';
 $string['deleteinstancenousersconfirm'] = 'You are about to delete the enrolment method "{$a->name}". Are you sure you want to continue?';
 $string['durationdays'] = '{$a} days';
+$string['editenrolment'] = 'Edit enrolment';
 $string['enrol'] = 'Enrol';
 $string['enrolcandidates'] = 'Not enrolled users';
 $string['enrolcandidatesmatching'] = 'Matching not enrolled users';