Inherited by MediaWiki\Collation\NumericUppercaseCollation.

Collaboration diagram for MediaWiki\Collation\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.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

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

Public Member Functions inherited from MediaWiki\Collation\Collation

getSortKeys ( $strings)

Get multiple sort keys.

Detailed Description

Definition at line 14 of file UppercaseCollation.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented in MediaWiki\Collation\AbkhazUppercaseCollation, MediaWiki\Collation\BashkirUppercaseCollation, MediaWiki\Collation\CentralKurdishUppercaseCollation, and MediaWiki\Collation\InariSaamiUppercaseCollation.

Definition at line 21 of file UppercaseCollation.php.

Member Function Documentation

◆ getFirstLetter()

MediaWiki\Collation\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 $string UTF-8 string

Returns: string UTF-8 string corresponding to the first letter of input

Reimplemented from MediaWiki\Collation\Collation.

Reimplemented in MediaWiki\Collation\CustomUppercaseCollation, and MediaWiki\Collation\NumericUppercaseCollation.

Definition at line 31 of file UppercaseCollation.php.

◆ getSortKey()

MediaWiki\Collation\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 $string UTF-8 string

Returns: string Binary sortkey

Reimplemented from MediaWiki\Collation\Collation.

Reimplemented in MediaWiki\Collation\CustomUppercaseCollation, and MediaWiki\Collation\NumericUppercaseCollation.

Definition at line 26 of file UppercaseCollation.php.

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

includes/Collation/UppercaseCollation.php