MediaWiki\Collation\IcuCollation Class Reference

Inherits MediaWiki\Collation\Collation.

Inherited by MediaWiki\Collation\CollationCkb.

Collaboration diagram for MediaWiki\Collation\IcuCollation:

Public Member Functions
	__construct (LanguageFactory $languageFactory, $locale)
	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.

Static Public Member Functions
static	isCjk ( $codepoint)
	Test if a code point is a CJK (Chinese, Japanese, Korean) character.

Protected Attributes
Language	$digitTransformLanguage

Detailed Description

Since

1.16.3

Definition at line 20 of file IcuCollation.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Collation\IcuCollation::__construct	(	LanguageFactory	$languageFactory,
			$locale )

Parameters

LanguageFactory	$languageFactory
string	$locale

Definition at line 318 of file IcuCollation.php.

Member Function Documentation

getFirstLetter()

MediaWiki\Collation\IcuCollation::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.

Definition at line 353 of file IcuCollation.php.

References Wikimedia\ArrayUtils\ArrayUtils\findLowerBound(), and wfMessage().

getSortKey()

MediaWiki\Collation\IcuCollation::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.

Definition at line 348 of file IcuCollation.php.

isCjk()

static MediaWiki\Collation\IcuCollation::isCjk ( $codepoint )

static

Test if a code point is a CJK (Chinese, Japanese, Korean) character.

Parameters

int

$codepoint

Returns

bool

Since

1.16.3

Definition at line 555 of file IcuCollation.php.

Member Data Documentation

$digitTransformLanguage

Language MediaWiki\Collation\IcuCollation::$digitTransformLanguage

protected

Definition at line 33 of file IcuCollation.php.

---

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

• includes/Collation/IcuCollation.php