includes/specialpage/PageQueryPage.php

   1 <?php
   2 /**
   3  * Variant of QueryPage which formats the result as a simple link to the page.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 use MediaWiki\MediaWikiServices;
  25 use Wikimedia\Rdbms\IResultWrapper;
  26 use Wikimedia\Rdbms\IDatabase;
  27
  28 /**
  29  * Variant of QueryPage which formats the result as a simple link to the page
  30  *
  31  * @ingroup SpecialPage
  32  */
  33 abstract class PageQueryPage extends QueryPage {
  34         /**
  35          * Run a LinkBatch to pre-cache LinkCache information,
  36          * like page existence and information for stub color and redirect hints.
  37          * This should be done for live data and cached data.
  38          *
  39          * @param IDatabase $db
  40          * @param IResultWrapper $res
  41          */
  42         public function preprocessResults( $db, $res ) {
  43                 $this->executeLBFromResultWrapper( $res );
  44         }
  45
  46         /**
  47          * Format the result as a simple link to the page
  48          *
  49          * @param Skin $skin
  50          * @param object $row Result row
  51          * @return string
  52          */
  53         public function formatResult( $skin, $row ) {
  54                 $title = Title::makeTitleSafe( $row->namespace, $row->title );
  55
  56                 if ( $title instanceof Title ) {
  57                         $text = MediaWikiServices::getInstance()->getContentLanguage()->
  58                                 convert( htmlspecialchars( $title->getPrefixedText() ) );
  59                         return $this->getLinkRenderer()->makeLink( $title, new HtmlArmor( $text ) );
  60                 } else {
  61                         return Html::element( 'span', [ 'class' => 'mw-invalidtitle' ],
  62                                 Linker::getInvalidTitleDescription( $this->getContext(), $row->namespace, $row->title ) );
  63                 }
  64         }
  65 }