Collation.php

Go to the documentation of this file.

<?php
abstract class Collation {
    private static $instance;

    public static function singleton() {
        if ( !self::$instance ) {
            global $wgCategoryCollation;
            self::$instance = self::factory( $wgCategoryCollation );
        }
        return self::$instance;
    }

    public static function factory( $collationName ) {
        switch ( $collationName ) {
            case 'uppercase':
                return new UppercaseCollation;
            case 'numeric':
                return new NumericUppercaseCollation;
            case 'identity':
                return new IdentityCollation;
            case 'uca-default':
                return new IcuCollation( 'root' );
            case 'uca-default-u-kn':
                return new IcuCollation( 'root-u-kn' );
            case 'xx-uca-ckb':
                return new CollationCkb;
            case 'xx-uca-et':
                return new CollationEt;
            default:
                $match = [];
                if ( preg_match( '/^uca-([a-z@=-]+)$/', $collationName, $match ) ) {
                    return new IcuCollation( $match[1] );
                }

                # Provide a mechanism for extensions to hook in.
                $collationObject = null;
                Hooks::run( 'Collation::factory', [ $collationName, &$collationObject ] );

                if ( $collationObject instanceof Collation ) {
                    return $collationObject;
                }

                // If all else fails...
                throw new MWException( __METHOD__ . ": unknown collation type \"$collationName\"" );
        }
    }

    abstract function getSortKey( $string );

    abstract function getFirstLetter( $string );

}