MediaWiki  master
UppercaseCollation Class Reference
Inheritance diagram for UppercaseCollation:
Collaboration diagram for UppercaseCollation:

Public Member Functions

 __construct (LanguageFactory $languageFactory)
 
 getFirstLetter ( $string)
 Given a string, return the logical "first letter" to be used for grouping on category pages and so on. More...
 
 getSortKey ( $string)
 Given a string, convert it to a (hopefully short) key that can be used for efficient sorting. More...
 

Private Attributes

Language $lang
 Language object for English, so we can use the generic UTF-8 uppercase function there. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Collation
static factory ( $collationName)
 
static singleton ()
 

Detailed Description

Definition at line 25 of file UppercaseCollation.php.

Constructor & Destructor Documentation

◆ __construct()

UppercaseCollation::__construct ( LanguageFactory  $languageFactory)
Parameters
LanguageFactory$languageFactory

Reimplemented in BashkirUppercaseCollation, and AbkhazUppercaseCollation.

Definition at line 35 of file UppercaseCollation.php.

References MediaWiki\Languages\LanguageFactory\getLanguage().

Member Function Documentation

◆ getFirstLetter()

UppercaseCollation::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$stringUTF-8 string
Returns
string UTF-8 string corresponding to the first letter of input

Reimplemented from Collation.

Reimplemented in NumericUppercaseCollation, and CustomUppercaseCollation.

Definition at line 43 of file UppercaseCollation.php.

◆ getSortKey()

UppercaseCollation::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$stringUTF-8 string
Returns
string Binary sortkey

Reimplemented from Collation.

Reimplemented in NumericUppercaseCollation, and CustomUppercaseCollation.

Definition at line 39 of file UppercaseCollation.php.

Member Data Documentation

◆ $lang

Language UppercaseCollation::$lang
private

Language object for English, so we can use the generic UTF-8 uppercase function there.

Definition at line 30 of file UppercaseCollation.php.


The documentation for this class was generated from the following file: