mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-13 04:22:07 +02:00
Code Issues Projects Releases Wiki Activity

MDL-81506 enrol_manual: Edit welcome message capability applied

Browse Source
This commit is contained in:
David Woloszyn 2024-06-04 16:20:16 +10:00
parent d43da95ed6
commit 49fa7785dd
2 changed files with 110 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

167
enrol/manual/lib.php
View File

@ -114,8 +114,17 @@ class enrol_manual_plugin extends enrol_plugin {
$managelink = new moodle_url("/enrol/manual/manage.php", array('enrolid'=>$instance->id));
$icons[] = $OUTPUT->action_icon($managelink, new pix_icon('t/enrolusers', get_string('enrolusers', 'enrol_manual'), 'core', array('class'=>'iconsmall')));
}
$parenticons = parent::get_action_icons($instance);
$icons = array_merge($icons, $parenticons);
if (has_any_capability(['enrol/manual:config', 'moodle/course:editcoursewelcomemessage'], $context)) {
$linkparams = [
'courseid' => $instance->courseid,
'id' => $instance->id,
'type' => $instance->enrol,
];
$editlink = new moodle_url('/enrol/editinstance.php', $linkparams);
$icon = new pix_icon('t/edit', get_string('edit'), 'core', ['class' => 'iconsmall']);
$icons[] = $OUTPUT->action_icon($editlink, $icon);
}
return $icons;
}
@ -175,7 +184,11 @@ class enrol_manual_plugin extends enrol_plugin {
}
}
$data->notifyall = $data->expirynotify == 2 ? 1 : 0;
// This method is used when configuring the enrolment method, and when only updating the welcome message.
// The 'expirynotify' property won't be set when updating the welcome message.
if (isset($data->expirynotify)) {
$data->notifyall = $data->expirynotify == 2 ? 1 : 0;
}
return parent::update_instance($instance, $data);
}
@ -582,86 +595,92 @@ class enrol_manual_plugin extends enrol_plugin {
*/
public function edit_instance_form($instance, MoodleQuickForm $mform, $context) {
$options = $this->get_status_options();
$mform->addElement('select', 'status', get_string('status', 'enrol_manual'), $options);
$mform->addHelpButton('status', 'status', 'enrol_manual');
$mform->setDefault('status', $this->get_config('status'));
// Main fields.
if (has_capability('enrol/manual:config', $context)) {
$options = $this->get_status_options();
$mform->addElement('select', 'status', get_string('status', 'enrol_manual'), $options);
$mform->addHelpButton('status', 'status', 'enrol_manual');
$mform->setDefault('status', $this->get_config('status'));
$roles = $this->get_roleid_options($instance, $context);
$mform->addElement('select', 'roleid', get_string('defaultrole', 'role'), $roles);
$mform->setDefault('roleid', $this->get_config('roleid'));
$roles = $this->get_roleid_options($instance, $context);
$mform->addElement('select', 'roleid', get_string('defaultrole', 'role'), $roles);
$mform->setDefault('roleid', $this->get_config('roleid'));
$options = array('optional' => true, 'defaultunit' => 86400);
$mform->addElement('duration', 'enrolperiod', get_string('defaultperiod', 'enrol_manual'), $options);
$mform->setDefault('enrolperiod', $this->get_config('enrolperiod'));
$mform->addHelpButton('enrolperiod', 'defaultperiod', 'enrol_manual');
$options = ['optional' => true, 'defaultunit' => 86400];
$mform->addElement('duration', 'enrolperiod', get_string('defaultperiod', 'enrol_manual'), $options);
$mform->setDefault('enrolperiod', $this->get_config('enrolperiod'));
$mform->addHelpButton('enrolperiod', 'defaultperiod', 'enrol_manual');
$options = $this->get_expirynotify_options();
$mform->addElement('select', 'expirynotify', get_string('expirynotify', 'core_enrol'), $options);
$mform->addHelpButton('expirynotify', 'expirynotify', 'core_enrol');
$options = $this->get_expirynotify_options();
$mform->addElement('select', 'expirynotify', get_string('expirynotify', 'core_enrol'), $options);
$mform->addHelpButton('expirynotify', 'expirynotify', 'core_enrol');
$options = array('optional' => false, 'defaultunit' => 86400);
$mform->addElement('duration', 'expirythreshold', get_string('expirythreshold', 'core_enrol'), $options);
$mform->addHelpButton('expirythreshold', 'expirythreshold', 'core_enrol');
$mform->disabledIf('expirythreshold', 'expirynotify', 'eq', 0);
$options = ['optional' => false, 'defaultunit' => 86400];
$mform->addElement('duration', 'expirythreshold', get_string('expirythreshold', 'core_enrol'), $options);
$mform->addHelpButton('expirythreshold', 'expirythreshold', 'core_enrol');
$mform->disabledIf('expirythreshold', 'expirynotify', 'eq', 0);
}
// Course welcome message.
$mform->addElement(
'select',
'customint1',
get_string(
if (has_any_capability(['enrol/manual:config', 'moodle/course:editcoursewelcomemessage'], $context)) {
$mform->addElement(
'select',
'customint1',
get_string(
identifier: 'sendcoursewelcomemessage',
component: 'core_enrol',
),
enrol_send_welcome_email_options(),
);
$mform->addHelpButton(
elementname: 'customint1',
identifier: 'sendcoursewelcomemessage',
component: 'core_enrol',
),
enrol_send_welcome_email_options(),
);
$mform->addHelpButton(
elementname: 'customint1',
identifier: 'sendcoursewelcomemessage',
component: 'core_enrol',
);
);
$options = [
'cols' => '60',
'rows' => '8',
];
$mform->addElement(
'textarea',
'customtext1',
get_string(
identifier: 'customwelcomemessage',
component: 'core_enrol',
),
$options,
);
$mform->setDefault('customtext1', get_string('customwelcomemessageplaceholder', 'core_enrol'));
$mform->hideIf(
elementname: 'customtext1',
dependenton: 'customint1',
condition: 'eq',
value: ENROL_DO_NOT_SEND_EMAIL,
);
$options = [
'cols' => '60',
'rows' => '8',
];
$mform->addElement(
'textarea',
'customtext1',
get_string(
identifier: 'customwelcomemessage',
component: 'core_enrol',
),
$options,
);
$mform->setDefault('customtext1', get_string('customwelcomemessageplaceholder', 'core_enrol'));
$mform->hideIf(
elementname: 'customtext1',
dependenton: 'customint1',
condition: 'eq',
value: ENROL_DO_NOT_SEND_EMAIL,
);
// Static form elements cannot be hidden by hideIf() so we need to add a dummy group.
// See: https://tracker.moodle.org/browse/MDL-66251.
$group[] = $mform->createElement(
'static',
'customwelcomemessage_extra_help',
null,
get_string(
identifier: 'customwelcomemessage_help',
component: 'core_enrol',
),
);
$mform->addGroup($group, 'group_customwelcomemessage_extra_help', '', ' ', false);
$mform->hideIf(
elementname: 'group_customwelcomemessage_extra_help',
dependenton: 'customint1',
condition: 'eq',
value: ENROL_DO_NOT_SEND_EMAIL,
);
// Static form elements cannot be hidden by hideIf() so we need to add a dummy group.
// See: https://tracker.moodle.org/browse/MDL-66251.
$group[] = $mform->createElement(
'static',
'customwelcomemessage_extra_help',
null,
get_string(
identifier: 'customwelcomemessage_help',
component: 'core_enrol',
),
);
$mform->addGroup($group, 'group_customwelcomemessage_extra_help', '', ' ', false);
$mform->hideIf(
elementname: 'group_customwelcomemessage_extra_help',
dependenton: 'customint1',
condition: 'eq',
value: ENROL_DO_NOT_SEND_EMAIL,
);
}
if (enrol_accessing_via_instance($instance)) {
// Enrolment changes warning.
if (has_capability('enrol/manual:config', $context) && enrol_accessing_via_instance($instance)) {
$warntext = get_string('instanceeditselfwarningtext', 'core_enrol');
$mform->addElement('static', 'selfwarn', get_string('instanceeditselfwarning', 'core_enrol'), $warntext);
}
@ -681,7 +700,9 @@ class enrol_manual_plugin extends enrol_plugin {
public function edit_instance_validation($data, $files, $instance, $context) {
$errors = array();
if ($data['expirynotify'] > 0 and $data['expirythreshold'] < 86400) {
// This method is used when configuring the enrolment method, and when only updating the welcome message.
// The 'expirynotify' key won't be set when updating the welcome message.
if (isset($data['expirynotify']) && $data['expirynotify'] > 0 && $data['expirythreshold'] < 86400) {
$errors['expirythreshold'] = get_string('errorthresholdlow', 'core_enrol');
}

16
enrol/manual/tests/behat/welcomemessage.feature
View File

@ -35,6 +35,22 @@ Feature: A course welcome message will be sent to the user when they are enrolle
And I should not see "Custom welcome message"
And I should not see "Accepted formats: Plain text or Moodle-auto format. HTML tags and multi-lang tags are also accepted, as well as the following placeholders:"
@javascript
Scenario: Teacher can edit the course welcome message
Given I am on the "C1" "Enrolled users" page logged in as teacher
And I set the field "Participants tertiary navigation" to "Enrolment methods"
When I click on "Edit" "link" in the "Manual enrolments" "table_row"
Then I should see "Send course welcome message"
And I should not see "Enable manual enrolments"
And I should not see "Default role"
And I should not see "Default enrolment duration"
And I should not see "Notify before enrolment expires"
And I should not see "Notification threshold"
And I set the field "Custom welcome message" to "Hello {$a->fullname}, welcome to the course {$a->coursename}"
And I press "Save changes"
And I click on "Edit" "link" in the "Manual enrolments" "table_row"
And I should see "Hello {$a->fullname}, welcome to the course {$a->coursename}"
@javascript
Scenario: Student should not receive a welcome message if the setting is disabled
Given I am on the "C1" "Enrolled users" page logged in as manager