MDL-23899 locale aware asort + unit tests

lib/simpletest/testtextlib.php

@@ -0,0 +1,58 @@
+<?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/>.
+
+/**
+ * Functions to support installation process
+ *
+ * @package    core
+ * @subpackage lib
+ * @copyright  2010 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+
+/**
+ * Unit tests for our utf-8 aware text processing
+ *
+ * @package    core
+ * @subpackage lib
+ * @copyright  2010 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class textlib_test extends UnitTestCase {
+
+    public static $includecoverage = array('lib/textlib.class.php');
+
+    public function test_asort() {
+        global $SESSION;
+        $SESSION->lang = 'en'; // make sure we test en language to get consistent results, hopefully all systems have this locale
+
+        $arr = array('b'=>'ab', 1=>'aa', 0=>'cc');
+        $result = textlib_get_instance()->asort($arr);
+        $this->assertIdentical(array_keys($result), array(1, 'b', 0));
+        $this->assertIdentical(array_values($result), array('aa', 'ab', 'cc'));
+
+        $arr = array('a'=>'áb', 'b'=>'ab', 1=>'aa', 0=>'cc');
+        $result = textlib_get_instance()->asort($arr);
+        $this->assertIdentical(array_keys($result), array(1, 'b', 'a', 0), 'Collation aware sorting not supported');
+
+        unset($SESSION->lang);
+    }
+
+}

lib/textlib.class.php

@@ -465,4 +465,20 @@ function strtotitle($text) {
         }
         return implode(' ', $words);
     }
+
+    /**
+     * Locale aware sorting, the key associations are kept, values are sorted alphabetically.
+     * @param array $arr array to be sorted
+     * @param string $lang moodle language
+     * @return array
+     */
+    function asort(array $arr) {
+        if (function_exists('collator_asort')) {
+            $coll = collator_create(get_string('locale', 'langconfig'));
+            collator_asort($coll, $arr);
+        } else {
+            asort($arr);
+        }
+        return $arr;
+    }
 }