Tim Hunt
9f82ddd66f
The purpose of this method is to ensure that when we display lists of users in different places, the default sort order is consistent. Having this code centralised in one place them makes it possible to improve things accross the board, and there is an example of that here. There is logic so that if we are searching for particular string, then users with an exact match are sorted first.
91 lines
3.5 KiB
PHP
91 lines
3.5 KiB
PHP
<?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/>.
|
|
|
|
/**
|
|
* Test for various bits of datalib.php.
|
|
*
|
|
* @package core
|
|
* @category phpunit
|
|
* @copyright 2012 The Open University
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
|
|
/**
|
|
* Test for various bits of datalib.php.
|
|
*
|
|
* @package core_css
|
|
* @category css
|
|
* @copyright 2012 Sam Hemelryk
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class datalib_testcase extends advanced_testcase {
|
|
protected function normalise_sql($sort) {
|
|
return preg_replace('~\s+~', ' ', $sort);
|
|
}
|
|
|
|
protected function assert_same_sql($expected, $actual) {
|
|
$this->assertEquals($this->normalise_sql($expected), $this->normalise_sql($actual));
|
|
}
|
|
|
|
public function test_users_order_by_sql_simple() {
|
|
list($sort, $params) = users_order_by_sql();
|
|
$this->assert_same_sql('lastname, firstname, id', $sort);
|
|
$this->assertEquals(array(), $params);
|
|
}
|
|
|
|
public function test_users_order_by_sql_table_prefix() {
|
|
list($sort, $params) = users_order_by_sql('u');
|
|
$this->assert_same_sql('u.lastname, u.firstname, u.id', $sort);
|
|
$this->assertEquals(array(), $params);
|
|
}
|
|
|
|
public function test_users_order_by_sql_search_no_extra_fields() {
|
|
global $CFG, $DB;
|
|
$CFG->showuseridentity = '';
|
|
$this->resetAfterTest(true);
|
|
|
|
list($sort, $params) = users_order_by_sql('', 'search', context_system::instance());
|
|
$this->assert_same_sql('CASE WHEN
|
|
' . $DB->sql_fullname() . ' = :usersortexact1 OR
|
|
firstname = :usersortexact2 OR
|
|
lastname = :usersortexact3
|
|
THEN 0 ELSE 1 END, lastname, firstname, id', $sort);
|
|
$this->assertEquals(array('usersortexact1' => 'search', 'usersortexact2' => 'search',
|
|
'usersortexact3' => 'search'), $params);
|
|
}
|
|
|
|
public function test_users_order_by_sql_search_with_extra_fields_and_prefix() {
|
|
global $CFG, $DB;
|
|
$CFG->showuseridentity = 'email,idnumber';
|
|
$this->setAdminUser();
|
|
$this->resetAfterTest(true);
|
|
|
|
list($sort, $params) = users_order_by_sql('u', 'search', context_system::instance());
|
|
$this->assert_same_sql('CASE WHEN
|
|
' . $DB->sql_fullname('u.firstname', 'u.lastname') . ' = :usersortexact1 OR
|
|
u.firstname = :usersortexact2 OR
|
|
u.lastname = :usersortexact3 OR
|
|
u.email = :usersortexact4 OR
|
|
u.idnumber = :usersortexact5
|
|
THEN 0 ELSE 1 END, u.lastname, u.firstname, u.id', $sort);
|
|
$this->assertEquals(array('usersortexact1' => 'search', 'usersortexact2' => 'search',
|
|
'usersortexact3' => 'search', 'usersortexact4' => 'search', 'usersortexact5' => 'search'), $params);
|
|
}
|
|
}
|