refactored strings

Author: rtschu

classes/bulkenrol_form.php

@@ -50,22 +50,37 @@ protected function definition() {
 
         $mform = $this->_form;
 
-        // Infotext.
-        $msg = get_string('bulkenrol_form_intro', 'local_bulkenrol');
-        $mform->addElement('html', '<div id="intro">'.$msg.'</div>');
-
         // Selector for database field to match list to.
         $availablefieldsstring = get_config('local_bulkenrol', 'fieldoptions');
         $availablefieldsarray = explode(',', $availablefieldsstring);
-        if (count($availablefieldsarray) < 1) {
+        if (count($availablefieldsarray) < 1 or $availablefieldsarray[0] == '') {
             print_error(get_string('error_no_options_available', 'local_bulkenrol'));
         }
+
+        $selectoptions = [];
+        foreach ($availablefieldsarray as $fieldoption) {
+            $selectoptions[$fieldoption] = $this->get_fieldname($fieldoption);
+        }
+
+        // Format CSV, replace last , with 'or' and add spaces after remaining.
+        $fieldnamestring = implode(', ', $selectoptions);
+        $formattedfieldnamestring = $this->str_last_replace(', ', ' ' . get_string('or', 'local_bulkenrol') . ' ', $fieldnamestring);
+
+        // Infotext.
+        $msg = get_string('bulkenrol_form_intro', 'local_bulkenrol', $formattedfieldnamestring);
+        $mform->addElement('html', '<div id="intro">'.$msg.'</div>');
+
+        // Helptext.
+        if ($availablefieldsarray[0] == 'u_username') {
+            $helpstringidentifier = 'userlist_username';
+        } else if ($availablefieldsarray[0] == 'u_idnumber') {
+            $helpstringidentifier = 'userlist_idnumber';
+        } else {
+            $helpstringidentifier = 'userlist_email';
+        }
+
         $singleoption = count($availablefieldsarray) == 1;
         if (!$singleoption) {
-            $selectoptions = [];
-            foreach ($availablefieldsarray as $fieldoption) {
-                $selectoptions[$fieldoption] = $this->get_fieldname($fieldoption);
-            }
             $mform->addElement('select', 'dbfield', get_string('choose_field', 'local_bulkenrol'), $selectoptions);
             $listfieldtitle = get_string('userlist', 'local_bulkenrol');
         } else {
@@ -79,7 +94,7 @@ protected function definition() {
         $mform->addElement('textarea', 'uservalues',
                 $listfieldtitle, 'wrap="virtual" rows="10" cols="80"');
         $mform->addRule('uservalues', null, 'required');
-        $mform->addHelpButton('uservalues', 'userlist', 'local_bulkenrol');
+        $mform->addHelpButton('uservalues', $helpstringidentifier, 'local_bulkenrol');
 
         // Add form content if the user came back to check his input.
         $localbulkenroleditlist = optional_param('editlist', 0, PARAM_ALPHANUMEXT);
@@ -131,4 +146,14 @@ private function get_fieldname($fieldoption) {
                 throw new \UnexpectedValueException("field is not from usertable (u_) or customfield (c_)");
         }
     }
+
+    private function str_last_replace($search, $replace, $subject) {
+        $pos = strrpos($subject, $search);
+
+        if ($pos !== false) {
+            $subject = substr_replace($subject, $replace, $pos, strlen($search));
+        }
+
+        return $subject;
+    }
 }

lang/en/local_bulkenrol.php

@@ -25,7 +25,7 @@
 defined('MOODLE_INTERNAL') || die();
 
 $string['bulkenrol:enrolusers'] = 'Use user bulk enrolment';
-$string['bulkenrol_form_intro'] = 'Here, you can bulk enrol users to your course. A user to be enrolled is identified by his e-mail address stored in his Moodle account.';
+$string['bulkenrol_form_intro'] = 'Here, you can bulk enrol users to your course. A user to be enrolled is identified by their {$a}.';
 $string['choose_field'] = 'Choose field to match list to';
 $string['enrol_users_successful'] = 'User bulk enrolment successful';
 $string['enrol_users'] = 'Enrol users';
@@ -38,36 +38,36 @@
 $string['error_getting_user_for_data'] = 'There was a problem when getting the user record for <em>{$a}</em> from the database.';
 $string['error_group_add_members'] = 'There was a problem when adding the users to the course group(s).';
 $string['error_group_add_member'] = 'There was a problem when adding the user <em>{$a->data}</em> to the course group <em>{$a->group}</em>.';
-$string['error_invalid_email'] = 'Invalid e-mail address found in line {$a->row} (<em>{$a->email}</em>). This line will be ignored.';
-$string['error_more_than_one_record_for_data'] = 'More than one existing Moodle user account <em>{$a}</em>em> found.<br /> This line will be ignored, none of the existing Moodle users will be enrolled.';
-$string['error_no_email'] = 'No e-mail address found in line {$a->line} (<em>{$a->content}</em>). This line will be ignored.';
+$string['error_more_than_one_record_for_data'] = 'More than one existing Moodle user account with {$a->field} <em>{$a->identifier}</em>em> found.<br /> This line will be ignored, none of the existing Moodle users will be enrolled.';
 $string['error_no_valid_data_in_list'] = 'No valid entrys were found in the given list.<br />Please <a href=\'{$a->url}\'>go back and check your input</a>.';
-$string['error_no_record_found_for_email'] = 'No existing Moodle user account with e-mail address <em>{$a}</em>.<br />This line will be ignored, there won\'t be a Moodle user account created on-the-fly.';
-$string['error_usermails_empty'] = 'List of e-mail addresses is empty. Please add at least one e-mail address.';
-$string['error_check_is_already_member'] = 'Error checking if the user (<em>{$a->email}</em>) is already a member of group (<em>{$a->groupname}</em>). {$a->error}';
 $string['groupinfos_headline'] = 'Groups included in the list';
 $string['group_name_headline'] = 'Group name';
 $string['group_status_create'] = 'Group will be created';
 $string['group_status_exists'] = 'Group already exists';
 $string['group_status_headline'] = 'Group status';
 $string['hints'] = 'Hints';
-$string['error_no_record_found_for_email'] = 'No existing Moodle user account <em>{$a}</em> was found.<br />This line will be ignored, there won\'t be a Moodle user account created on-the-fly.';
 $string['error_no_data'] = 'No data found (<em>{$a}</em>). This line will be ignored.';
 $string['error_no_record_found_for_data'] = 'No existing Moodle user account <em>{$a}</em> was found.<br />This line will be ignored, there won\'t be a Moodle user account created on-the-fly.';
-$string['error_usermails_empty'] = 'List of e-mail addresses is empty. Please add at least one e-mail address.';
-$string['error_check_is_already_member'] = 'Error checking if the user (<em>{$a->data}</em>) is already a member of group (<em>{$a->groupname}</em>). {$a->error}';
+$string['error_no_options_available'] = 'Your administrator has disabled all options. Please contact your administrator';
 $string['error_list_empty'] = 'List is empty. Please add at least one fieldvalue';
 $string['error_check_is_already_member'] = 'Error checking if the user (<em>{$a->data}</em>) is already a member of group (<em>{$a->groupname}</em>). {$a->error}';
 $string['fieldoptions'] = 'Fieldoptions';
 $string['fieldoptions_desc'] = 'Fields, that teachers can use as identifier to enrol students by.';
 $string['pluginname'] = 'User bulk enrolment';
+$string['or'] = 'or';
 $string['privacy:metadata'] = 'The user bulk enrolment plugin acts as a tool to enrol users into courses, but does not store any personal data.';
 $string['role'] = 'Role';
 $string['role_assigned'] = 'Assigned role';
 $string['role_description'] = 'The role to be used to bulk enrol the users.';
 $string['row'] = 'Row';
 $string['userlist'] = 'List of users identified by your chosen field';
-$string['userlist_help'] = 'To enrol an existing Moodle user into this course, choose a field to identify the user by and add the identifyer to the list. <br /><br />Example for field "email" :<br />[email protected]<br />[email protected]<br /><br />Optionally, you are able to create groups and add the enrolled users to the groups. All you have to do is to add a heading line with a hash sign and the group\'s name, separating the list of users.<br /><br />Example:<br /># Group 1<br />[email protected]<br />[email protected]<br /># Group 2<br />[email protected]<br />[email protected]';
+$string['userlist_singleoption'] = 'List of users identified by their {$a}';
+$string['userlist_email'] = 'data input';
+$string['userlist_username'] = 'data input';
+$string['userlist_idnumber'] = 'data input';
+$string['userlist_email_help'] = 'To enrol an existing Moodle user into this course, choose a field to identify the user by and add the identifier to the list. <br /><br />Example for field "email" :<br />[email protected]<br />[email protected]<br /><br />Optionally, you are able to create groups and add the enrolled users to the groups. All you have to do is to add a heading line with a hash sign and the group\'s name, separating the list of users.<br /><br />Example:<br /># Group 1<br />[email protected]<br />[email protected]<br /># Group 2<br />[email protected]<br />[email protected]';
+$string['userlist_username_help'] = 'To enrol an existing Moodle user into this course, choose a field to identify the user by and add the identifier to the list. <br /><br />Example for field "username" :<br />alice<br />bob<br /><br />Optionally, you are able to create groups and add the enrolled users to the groups. All you have to do is to add a heading line with a hash sign and the group\'s name, separating the list of users.<br /><br />Example:<br /># Group 1<br />alice<br />bob<br /># Group 2<br />carol<br />dave';
+$string['userlist_idnumber_help'] = 'To enrol an existing Moodle user into this course, choose a field to identify the user by and add the identifier to the list. <br /><br />Example for field "idnumber" :<br />1001<br />1002<br /><br />Optionally, you are able to create groups and add the enrolled users to the groups. All you have to do is to add a heading line with a hash sign and the group\'s name, separating the list of users.<br /><br />Example:<br /># Group 1<br />1001<br />1002<br /># Group 2<br />1003<br />1004';
 $string['users_to_enrol_in_course'] = 'Users to be enrolled into the course';
 $string['user_enroled'] = 'User enrolment';
 $string['user_enroled_yes'] = 'User will be enrolled';

locallib.php

@@ -243,7 +243,7 @@ function local_bulkenrol_get_user($data, $datafield) {
         if (!empty($count)) {
             // More than one user with data -> ignore data and don't enrol users later!
             if ($count > 1) {
-                $error = get_string('error_more_than_one_record_for_data', 'local_bulkenrol', $data);
+                $error = get_string('error_more_than_one_record_for_data', 'local_bulkenrol', array('identifier' => $data, "field" => $datafield));
             } else {
                 $userrecord = current($userrecords);
             }