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

Merge branch 'wip-MDL-42177-master-three' of git://github.com/abgreeve/moodle

Browse Source
This commit is contained in:
Marina Glancy
2013-10-22 09:48:57 +11:00
parent 9c5ab08e5a 0c76aa984c
commit 83a3e35e56
2 changed files with 204 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
user/editlib.php
+86 -36
View File
@@ -129,38 +129,16 @@ function useredit_shared_definition(&$mform, $editoroptions = null, $filemanager
$strrequired = get_string('required');
$nameformat = $CFG->fullnamedisplay;
if ($nameformat == 'language') {
$nameformat = get_string('fullnamedisplay');
}
$necessarynames = array('firstname', 'lastname');
$enablednames = array_diff(get_all_user_name_fields(), $necessarynames);
// Get a list of all of the enabled names.
$enabledadditionalusernames = array();
foreach ($enablednames as $enabledname) {
if (strpos($CFG->fullnamedisplay, $enabledname) !== false) {
$enabledadditionalusernames[] = $enabledname;
}
}
$combinednames = array_merge($necessarynames, $enabledadditionalusernames);
$requirednames = order_in_string($combinednames, $nameformat);
foreach ($necessarynames as $necessaryname) {
if (!in_array($necessaryname, $requirednames)) {
$requirednames = order_in_string($combinednames, get_string('fullnamedisplay'));
}
}
foreach ($requirednames as $fullname) {
// Add the necessary names.
foreach (useredit_get_required_name_fields() as $fullname) {
$mform->addElement('text', $fullname, get_string($fullname), 'maxlength="100" size="30"');
$mform->addRule($fullname, $strrequired, 'required', null, 'client');
$mform->setType($fullname, PARAM_NOTAGS);
}
$mform->addRule('firstname', $strrequired, 'required', null, 'client');
$mform->addRule('lastname', $strrequired, 'required', null, 'client');
$morenames = array_diff($enabledadditionalusernames, $requirednames);
foreach ($morenames as $addname) {
$enabledusernamefields = useredit_get_enabled_name_fields();
// Add the enabled additional name fields.
foreach ($enabledusernamefields as $addname) {
$mform->addElement('text', $addname, get_string($addname), 'maxlength="100" size="30"');
$mform->setType($addname, PARAM_NOTAGS);
}
@@ -311,16 +289,14 @@ function useredit_shared_definition(&$mform, $editoroptions = null, $filemanager
}
$alladditionalnames = array_diff(get_all_user_name_fields(), $necessarynames);
if (count($enabledadditionalusernames) < count($alladditionalnames)) {
// Display user name fields that are not currenlty enabled here if there are any.
$disabledusernamefields = useredit_get_disabled_name_fields($enabledusernamefields);
if (isset($disabledusernamefields[0])) {
$mform->addElement('header', 'moodle_additional_names', get_string('additionalnames'));
foreach ($alladditionalnames as $allname) {
if (!in_array($allname, $enabledadditionalusernames)) {
$mform->addElement('text', $allname, get_string($allname), 'maxlength="100" size="30"');
$mform->setType($allname, PARAM_NOTAGS);
}
foreach ($disabledusernamefields as $allname) {
$mform->addElement('text', $allname, get_string($allname), 'maxlength="100" size="30"');
$mform->setType($allname, PARAM_NOTAGS);
}
}
if (!empty($CFG->usetags) and empty($USER->newadminuser)) {
@@ -371,4 +347,78 @@ function useredit_shared_definition(&$mform, $editoroptions = null, $filemanager
}
/**
* Return required user name fields for forms.
*
* @return array required user name fields in order according to settings.
*/
function useredit_get_required_name_fields() {
global $CFG;
// Get the name display format.
$nameformat = $CFG->fullnamedisplay;
// Names that are required fields on user forms.
$necessarynames = array('firstname', 'lastname');
$languageformat = get_string('fullnamedisplay');
// Check that the language string and the $nameformat contain the necessary names.
foreach ($necessarynames as $necessaryname) {
$pattern = "/$necessaryname\b/";
if (!preg_match($pattern, $languageformat)) {
// If the language string has been altered then fall back on the below order.
$languageformat = 'firstname lastname';
}
if (!preg_match($pattern, $nameformat)) {
// If the nameformat doesn't contain the necessary name fields then use the languageformat.
$nameformat = $languageformat;
}
}
// Order all of the name fields in the postion they are written in the fullnamedisplay setting.
$necessarynames = order_in_string($necessarynames, $nameformat);
return $necessarynames;
}
/**
* Gets enabled (from fullnameformate setting) user name fields in appropriate order.
*
* @return array Enabled user name fields.
*/
function useredit_get_enabled_name_fields() {
global $CFG;
// Get all of the other name fields which are not ranked as necessary.
$additionalusernamefields = array_diff(get_all_user_name_fields(), array('firstname', 'lastname'));
// Find out which additional name fields are actually being used from the fullnamedisplay setting.
$enabledadditionalusernames = array();
foreach ($additionalusernamefields as $enabledname) {
if (strpos($CFG->fullnamedisplay, $enabledname) !== false) {
$enabledadditionalusernames[] = $enabledname;
}
}
// Order all of the name fields in the postion they are written in the fullnamedisplay setting.
$enabledadditionalusernames = order_in_string($enabledadditionalusernames, $CFG->fullnamedisplay);
return $enabledadditionalusernames;
}
/**
* Gets user name fields not enabled from the setting fullnamedisplay.
*
* @param array $enabledadditionalusernames Current enabled additional user name fields.
* @return array Disabled user name fields.
*/
function useredit_get_disabled_name_fields($enabledadditionalusernames = null) {
// If we don't have enabled additional user name information then go and fetch it (try to avoid).
if (!isset($enabledadditionalusernames)) {
$enabledadditionalusernames = useredit_get_enabled_name_fields();
}
// These are the additional fields that are not currently enabled.
$nonusednamefields = array_diff(get_all_user_name_fields(),
array_merge(array('firstname', 'lastname'), $enabledadditionalusernames));
return $nonusednamefields;
}
user/tests/editlib_test.php
+118
View File
@@ -0,0 +1,118 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Unit tests for user/editlib.php.
*
* @package core_user
* @category phpunit
* @copyright 2013 Adrian Greeve <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->dirroot.'/user/editlib.php');
/**
* Unit tests for user editlib api.
*
* @package core_user
* @category phpunit
* @copyright 2013 Adrian Greeve <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_user_editlib_testcase extends advanced_testcase {
/**
* Test that the required fields are returned in the correct order.
*/
function test_useredit_get_required_name_fields() {
global $CFG;
// Back up config settings for restore later.
$originalcfg = new stdClass();
$originalcfg->fullnamedisplay = $CFG->fullnamedisplay;
$CFG->fullnamedisplay = 'language';
$expectedresult = array(5 => 'firstname', 21 => 'lastname');
$this->assertEquals(useredit_get_required_name_fields(), $expectedresult);
$CFG->fullnamedisplay = 'firstname';
$expectedresult = array(5 => 'firstname', 21 => 'lastname');
$this->assertEquals(useredit_get_required_name_fields(), $expectedresult);
$CFG->fullnamedisplay = 'lastname firstname';
$expectedresult = array('lastname', 9 => 'firstname');
$this->assertEquals(useredit_get_required_name_fields(), $expectedresult);
$CFG->fullnamedisplay = 'firstnamephonetic lastnamephonetic';
$expectedresult = array(5 => 'firstname', 21 => 'lastname');
$this->assertEquals(useredit_get_required_name_fields(), $expectedresult);
// Tidy up after we finish testing.
$CFG->fullnamedisplay = $originalcfg->fullnamedisplay;
}
/**
* Test that the enabled fields are returned in the correct order.
*/
function test_useredit_get_enabled_name_fields() {
global $CFG;
// Back up config settings for restore later.
$originalcfg = new stdClass();
$originalcfg->fullnamedisplay = $CFG->fullnamedisplay;
$CFG->fullnamedisplay = 'language';
$expectedresult = array();
$this->assertEquals(useredit_get_enabled_name_fields(), $expectedresult);
$CFG->fullnamedisplay = 'firstname lastname firstnamephonetic';
$expectedresult = array(19 => 'firstnamephonetic');
$this->assertEquals(useredit_get_enabled_name_fields(), $expectedresult);
$CFG->fullnamedisplay = 'firstnamephonetic, lastname lastnamephonetic (alternatename)';
$expectedresult = array('firstnamephonetic', 28 => 'lastnamephonetic', 46 => 'alternatename');
$this->assertEquals(useredit_get_enabled_name_fields(), $expectedresult);
$CFG->fullnamedisplay = 'firstnamephonetic lastnamephonetic alternatename middlename';
$expectedresult = array('firstnamephonetic', 18 => 'lastnamephonetic', 35 => 'alternatename', 49 => 'middlename');
$this->assertEquals(useredit_get_enabled_name_fields(), $expectedresult);
// Tidy up after we finish testing.
$CFG->fullnamedisplay = $originalcfg->fullnamedisplay;
}
/**
* Test that the disabled fields are returned.
*/
function test_useredit_get_disabled_name_fields() {
global $CFG;
// Back up config settings for restore later.
$originalcfg = new stdClass();
$originalcfg->fullnamedisplay = $CFG->fullnamedisplay;
$CFG->fullnamedisplay = 'language';
$expectedresult = array('firstnamephonetic', 'lastnamephonetic', 'middlename', 'alternatename');
$this->assertEquals(useredit_get_disabled_name_fields(), $expectedresult);
$CFG->fullnamedisplay = 'firstname lastname firstnamephonetic';
$expectedresult = array(1 => 'lastnamephonetic', 2 => 'middlename', 3 => 'alternatename');
$this->assertEquals(useredit_get_disabled_name_fields(), $expectedresult);
$CFG->fullnamedisplay = 'firstnamephonetic, lastname lastnamephonetic (alternatename)';
$expectedresult = array(2 => 'middlename');
$this->assertEquals(useredit_get_disabled_name_fields(), $expectedresult);
$CFG->fullnamedisplay = 'firstnamephonetic lastnamephonetic alternatename middlename';
$expectedresult = array();
$this->assertEquals(useredit_get_disabled_name_fields(), $expectedresult);
// Tidy up after we finish testing.
$CFG->fullnamedisplay = $originalcfg->fullnamedisplay;
}
}