Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | |
0.00% |
0 / 26 |
|
0.00% |
0 / 4 |
CRAP | |
0.00% |
0 / 1 |
NumericUppercaseCollation | |
0.00% |
0 / 26 |
|
0.00% |
0 / 4 |
56 | |
0.00% |
0 / 1 |
__construct | |
0.00% |
0 / 4 |
|
0.00% |
0 / 1 |
6 | |||
getSortKey | |
0.00% |
0 / 9 |
|
0.00% |
0 / 1 |
2 | |||
convertDigits | |
0.00% |
0 / 7 |
|
0.00% |
0 / 1 |
6 | |||
getFirstLetter | |
0.00% |
0 / 6 |
|
0.00% |
0 / 1 |
6 |
1 | <?php |
2 | /** |
3 | * This program is free software; you can redistribute it and/or modify |
4 | * it under the terms of the GNU General Public License as published by |
5 | * the Free Software Foundation; either version 2 of the License, or |
6 | * (at your option) any later version. |
7 | * |
8 | * This program is distributed in the hope that it will be useful, |
9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
11 | * GNU General Public License for more details. |
12 | * |
13 | * You should have received a copy of the GNU General Public License along |
14 | * with this program; if not, write to the Free Software Foundation, Inc., |
15 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
16 | * http://www.gnu.org/copyleft/gpl.html |
17 | * |
18 | * @file |
19 | */ |
20 | |
21 | use MediaWiki\Languages\LanguageFactory; |
22 | |
23 | /** |
24 | * Collation that orders text with numbers "naturally", so that 'Foo 1' < 'Foo 2' < 'Foo 12'. |
25 | * |
26 | * Note that this only works in terms of sequences of digits, and the behavior for decimal fractions |
27 | * or pretty-formatted numbers may be unexpected. |
28 | * |
29 | * Digits will be based on the wiki's content language settings. If |
30 | * you change the content language of a wiki you will need to run |
31 | * updateCollation.php --force. Only English (ASCII 0-9) and the |
32 | * localized version will be counted. Localized digits from other languages |
33 | * or weird unicode digit equivalents (e.g. 4, 𝟜, ⓸ , ⁴, etc) will not count. |
34 | * |
35 | * @since 1.28 |
36 | */ |
37 | class NumericUppercaseCollation extends UppercaseCollation { |
38 | |
39 | /** |
40 | * @var Language How to convert digits (usually the content language) |
41 | */ |
42 | private $digitTransformLang; |
43 | |
44 | /** |
45 | * @param LanguageFactory $languageFactory |
46 | * @param string|Language $digitTransformLang How to convert digits. |
47 | * For example, if given language "my" than ၇ is treated like 7. |
48 | * It is expected that usually this is given the content language. |
49 | */ |
50 | public function __construct( |
51 | LanguageFactory $languageFactory, |
52 | $digitTransformLang |
53 | ) { |
54 | $this->digitTransformLang = $digitTransformLang instanceof Language |
55 | ? $digitTransformLang |
56 | : $languageFactory->getLanguage( $digitTransformLang ); |
57 | parent::__construct( $languageFactory ); |
58 | } |
59 | |
60 | public function getSortKey( $string ) { |
61 | $sortkey = parent::getSortKey( $string ); |
62 | $sortkey = $this->convertDigits( $sortkey ); |
63 | // For each sequence of digits, insert the digit '0' and then the length of the sequence |
64 | // (encoded in two bytes) before it. That's all folks, it sorts correctly now! The '0' ensures |
65 | // correct position (where digits would normally sort), then the length will be compared putting |
66 | // shorter numbers before longer ones; if identical, then the characters will be compared, which |
67 | // generates the correct results for numbers of equal length. |
68 | $sortkey = preg_replace_callback( '/\d+/', static function ( $matches ) { |
69 | // Strip any leading zeros |
70 | $number = ltrim( $matches[0], '0' ); |
71 | $len = strlen( $number ); |
72 | // This allows sequences of up to 65536 numeric characters to be handled correctly. One byte |
73 | // would allow only for 256, which doesn't feel future-proof. |
74 | $prefix = chr( (int)floor( $len / 256 ) ) . chr( $len % 256 ); |
75 | return '0' . $prefix . $number; |
76 | }, $sortkey ); |
77 | |
78 | return $sortkey; |
79 | } |
80 | |
81 | /** |
82 | * Convert localized digits to english digits. |
83 | * |
84 | * based on Language::parseFormattedNumber but without commas. |
85 | * |
86 | * @param string $string sortkey to unlocalize digits of |
87 | * @return string Sortkey with all localized digits replaced with ASCII digits. |
88 | */ |
89 | private function convertDigits( $string ) { |
90 | $table = $this->digitTransformLang->digitTransformTable(); |
91 | if ( $table ) { |
92 | $table = array_filter( $table ); |
93 | $flipped = array_flip( $table ); |
94 | // Some languages seem to also have commas in this table. |
95 | $flipped = array_filter( $flipped, 'is_numeric' ); |
96 | $string = strtr( $string, $flipped ); |
97 | } |
98 | return $string; |
99 | } |
100 | |
101 | public function getFirstLetter( $string ) { |
102 | $convertedString = $this->convertDigits( $string ); |
103 | |
104 | if ( preg_match( '/^\d/', $convertedString ) ) { |
105 | return wfMessage( 'category-header-numerals' ) |
106 | ->numParams( 0, 9 ) |
107 | ->text(); |
108 | } else { |
109 | return parent::getFirstLetter( $string ); |
110 | } |
111 | } |
112 | } |