Inheritance diagram for Collation:

[legend]

Public Member Functions
	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...

Static Public Member Functions
static	factory ( $collationName)

static	singleton ()

Static Public Attributes
static	$instance

Detailed Description

Definition at line 23 of file Collation.php.

Member Function Documentation

◆ factory()

static Collation::factory ( $collationName )

static

Exceptions

MWException

Parameters

string $collationName

Returns: Collation

Definition at line 42 of file Collation.php.

References array(), and wfRunHooks().

Referenced by UpdateCollation\execute(), singleton(), and CollationTest\testGetFirstLetter().

◆ getFirstLetter()

Collation::getFirstLetter ( $string )

abstract

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.

Parameters

string $string UTF-8 string

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

Reimplemented in IcuCollation, IdentityCollation, and UppercaseCollation.

◆ getSortKey()

Collation::getSortKey ( $string )

abstract

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).

Parameters

string $string UTF-8 string