Merge "prop=duplicatefiles does not show duplicates under same name"

[lhc/web/wiklou.git] / includes / Collation.php

diff --git a/includes/Collation.php b/includes/Collation.php
index f00b568..ad2b94b 100644 (file)
--- a/includes/Collation.php
+++ b/includes/Collation.php
@@ -1,8 +1,31 @@
 <?php
+/**
+ * Database row sorting.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
 
 abstract class Collation {
        static $instance;
 
+       /**
+        * @return Collation
+        */
        static function singleton() {
                if ( !self::$instance ) {
                        global $wgCategoryCollation;
@@ -11,13 +34,30 @@ abstract class Collation {
                return self::$instance;
        }
 
+       /**
+        * @throws MWException
+        * @param $collationName string
+        * @return Collation
+        */
        static function factory( $collationName ) {
                switch( $collationName ) {
                        case 'uppercase':
                                return new UppercaseCollation;
+                       case 'identity':
+                               return new IdentityCollation;
                        case 'uca-default':
                                return new IcuCollation( 'root' );
                        default:
+                               # Provide a mechanism for extensions to hook in.
+
+                               $collationObject = null;
+                               wfRunHooks( 'Collation::factory', array( $collationName, &$collationObject ) );
+
+                               if ( $collationObject instanceof Collation ) {
+                                       return $collationObject;
+                               }
+
+                               // If all else fails...
                                throw new MWException( __METHOD__.": unknown collation type \"$collationName\"" );
                }
        }
@@ -81,6 +121,30 @@ class UppercaseCollation extends Collation {
        }
 }
 
+/**
+ * Collation class that's essentially a no-op.
+ *
+ * Does sorting based on binary value of the string.
+ * Like how things were pre 1.17.
+ */
+class IdentityCollation extends Collation {
+
+       function getSortKey( $string ) {
+               return $string;
+       }
+
+       function getFirstLetter( $string ) {
+               global $wgContLang;
+               // Copied from UppercaseCollation.
+               // I'm kind of unclear on when this could happen...
+               if ( $string[0] == "\0" ) {
+                       $string = substr( $string, 1 );
+               }
+               return $wgContLang->firstChar( $string );
+       }
+}
+
+
 class IcuCollation extends Collation {
        var $primaryCollator, $mainCollator, $locale;
        var $firstLetterData;
@@ -259,15 +323,15 @@ class IcuCollation extends Collation {
         * Do a binary search, and return the index of the largest item that sorts 
         * less than or equal to the target value.
         *
-        * @param $valueCallback A function to call to get the value with 
+        * @param $valueCallback array A function to call to get the value with
         *     a given array index.
-        * @param $valueCount The number of items accessible via $valueCallback, 
+        * @param $valueCount int The number of items accessible via $valueCallback,
         *     indexed from 0 to $valueCount - 1
-        * @param $comparisonCallback A callback to compare two values, returning 
+        * @param $comparisonCallback array A callback to compare two values, returning
         *     -1, 0 or 1 in the style of strcmp().
-        * @param $target The target value to find.
+        * @param $target string The target value to find.
         *
-        * @return The item index of the lower bound, or false if the target value
+        * @return int|bool The item index of the lower bound, or false if the target value
         *     sorts before all items.
         */
        function findLowerBound( $valueCallback, $valueCount, $comparisonCallback, $target ) {