Collation that orders text with numbers "naturally", so that 'Foo 1' < 'Foo 2' < 'Foo 12'. More...
Inherits UppercaseCollation.
Inherited by CustomUppercaseCollation.
Public Member Functions | |
| __construct (LanguageFactory $languageFactory, $digitTransformLang) | |
| getFirstLetter ( $string) | |
| Given a string, return the logical "first letter" to be used for grouping on category pages and so on. | |
| getSortKey ( $string) | |
| Given a string, convert it to a (hopefully short) key that can be used for efficient sorting. | |
 Public Member Functions inherited from UppercaseCollation | |
| __construct (LanguageFactory $languageFactory) | |
| Public Member Functions inherited from Collation | |
| getSortKeys ( $strings) | |
| Get multiple sort keys. | |
Detailed Description
Collation that orders text with numbers "naturally", so that 'Foo 1' < 'Foo 2' < 'Foo 12'.
Note that this only works in terms of sequences of digits, and the behavior for decimal fractions or pretty-formatted numbers may be unexpected.
Digits will be based on the wiki's content language settings. If you change the content language of a wiki you will need to run updateCollation.php –force. Only English (ASCII 0-9) and the localized version will be counted. Localized digits from other languages or weird unicode digit equivalents (e.g. ４, 𝟜, ⓸ , ⁴, etc) will not count.
- Since
- 1.28
Definition at line 38 of file NumericUppercaseCollation.php.
Constructor & Destructor Documentation
◆ __construct()
| NumericUppercaseCollation::__construct | ( | LanguageFactory | $languageFactory, |
| $digitTransformLang ) |
- Parameters
-
LanguageFactory $languageFactory string | Language $digitTransformLang How to convert digits. For example, if given language "my" than ၇ is treated like 7. It is expected that usually this is given the content language.
Definition at line 51 of file NumericUppercaseCollation.php.
References MediaWiki\Languages\LanguageFactory\getLanguage().
Member Function Documentation
◆ getFirstLetter()
| NumericUppercaseCollation::getFirstLetter | ( | $string | ) |
Given a string, return the logical "first letter" to be used for grouping on category pages and so on.
This has to be coordinated carefully with convertToSortkey(), or else the sorted list might jump back and forth between the same "initial letters" or other pathological behavior. For instance, if you just return the first character, but "a" sorts the same as "A" based on getSortKey(), then you might get a list like
== A ==
- [[Aardvark]]
== a ==
- [[antelope]]
== A ==
- [[Ape]]
etc., assuming for the sake of argument that $wgCapitalLinks is false.
- Since
- 1.16.3
- Parameters
-
string $string UTF-8 string
- Returns
- string UTF-8 string corresponding to the first letter of input
Reimplemented from UppercaseCollation.
Reimplemented in CustomUppercaseCollation.
Definition at line 102 of file NumericUppercaseCollation.php.
References wfMessage().
◆ getSortKey()
| NumericUppercaseCollation::getSortKey | ( | $string | ) |
Given a string, convert it to a (hopefully short) key that can be used for efficient sorting.
A binary sort according to the sortkeys corresponds to a logical sort of the corresponding strings. Current code expects that a line feed character should sort before all others, but has no other particular expectations (and that one can be changed if necessary).
- Since
- 1.16.3
- Parameters
-
string $string UTF-8 string
- Returns
- string Binary sortkey
Reimplemented from UppercaseCollation.
Reimplemented in CustomUppercaseCollation.
Definition at line 61 of file NumericUppercaseCollation.php.
References $matches.
The documentation for this class was generated from the following file:
- includes/collation/NumericUppercaseCollation.php
