MediaWiki master
MediaWiki\Collation\InariSaamiUppercaseCollation Class Reference

Inherits MediaWiki\Collation\CustomUppercaseCollation.

Collaboration diagram for MediaWiki\Collation\InariSaamiUppercaseCollation:

Public Member Functions

 __construct (LanguageFactory $languageFactory)
 
- Public Member Functions inherited from MediaWiki\Collation\CustomUppercaseCollation
 __construct (LanguageFactory $languageFactory, array $alphabet, $digitTransformLang)
 
 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

 
 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

 
- Public Member Functions inherited from MediaWiki\Collation\NumericUppercaseCollation
 __construct (LanguageFactory $languageFactory, $digitTransformLang)
 
- Public Member Functions inherited from MediaWiki\Collation\Collation
 getSortKeys ( $strings)
 Get multiple sort keys.
 

Detailed Description

Definition at line 13 of file InariSaamiUppercaseCollation.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Collation\InariSaamiUppercaseCollation::__construct ( LanguageFactory $languageFactory)

Reimplemented from MediaWiki\Collation\UppercaseCollation.

Definition at line 15 of file InariSaamiUppercaseCollation.php.


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