includes/pager/AlphabeticPager.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 namespace MediaWiki\Pager;
  22
  23 /**
  24  * IndexPager with an alphabetic list and a formatted navigation bar
  25  *
  26  * @stable to extend
  27  * @ingroup Pager
  28  */
  29 abstract class AlphabeticPager extends IndexPager {
  30
  31         /**
  32          * @stable to override
  33          * @return string HTML
  34          */
  35         public function getNavigationBar() {
  36                 if ( !$this->isNavigationBarShown() ) {
  37                         return '';
  38                 }
  39
  40                 if ( $this->mNavigationBar !== null ) {
  41                         return $this->mNavigationBar;
  42                 }
  43
  44                 $navBuilder = $this->getNavigationBuilder()
  45                         ->setPrevMsg( 'prevn' )
  46                         ->setNextMsg( 'nextn' )
  47                         ->setFirstMsg( 'page_first' )
  48                         ->setLastMsg( 'page_last' );
  49
  50                 $this->mNavigationBar = $navBuilder->getHtml();
  51
  52                 return $this->mNavigationBar;
  53         }
  54 }
  55
  56 /** @deprecated class alias since 1.41 */
  57 class_alias( AlphabeticPager::class, 'AlphabeticPager' );