includes/collation/IdentityCollation.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 use MediaWiki\Language\Language;
  22
  23 /**
  24  * Collation class that's essentially a no-op.
  25  *
  26  * Does sorting based on binary value of the string.
  27  * Like how things were pre 1.17.
  28  *
  29  * @since 1.18
  30  */
  31 class IdentityCollation extends Collation {
  32
  33         /** @var Language */
  34         private $contentLanguage;
  35
  36         /**
  37          * @param Language $contentLanguage
  38          */
  39         public function __construct( Language $contentLanguage ) {
  40                 $this->contentLanguage = $contentLanguage;
  41         }
  42
  43         public function getSortKey( $string ) {
  44                 return $string;
  45         }
  46
  47         public function getFirstLetter( $string ) {
  48                 // Copied from UppercaseCollation.
  49                 // I'm kind of unclear on when this could happen...
  50                 if ( $string[0] == "\0" ) {
  51                         $string = substr( $string, 1 );
  52                 }
  53                 return $this->contentLanguage->firstChar( $string );
  54         }
  55 }