L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-85672 registration: Added new fields to registration form

Browse Source
This commit is contained in:
David Woloszyn
2025-08-25 10:15:41 +10:00
parent 6509b43b4c
commit be8adf1373
4 changed files with 85 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
public/lang/en/deprecated.txt
+2
View File
@@ -88,3 +88,5 @@ activities_help,core
resources_help,core
unabletomessage,core_message
notificationimage,core_message
sitename,core_hub
sitename_help,core_hub
public/lang/en/hub.php
+8 -4
View File
@@ -95,6 +95,8 @@ $string['nocheckstatusfromunreghub'] = 'The site is not registered on the hub so
$string['nohubselected'] = 'No hub selected';
$string['none'] = 'None';
$string['operation'] = 'Actions';
$string['organisationname'] = 'Organisation name';
$string['organisationname_help'] = 'The name of the organisation registering this site. If you choose to have your site listed, this will be the name that is listed.';
$string['participantnumberaverage'] = 'Average number of participants ({$a})';
$string['pluginusagedata'] = 'Plugin usage data collected from: <a href="{$a->overview}">Plugins overview</a>, <a href="{$a->activities}">Manage activities</a>, and <a href="{$a->blocks}">Manage blocks</a>';
$string['policyagreed'] = 'Privacy notice and data processing agreement';
@@ -147,8 +149,6 @@ $string['siteemail'] = 'Admin email address';
$string['siteemail_help'] = 'An email address is necessary so that Moodle HQ can contact you if required. It may also be used for other purposes as you allow below. We recommend a generic email address related to a position (eg.: [email protected]), not a personal address.';
$string['sitelang'] = 'Language';
$string['sitelang_help'] = 'What is the main language used on your Moodle site?';
$string['sitename'] = 'Name';
$string['sitename_help'] = 'The name of the site will be shown on the site listing if the hub allows that.';
$string['siteorganisationtype'] = 'Organisation type';
$string['siteorganisationtype:charityornotforprofit'] = 'Charity or Not For Profit';
$string['siteorganisationtype:charterschool'] = 'Charter school';
@@ -174,9 +174,9 @@ $string['sitephone'] = 'Phone';
$string['sitephone_help'] = 'Your phone number will only be seen by the hub administrator.';
$string['siteprivacy'] = 'Site listing';
$string['siteprivacy_help'] = 'You can choose to have your site listed publicly in the list of registered sites, with or without a link to your site.';
$string['siteprivacylinked'] = 'Display my organisation name with a link';
$string['siteprivacynotpublished'] = 'Do not list my site';
$string['siteprivacypublished'] = 'Only display my site name';
$string['siteprivacylinked'] = 'Display my site name with the link';
$string['siteprivacypublished'] = 'Only display my organisation name';
$string['siteregistrationemail'] = 'Notifications of new Moodle releases, security alerts and other important news';
$string['siteregistrationemail_help'] = 'You have the option of subscribing to our low-volume mailing list for notifications of new Moodle releases, security alerts and other important news. You may unsubscribe at any time.';
$string['siteregistrationupdated'] = 'Site registration updated';
@@ -218,3 +218,7 @@ $string['aiusagestats'] = 'AI usage stats ({$a->timefrom} - {$a->timeto})';
$string['sitecommnews'] = 'Moodle newsletter';
$string['sitecommnews_help'] = 'You have the option of subscribing to our Moodle newsletter. You may unsubscribe at any time.';
$string['sitecommnewsyes'] = 'Yes, I would like to receive the Moodle newsletter';
// Deprecated since 5.1.
$string['sitename'] = 'Name';
$string['sitename_help'] = 'The name of the site will be shown on the site listing if the hub allows that.';
public/lib/classes/hub/registration.php
+1 -1
View File
@@ -46,7 +46,7 @@ class registration {
const FORM_FIELDS = ['policyagreed', 'language', 'countrycode', 'privacy',
'contactemail', 'emailalert', 'emailalertemail', 'commnews', 'commnewsemail',
'contactname', 'name', 'description', 'imageurl', 'contactphone', 'regioncode',
'geolocation', 'street', 'organisationtype'];
'geolocation', 'street', 'organisationtype', 'commnewsfirstname', 'commnewslastname'];
/** @var array List of new FORM_FIELDS or siteinfo fields added indexed by the version when they were added.
* If site was already registered, admin will be promted to confirm new registration data manually. Until registration is manually confirmed,
public/lib/classes/hub/site_registration_form.php
+74 -25
View File
@@ -77,10 +77,10 @@ class site_registration_form extends \moodleform {
$mform->addElement('header', 'moodle', get_string('registrationinfo', 'hub'));
$mform->addElement('text', 'name', get_string('sitename', 'hub'),
$mform->addElement('text', 'name', get_string('organisationname', 'hub'),
array('class' => 'registration_textfield', 'maxlength' => 255));
$mform->setType('name', PARAM_TEXT);
$mform->addHelpButton('name', 'sitename', 'hub');
$mform->addHelpButton('name', 'organisationname', 'hub');
$organisationtypes = registration::get_site_organisation_type_options();
\core_collator::asort($organisationtypes);
@@ -140,17 +140,47 @@ class site_registration_form extends \moodleform {
$mform->setType('contactemail', PARAM_EMAIL);
$mform->addHelpButton('contactemail', 'siteemail', 'hub');
$this->add_checkbox_with_email('emailalert', 'siteregistrationemail', false, get_string('registrationyes'));
$mform->addElement('html', html_writer::empty_tag('hr'));
// Admin notification emails.
$mform->addElement('checkbox', 'emailalert', get_string('siteregistrationemail', 'hub'), get_string('registrationyes'));
$mform->setDefault('emailalert', 1);
$mform->addElement('checkbox', 'emailalertdifferentemail', get_string('email'),
get_string('usedifferentemail', 'hub'));
$mform->hideif('emailalertdifferentemail', 'emailalert', 'notchecked');
$mform->addElement('text', 'emailalertemail', '', ['maxlength' => 100]);
$mform->setType('emailalertemail', PARAM_RAW_TRIMMED);
$mform->hideif('emailalertemail', 'emailalertdifferentemail', 'notchecked');
$mform->hideif('emailalertemail', 'emailalert', 'notchecked');
$mform->addElement('html', html_writer::empty_tag('hr'));
// Communication news emails (expert tips).
$privacyurl = new moodle_url('https://moodle.com/privacy-notice/');
$experttipsandinsightsdesc = html_writer::span(get_string('experttipsandinsightsdesc', 'hub', $privacyurl->out()));
$this->add_checkbox_with_email(
elementname: 'commnews',
stridentifier: 'experttipsandinsights',
highlight: in_array('commnews', $highlightfields),
checkboxtext: $experttipsandinsightsdesc,
showhelp: false,
);
$mform->addElement('checkbox', 'commnews', get_string('experttipsandinsights', 'hub'), $experttipsandinsightsdesc);
$mform->addElement('text', 'commnewsfirstname', get_string('firstname'), ['maxlength' => 100]);
$mform->setType('commnewsfirstname', PARAM_TEXT);
$mform->hideif('commnewsfirstname', 'commnews', 'notchecked');
$mform->setDefault('commnewsfirstname', $admin->firstname);
$mform->addElement('text', 'commnewslastname', get_string('lastname'), ['maxlength' => 100]);
$mform->setType('commnewslastname', PARAM_TEXT);
$mform->hideif('commnewslastname', 'commnews', 'notchecked');
$mform->setDefault('commnewslastname', $admin->lastname);
$mform->addElement('checkbox', 'commnewsdifferentemail', get_string('email'),
get_string('usedifferentemail', 'hub'));
$mform->hideif('commnewsdifferentemail', 'commnews', 'notchecked');
$mform->addElement('text', 'commnewsemail', '', ['maxlength' => 100]);
$mform->setType('commnewsemail', PARAM_RAW_TRIMMED);
$mform->hideif('commnewsemail', 'commnewsdifferentemail', 'notchecked');
$mform->hideif('commnewsemail', 'commnews', 'notchecked');
$mform->addElement('html', html_writer::empty_tag('hr'));
// TODO site logo.
$mform->addElement('hidden', 'imageurl', ''); // TODO: temporary.
@@ -183,12 +213,13 @@ class site_registration_form extends \moodleform {
$mform->setType('returnurl', PARAM_LOCALURL);
// Prepare and set data.
$siteinfo['emailalertnewemail'] = !empty($siteinfo['emailalert']) && !empty($siteinfo['emailalertemail']);
if (empty($siteinfo['emailalertnewemail'])) {
// We don't store some checkbox values. Set the checkboxes depending on other stored settings.
$siteinfo['emailalertdifferentemail'] = !empty($siteinfo['emailalert']) && !empty($siteinfo['emailalertemail']);
if (empty($siteinfo['emailalertdifferentemail'])) {
$siteinfo['emailalertemail'] = '';
}
$siteinfo['commnewsnewemail'] = !empty($siteinfo['commnews']) && !empty($siteinfo['commnewsemail']);
if (empty($siteinfo['commnewsnewemail'])) {
$siteinfo['commnewsdifferentemail'] = !empty($siteinfo['commnews']) && !empty($siteinfo['commnewsemail']);
if (empty($siteinfo['commnewsdifferentemail'])) {
$siteinfo['commnewsemail'] = '';
}
@@ -261,11 +292,11 @@ class site_registration_form extends \moodleform {
public function validation($data, $files) {
$errors = parent::validation($data, $files);
// Validate optional emails. We do not use PARAM_EMAIL because it blindly clears the field if it is not a valid email.
if (!empty($data['emailalert']) && !empty($data['emailalertnewemail']) && !validate_email($data['emailalertemail'])) {
$errors['emailalertgroup'] = get_string('invalidemail');
if (!empty($data['emailalert']) && !empty($data['emailalertdifferentemail']) && !validate_email($data['emailalertemail'])) {
$errors['emailalertemail'] = get_string('invalidemail');
}
if (!empty($data['commnews']) && !empty($data['commnewsnewemail']) && !validate_email($data['commnewsemail'])) {
$errors['commnewsgroup'] = get_string('invalidemail');
if (!empty($data['commnews']) && !empty($data['commnewsdifferentemail']) && !validate_email($data['commnewsemail'])) {
$errors['commnewsemail'] = get_string('invalidemail');
}
return $errors;
}
@@ -277,15 +308,33 @@ class site_registration_form extends \moodleform {
*/
public function get_data() {
if ($data = parent::get_data()) {
// Never return '*newemail' checkboxes, always return 'emailalertemail' and 'commnewsemail' even if not applicable.
if (empty($data->emailalert) || empty($data->emailalertnewemail)) {
$data->emailalertemail = null;
// Ensure emailalert values are sent to the hub (when checkbox is unticked).
if (!isset($data->emailalert)) {
$data->emailalert = 0;
}
unset($data->emailalertnewemail);
if (empty($data->commnews) || empty($data->commnewsnewemail)) {
$data->commnewsemail = null;
// Ensure commnews values are sent to the hub (when checkbox is unticked).
if (!isset($data->commnews)) {
$data->commnews = 0;
}
// Reset the emailalertemail email address if emailalertdifferentemail is not ticked.
if (empty($data->emailalertdifferentemail)) {
$data->emailalertemail = '';
}
unset($data->emailalertdifferentemail);
// Reset the commnewsemail email address if commnewsdifferentemail is not ticked.
if (empty($data->commnewsdifferentemail)) {
$data->commnewsemail = '';
}
unset($data->commnewsdifferentemail);
// Reset contact details if commnews is not ticked.
if (empty($data->commnews)) {
$data->commnewsfirstname = '';
$data->commnewslastname = '';
}
unset($data->commnewsnewemail);
if (debugging('', DEBUG_DEVELOPER)) {
// Display debugging message for developers who added fields to the form and forgot to add them to registration::FORM_FIELDS.