f071531368304215215fc9c3a4ecad445ca76f30
[moodle.git] / lib / tests / textlib_test.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * textlib unit tests
19  *
20  * @package    core
21  * @category   phpunit
22  * @copyright  2012 Petr Skoda {@link http://skodak.org}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Unit tests for our utf-8 aware text processing
31  *
32  * @package    core
33  * @category   phpunit
34  * @copyright  2010 Petr Skoda (http://skodak.org)
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class core_textlib_testcase extends basic_testcase {
39     /**
40      * Tests the static parse charset method
41      * @return void
42      */
43     public function test_parse_charset() {
44         $this->assertSame(textlib::parse_charset('Cp1250'), 'windows-1250');
45         // does typo3 work? some encoding moodle does not use
46         $this->assertSame(textlib::parse_charset('ms-ansi'), 'windows-1252');
47     }
49     /**
50      * Tests the static convert method
51      * @return void
52      */
53     public function test_convert() {
54         $utf8 = "Žluťoučký koníček";
55         $iso2 = pack("H*", "ae6c75bb6f75e86bfd206b6f6eede8656b");
56         $win  = pack("H*", "8e6c759d6f75e86bfd206b6f6eede8656b");
57         $this->assertSame(textlib::convert($utf8, 'utf-8', 'iso-8859-2'), $iso2);
58         $this->assertSame(textlib::convert($iso2, 'iso-8859-2', 'utf-8'), $utf8);
59         $this->assertSame(textlib::convert($utf8, 'utf-8', 'win-1250'), $win);
60         $this->assertSame(textlib::convert($win, 'win-1250', 'utf-8'), $utf8);
61         $this->assertSame(textlib::convert($win, 'win-1250', 'iso-8859-2'), $iso2);
62         $this->assertSame(textlib::convert($iso2, 'iso-8859-2', 'win-1250'), $win);
63         $this->assertSame(textlib::convert($iso2, 'iso-8859-2', 'iso-8859-2'), $iso2);
64         $this->assertSame(textlib::convert($win, 'win-1250', 'cp1250'), $win);
65         $this->assertSame(textlib::convert($utf8, 'utf-8', 'utf-8'), $utf8);
68         $utf8 = '言語設定';
69         $str = pack("H*", "b8c0b8ecc0dfc4ea"); //EUC-JP
70         $this->assertSame(textlib::convert($utf8, 'utf-8', 'EUC-JP'), $str);
71         $this->assertSame(textlib::convert($str, 'EUC-JP', 'utf-8'), $utf8);
72         $this->assertSame(textlib::convert($utf8, 'utf-8', 'utf-8'), $utf8);
74         $str = pack("H*", "1b24423840386c405f446a1b2842"); //ISO-2022-JP
75         $this->assertSame(textlib::convert($utf8, 'utf-8', 'ISO-2022-JP'), $str);
76         $this->assertSame(textlib::convert($str, 'ISO-2022-JP', 'utf-8'), $utf8);
77         $this->assertSame(textlib::convert($utf8, 'utf-8', 'utf-8'), $utf8);
79         $str = pack("H*", "8cbe8cea90dd92e8"); //SHIFT-JIS
80         $this->assertSame(textlib::convert($utf8, 'utf-8', 'SHIFT-JIS'), $str);
81         $this->assertSame(textlib::convert($str, 'SHIFT-JIS', 'utf-8'), $utf8);
82         $this->assertSame(textlib::convert($utf8, 'utf-8', 'utf-8'), $utf8);
84         $utf8 = '简体中文';
85         $str = pack("H*", "bcf2cce5d6d0cec4"); //GB2312
86         $this->assertSame(textlib::convert($utf8, 'utf-8', 'GB2312'), $str);
87         $this->assertSame(textlib::convert($str, 'GB2312', 'utf-8'), $utf8);
88         $this->assertSame(textlib::convert($utf8, 'utf-8', 'utf-8'), $utf8);
90         $str = pack("H*", "bcf2cce5d6d0cec4"); //GB18030
91         $this->assertSame(textlib::convert($utf8, 'utf-8', 'GB18030'), $str);
92         $this->assertSame(textlib::convert($str, 'GB18030', 'utf-8'), $utf8);
93         $this->assertSame(textlib::convert($utf8, 'utf-8', 'utf-8'), $utf8);
94     }
96     /**
97      * Tests the static sub string method
98      * @return void
99      */
100     public function test_substr() {
101         $str = "Žluťoučký koníček";
102         $this->assertSame(textlib::substr($str, 0), $str);
103         $this->assertSame(textlib::substr($str, 1), 'luťoučký koníček');
104         $this->assertSame(textlib::substr($str, 1, 3), 'luť');
105         $this->assertSame(textlib::substr($str, 0, 100), $str);
106         $this->assertSame(textlib::substr($str, -3, 2), 'če');
108         $iso2 = pack("H*", "ae6c75bb6f75e86bfd206b6f6eede8656b");
109         $this->assertSame(textlib::substr($iso2, 1, 3, 'iso-8859-2'), textlib::convert('luť', 'utf-8', 'iso-8859-2'));
110         $this->assertSame(textlib::substr($iso2, 0, 100, 'iso-8859-2'), textlib::convert($str, 'utf-8', 'iso-8859-2'));
111         $this->assertSame(textlib::substr($iso2, -3, 2, 'iso-8859-2'), textlib::convert('če', 'utf-8', 'iso-8859-2'));
113         $win  = pack("H*", "8e6c759d6f75e86bfd206b6f6eede8656b");
114         $this->assertSame(textlib::substr($win, 1, 3, 'cp1250'), textlib::convert('luť', 'utf-8', 'cp1250'));
115         $this->assertSame(textlib::substr($win, 0, 100, 'cp1250'), textlib::convert($str, 'utf-8', 'cp1250'));
116         $this->assertSame(textlib::substr($win, -3, 2, 'cp1250'), textlib::convert('če', 'utf-8', 'cp1250'));
119         $str = pack("H*", "b8c0b8ecc0dfc4ea"); //EUC-JP
120         $s = pack("H*", "b8ec"); //EUC-JP
121         $this->assertSame(textlib::substr($str, 1, 1, 'EUC-JP'), $s);
123         $str = pack("H*", "1b24423840386c405f446a1b2842"); //ISO-2022-JP
124         $s = pack("H*", "1b2442386c1b2842"); //ISO-2022-JP
125         $this->assertSame(textlib::substr($str, 1, 1, 'ISO-2022-JP'), $s);
127         $str = pack("H*", "8cbe8cea90dd92e8"); //SHIFT-JIS
128         $s = pack("H*", "8cea"); //SHIFT-JIS
129         $this->assertSame(textlib::substr($str, 1, 1, 'SHIFT-JIS'), $s);
131         $str = pack("H*", "bcf2cce5d6d0cec4"); //GB2312
132         $s = pack("H*", "cce5"); //GB2312
133         $this->assertSame(textlib::substr($str, 1, 1, 'GB2312'), $s);
135         $str = pack("H*", "bcf2cce5d6d0cec4"); //GB18030
136         $s = pack("H*", "cce5"); //GB18030
137         $this->assertSame(textlib::substr($str, 1, 1, 'GB18030'), $s);
138     }
140     /**
141      * Tests the static string length method
142      * @return void
143      */
144     public function test_strlen() {
145         $str = "Žluťoučký koníček";
146         $this->assertSame(textlib::strlen($str), 17);
148         $iso2 = pack("H*", "ae6c75bb6f75e86bfd206b6f6eede8656b");
149         $this->assertSame(textlib::strlen($iso2, 'iso-8859-2'), 17);
151         $win  = pack("H*", "8e6c759d6f75e86bfd206b6f6eede8656b");
152         $this->assertSame(textlib::strlen($win, 'cp1250'), 17);
155         $str = pack("H*", "b8ec"); //EUC-JP
156         $this->assertSame(textlib::strlen($str, 'EUC-JP'), 1);
157         $str = pack("H*", "b8c0b8ecc0dfc4ea"); //EUC-JP
158         $this->assertSame(textlib::strlen($str, 'EUC-JP'), 4);
160         $str = pack("H*", "1b2442386c1b2842"); //ISO-2022-JP
161         $this->assertSame(textlib::strlen($str, 'ISO-2022-JP'), 1);
162         $str = pack("H*", "1b24423840386c405f446a1b2842"); //ISO-2022-JP
163         $this->assertSame(textlib::strlen($str, 'ISO-2022-JP'), 4);
165         $str = pack("H*", "8cea"); //SHIFT-JIS
166         $this->assertSame(textlib::strlen($str, 'SHIFT-JIS'), 1);
167         $str = pack("H*", "8cbe8cea90dd92e8"); //SHIFT-JIS
168         $this->assertSame(textlib::strlen($str, 'SHIFT-JIS'), 4);
170         $str = pack("H*", "cce5"); //GB2312
171         $this->assertSame(textlib::strlen($str, 'GB2312'), 1);
172         $str = pack("H*", "bcf2cce5d6d0cec4"); //GB2312
173         $this->assertSame(textlib::strlen($str, 'GB2312'), 4);
175         $str = pack("H*", "cce5"); //GB18030
176         $this->assertSame(textlib::strlen($str, 'GB18030'), 1);
177         $str = pack("H*", "bcf2cce5d6d0cec4"); //GB18030
178         $this->assertSame(textlib::strlen($str, 'GB18030'), 4);
179     }
181     /**
182      * Tests the static strtolower method
183      * @return void
184      */
185     public function test_strtolower() {
186         $str = "Žluťoučký koníček";
187         $low = 'žluťoučký koníček';
188         $this->assertSame(textlib::strtolower($str), $low);
190         $iso2 = pack("H*", "ae6c75bb6f75e86bfd206b6f6eede8656b");
191         $this->assertSame(textlib::strtolower($iso2, 'iso-8859-2'), textlib::convert($low, 'utf-8', 'iso-8859-2'));
193         $win  = pack("H*", "8e6c759d6f75e86bfd206b6f6eede8656b");
194         $this->assertSame(textlib::strtolower($win, 'cp1250'), textlib::convert($low, 'utf-8', 'cp1250'));
197         $str = '言語設定';
198         $this->assertSame(textlib::strtolower($str), $str);
200         $str = '简体中文';
201         $this->assertSame(textlib::strtolower($str), $str);
203         $str = pack("H*", "1b24423840386c405f446a1b2842"); //ISO-2022-JP
204         $this->assertSame(textlib::strtolower($str, 'ISO-2022-JP'), $str);
206         $str = pack("H*", "8cbe8cea90dd92e8"); //SHIFT-JIS
207         $this->assertSame(textlib::strtolower($str, 'SHIFT-JIS'), $str);
209         $str = pack("H*", "bcf2cce5d6d0cec4"); //GB2312
210         $this->assertSame(textlib::strtolower($str, 'GB2312'), $str);
212         $str = pack("H*", "bcf2cce5d6d0cec4"); //GB18030
213         $this->assertSame(textlib::strtolower($str, 'GB18030'), $str);
215         // typo3 has problems with integers
216         $str = 1309528800;
217         $this->assertSame((string)$str, textlib::strtolower($str));
218     }
220     /**
221      * Tests the static strtoupper
222      * @return void
223      */
224     public function test_strtoupper() {
225         $str = "Žluťoučký koníček";
226         $up  = 'ŽLUŤOUČKÝ KONÍČEK';
227         $this->assertSame(textlib::strtoupper($str), $up);
229         $iso2 = pack("H*", "ae6c75bb6f75e86bfd206b6f6eede8656b");
230         $this->assertSame(textlib::strtoupper($iso2, 'iso-8859-2'), textlib::convert($up, 'utf-8', 'iso-8859-2'));
232         $win  = pack("H*", "8e6c759d6f75e86bfd206b6f6eede8656b");
233         $this->assertSame(textlib::strtoupper($win, 'cp1250'), textlib::convert($up, 'utf-8', 'cp1250'));
236         $str = '言語設定';
237         $this->assertSame(textlib::strtoupper($str), $str);
239         $str = '简体中文';
240         $this->assertSame(textlib::strtoupper($str), $str);
242         $str = pack("H*", "1b24423840386c405f446a1b2842"); //ISO-2022-JP
243         $this->assertSame(textlib::strtoupper($str, 'ISO-2022-JP'), $str);
245         $str = pack("H*", "8cbe8cea90dd92e8"); //SHIFT-JIS
246         $this->assertSame(textlib::strtoupper($str, 'SHIFT-JIS'), $str);
248         $str = pack("H*", "bcf2cce5d6d0cec4"); //GB2312
249         $this->assertSame(textlib::strtoupper($str, 'GB2312'), $str);
251         $str = pack("H*", "bcf2cce5d6d0cec4"); //GB18030
252         $this->assertSame(textlib::strtoupper($str, 'GB18030'), $str);
253     }
255     /**
256      * Tests the static strpos method
257      * @return void
258      */
259     public function test_strpos() {
260         $str = "Žluťoučký koníček";
261         $this->assertSame(textlib::strpos($str, 'koníč'), 10);
262     }
264     /**
265      * Tests the static strrpos
266      * @return void
267      */
268     public function test_strrpos() {
269         $str = "Žluťoučký koníček";
270         $this->assertSame(textlib::strrpos($str, 'o'), 11);
271     }
273     /**
274      * Tests the static specialtoascii method
275      * @return void
276      */
277     public function test_specialtoascii() {
278         $str = "Žluťoučký koníček";
279         $this->assertSame(textlib::specialtoascii($str), 'Zlutoucky konicek');
280     }
282     /**
283      * Tests the static encode_mimeheader method
284      * @return void
285      */
286     public function test_encode_mimeheader() {
287         $str = "Žluťoučký koníček";
288         $this->assertSame(textlib::encode_mimeheader($str), '=?utf-8?B?xb1sdcWlb3XEjWvDvSBrb27DrcSNZWs=?=');
289     }
291     /**
292      * Tests the static entities_to_utf8 method
293      * @return void
294      */
295     public function test_entities_to_utf8() {
296         $str = "&#x17d;lu&#x165;ou&#x10d;k&#xfd; kon&#237;&#269;ek";
297         $this->assertSame(textlib::entities_to_utf8($str), "Žluťoučký koníček");
298     }
300     /**
301      * Tests the static utf8_to_entities method
302      * @return void
303      */
304     public function test_utf8_to_entities() {
305         $str = "Žluťoučký koníček";
306         $this->assertSame(textlib::utf8_to_entities($str), "&#x17d;lu&#x165;ou&#x10d;k&#xfd; kon&#xed;&#x10d;ek");
307         $this->assertSame(textlib::utf8_to_entities($str, true), "&#381;lu&#357;ou&#269;k&#253; kon&#237;&#269;ek");
309     }
311     /**
312      * Tests the static trim_utf8_bom method
313      * @return void
314      */
315     public function test_trim_utf8_bom() {
316         $bom = "\xef\xbb\xbf";
317         $str = "Žluťoučký koníček";
318         $this->assertSame(textlib::trim_utf8_bom($bom.$str.$bom), $str.$bom);
319     }
321     /**
322      * Tests the static get_encodings method
323      * @return void
324      */
325     public function test_get_encodings() {
326         $encodings = textlib::get_encodings();
327         $this->assertTrue(is_array($encodings));
328         $this->assertTrue(count($encodings) > 1);
329         $this->assertTrue(isset($encodings['UTF-8']));
330     }
332     /**
333      * Tests the static code2utf8 method
334      * @return void
335      */
336     public function test_code2utf8() {
337         $this->assertSame(textlib::code2utf8(381), 'Ž');
338     }
340     /**
341      * Tests the static strtotitle method
342      * @return void
343      */
344     public function test_strtotitle() {
345         $str = "žluťoučký koníček";
346         $this->assertSame(textlib::strtotitle($str), "Žluťoučký Koníček");
347     }
349     /**
350      * Tests the deprecated method of textlib that still require an instance.
351      * @return void
352      */
353     public function test_deprecated_textlib_get_instance() {
354         ob_start();
355         $textlib = textlib_get_instance();
356         $output = ob_get_contents();
357         $this->assertNotEmpty($output);
358         ob_end_clean();
359         $this->assertSame($textlib->substr('abc', 1, 1), 'b');
360         $this->assertSame($textlib->strlen('abc'), 3);
361         $this->assertSame($textlib->strtoupper('Abc'), 'ABC');
362         $this->assertSame($textlib->strtolower('Abc'), 'abc');
363         $this->assertSame($textlib->strpos('abc', 'a'), 0);
364         $this->assertSame($textlib->strpos('abc', 'd'), false);
365         $this->assertSame($textlib->strrpos('abcabc', 'a'), 3);
366         $this->assertSame($textlib->specialtoascii('ábc'), 'abc');
367         $this->assertSame($textlib->strtotitle('abc ABC'), 'Abc Abc');
368     }
372 /**
373  * Unit tests for our utf-8 aware collator.
374  *
375  * Used for sorting.
376  *
377  * @package    core
378  * @category   phpunit
379  * @copyright  2011 Sam Hemelryk
380  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
381  */
382 class collatorlib_testcase extends basic_testcase {
384     /**
385      * @var string The initial lang, stored because we change it during testing
386      */
387     protected $initiallang = null;
389     /**
390      * @var string The last error that has occured
391      */
392     protected $error = null;
394     /**
395      * Prepares things for this test case
396      * @return void
397      */
398     protected function setUp() {
399         global $SESSION;
400         if (isset($SESSION->lang)) {
401             $this->initiallang = $SESSION->lang;
402         }
403         $SESSION->lang = 'en'; // make sure we test en language to get consistent results, hopefully all systems have this locale
404         if (extension_loaded('intl')) {
405             $this->error = 'Collation aware sorting not supported';
406         } else {
407             $this->error = 'Collation aware sorting not supported, PHP extension "intl" is not available.';
408         }
409         parent::setUp();
410     }
412     /**
413      * Cleans things up after this test case has run
414      * @return void
415      */
416     protected function tearDown() {
417         global $SESSION;
418         parent::tearDown();
419         if ($this->initiallang !== null) {
420             $SESSION->lang = $this->initiallang;
421             $this->initiallang = null;
422         } else {
423             unset($SESSION->lang);
424         }
425     }
427     /**
428      * Tests the static asort method
429      * @return void
430      */
431     public function test_asort() {
432         $arr = array('b' => 'ab', 1 => 'aa', 0 => 'cc');
433         $result = collatorlib::asort($arr);
434         $this->assertSame(array_values($arr), array('aa', 'ab', 'cc'));
435         $this->assertSame(array_keys($arr), array(1, 'b', 0));
436         $this->assertTrue($result);
438         $arr = array('b' => 'ab', 1 => 'aa', 0 => 'cc');
439         $result = collatorlib::asort($arr, collatorlib::SORT_STRING);
440         $this->assertSame(array_values($arr), array('aa', 'ab', 'cc'));
441         $this->assertSame(array_keys($arr), array(1, 'b', 0));
442         $this->assertTrue($result);
444         $arr = array('b' => 'aac', 1 => 'Aac', 0 => 'cc');
445         $result = collatorlib::asort($arr, (collatorlib::SORT_STRING | collatorlib::CASE_SENSITIVE));
446         $this->assertSame(array_values($arr), array('Aac', 'aac', 'cc'));
447         $this->assertSame(array_keys($arr), array(1, 'b', 0));
448         $this->assertTrue($result);
450         $arr = array('b' => 'a1', 1 => 'a10', 0 => 'a3b');
451         $result = collatorlib::asort($arr);
452         $this->assertSame(array_values($arr), array('a1', 'a10', 'a3b'));
453         $this->assertSame(array_keys($arr), array('b', 1, 0));
454         $this->assertTrue($result);
456         $arr = array('b' => 'a1', 1 => 'a10', 0 => 'a3b');
457         $result = collatorlib::asort($arr, collatorlib::SORT_NATURAL);
458         $this->assertSame(array_values($arr), array('a1', 'a3b', 'a10'));
459         $this->assertSame(array_keys($arr), array('b', 0, 1));
460         $this->assertTrue($result);
462         $arr = array('b' => '1.1.1', 1 => '1.2', 0 => '1.20.2');
463         $result = collatorlib::asort($arr, collatorlib::SORT_NATURAL);
464         $this->assertSame(array_values($arr), array('1.1.1', '1.2', '1.20.2'));
465         $this->assertSame(array_keys($arr), array('b', 1, 0));
466         $this->assertTrue($result);
468         $arr = array('b' => '-1', 1 => 1000, 0 => -1.2, 3 => 1, 4 => false);
469         $result = collatorlib::asort($arr, collatorlib::SORT_NUMERIC);
470         $this->assertSame(array_values($arr), array(-1.2, '-1', false, 1, 1000));
471         $this->assertSame(array_keys($arr), array(0, 'b', 4, 3, 1));
472         $this->assertTrue($result);
474         $arr = array('b' => array(1), 1 => array(2, 3), 0 => 1);
475         $result = collatorlib::asort($arr, collatorlib::SORT_REGULAR);
476         $this->assertSame(array_values($arr), array(1, array(1), array(2, 3)));
477         $this->assertSame(array_keys($arr), array(0, 'b', 1));
478         $this->assertTrue($result);
480         // test sorting of array of arrays - first element should be used for actual comparison
481         $arr = array(0=>array('bb', 'z'), 1=>array('ab', 'a'), 2=>array('zz', 'x'));
482         $result = collatorlib::asort($arr, collatorlib::SORT_REGULAR);
483         $this->assertSame(array_keys($arr), array(1, 0, 2));
484         $this->assertTrue($result);
486         $arr = array('a' => 'áb', 'b' => 'ab', 1 => 'aa', 0=>'cc', 'x' => 'Áb',);
487         $result = collatorlib::asort($arr);
488         $this->assertSame(array_values($arr), array('aa', 'ab', 'áb', 'Áb', 'cc'), $this->error);
489         $this->assertSame(array_keys($arr), array(1, 'b', 'a', 'x', 0), $this->error);
490         $this->assertTrue($result);
492         $a = array(2=>'b', 1=>'c');
493         $c =& $a;
494         $b =& $a;
495         collatorlib::asort($b);
496         $this->assertSame($a, $b);
497         $this->assertSame($c, $b);
498     }
500     /**
501      * Tests the static asort_objects_by_method method
502      * @return void
503      */
504     public function test_asort_objects_by_method() {
505         $objects = array(
506             'b' => new string_test_class('ab'),
507             1 => new string_test_class('aa'),
508             0 => new string_test_class('cc')
509         );
510         $result = collatorlib::asort_objects_by_method($objects, 'get_protected_name');
511         $this->assertSame(array_keys($objects), array(1, 'b', 0));
512         $this->assertSame($this->get_ordered_names($objects, 'get_protected_name'), array('aa', 'ab', 'cc'));
513         $this->assertTrue($result);
515         $objects = array(
516             'b' => new string_test_class('a20'),
517             1 => new string_test_class('a1'),
518             0 => new string_test_class('a100')
519         );
520         $result = collatorlib::asort_objects_by_method($objects, 'get_protected_name', collatorlib::SORT_NATURAL);
521         $this->assertSame(array_keys($objects), array(1, 'b', 0));
522         $this->assertSame($this->get_ordered_names($objects, 'get_protected_name'), array('a1', 'a20', 'a100'));
523         $this->assertTrue($result);
524     }
526     /**
527      * Tests the static asort_objects_by_method method
528      * @return void
529      */
530     public function test_asort_objects_by_property() {
531         $objects = array(
532             'b' => new string_test_class('ab'),
533             1 => new string_test_class('aa'),
534             0 => new string_test_class('cc')
535         );
536         $result = collatorlib::asort_objects_by_property($objects, 'publicname');
537         $this->assertSame(array_keys($objects), array(1, 'b', 0));
538         $this->assertSame($this->get_ordered_names($objects, 'publicname'), array('aa', 'ab', 'cc'));
539         $this->assertTrue($result);
541         $objects = array(
542             'b' => new string_test_class('a20'),
543             1 => new string_test_class('a1'),
544             0 => new string_test_class('a100')
545         );
546         $result = collatorlib::asort_objects_by_property($objects, 'publicname', collatorlib::SORT_NATURAL);
547         $this->assertSame(array_keys($objects), array(1, 'b', 0));
548         $this->assertSame($this->get_ordered_names($objects, 'publicname'), array('a1', 'a20', 'a100'));
549         $this->assertTrue($result);
550     }
552     /**
553      * Returns an array of sorted names
554      * @param array $objects
555      * @param string $methodproperty
556      * @return type
557      */
558     protected function get_ordered_names($objects, $methodproperty = 'get_protected_name') {
559         $return = array();
560         foreach ($objects as $object) {
561             if ($methodproperty == 'publicname') {
562                 $return[] = $object->publicname;
563             } else {
564                 $return[] = $object->$methodproperty();
565             }
566         }
567         return $return;
568     }
570     /**
571      * Tests the static ksort method
572      * @return void
573      */
574     public function test_ksort() {
575         $arr = array('b' => 'ab', 1 => 'aa', 0 => 'cc');
576         $result = collatorlib::ksort($arr);
577         $this->assertSame(array_keys($arr), array(0, 1, 'b'));
578         $this->assertSame(array_values($arr), array('cc', 'aa', 'ab'));
579         $this->assertTrue($result);
581         $obj = new stdClass();
582         $arr = array('1.1.1'=>array(), '1.2'=>$obj, '1.20.2'=>null);
583         $result = collatorlib::ksort($arr, collatorlib::SORT_NATURAL);
584         $this->assertSame(array_keys($arr), array('1.1.1', '1.2', '1.20.2'));
585         $this->assertSame(array_values($arr), array(array(), $obj, null));
586         $this->assertTrue($result);
588         $a = array(2=>'b', 1=>'c');
589         $c =& $a;
590         $b =& $a;
591         collatorlib::ksort($b);
592         $this->assertSame($a, $b);
593         $this->assertSame($c, $b);
594     }
598 /**
599  * Simple class used to work with the unit test.
600  *
601  * @package    core
602  * @category   phpunit
603  * @copyright  2011 Sam Hemelryk
604  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
605  */
606 class string_test_class extends stdClass {
607     /**
608      * @var string A public property
609      */
610     public $publicname;
611     /**
612      * @var string A protected property
613      */
614     protected $protectedname;
615     /**
616      * @var string A private property
617      */
618     private $privatename;
619     /**
620      * Constructs the test instance
621      * @param string $name
622      */
623     public function __construct($name) {
624         $this->publicname = $name;
625         $this->protectedname = $name;
626         $this->privatename = $name;
627     }
628     /**
629      * Returns the protected property
630      * @return string
631      */
632     public function get_protected_name() {
633         return $this->protectedname;
634     }
635     /**
636      * Returns the protected property
637      * @return string
638      */
639     public function get_private_name() {
640         return $this->publicname;
641     }