includes/specials/SpecialMostlinkedtemplates.php

   1 <?php
   2 /**
   3  * Implements Special:Mostlinkedtemplates
   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  * @author Rob Church <robchur@gmail.com>
  23  */
  24
  25 /**
  26  * Special page lists templates with a large number of
  27  * transclusion links, i.e. "most used" templates
  28  *
  29  * @ingroup SpecialPage
  30  */
  31 class MostlinkedTemplatesPage extends QueryPage {
  32         function __construct( $name = 'Mostlinkedtemplates' ) {
  33                 parent::__construct( $name );
  34         }
  35
  36         /**
  37          * Is this report expensive, i.e should it be cached?
  38          *
  39          * @return bool
  40          */
  41         public function isExpensive() {
  42                 return true;
  43         }
  44
  45         /**
  46          * Is there a feed available?
  47          *
  48          * @return bool
  49          */
  50         public function isSyndicated() {
  51                 return false;
  52         }
  53
  54         /**
  55          * Sort the results in descending order?
  56          *
  57          * @return bool
  58          */
  59         public function sortDescending() {
  60                 return true;
  61         }
  62
  63         public function getQueryInfo() {
  64                 return [
  65                         'tables' => [ 'templatelinks' ],
  66                         'fields' => [
  67                                 'namespace' => 'tl_namespace',
  68                                 'title' => 'tl_title',
  69                                 'value' => 'COUNT(*)'
  70                         ],
  71                         'options' => [ 'GROUP BY' => [ 'tl_namespace', 'tl_title' ] ]
  72                 ];
  73         }
  74
  75         /**
  76          * Pre-cache page existence to speed up link generation
  77          *
  78          * @param IDatabase $db
  79          * @param ResultWrapper $res
  80          */
  81         public function preprocessResults( $db, $res ) {
  82                 $this->executeLBFromResultWrapper( $res );
  83         }
  84
  85         /**
  86          * Format a result row
  87          *
  88          * @param Skin $skin
  89          * @param object $result Result row
  90          * @return string
  91          */
  92         public function formatResult( $skin, $result ) {
  93                 $title = Title::makeTitleSafe( $result->namespace, $result->title );
  94                 if ( !$title ) {
  95                         return Html::element(
  96                                 'span',
  97                                 [ 'class' => 'mw-invalidtitle' ],
  98                                 Linker::getInvalidTitleDescription(
  99                                         $this->getContext(),
 100                                         $result->namespace,
 101                                         $result->title
 102                                 )
 103                         );
 104                 }
 105
 106                 return $this->getLanguage()->specialList(
 107                         $this->getLinkRenderer()->makeLink( $title ),
 108                         $this->makeWlhLink( $title, $result )
 109                 );
 110         }
 111
 112         /**
 113          * Make a "what links here" link for a given title
 114          *
 115          * @param Title $title Title to make the link for
 116          * @param object $result Result row
 117          * @return string
 118          */
 119         private function makeWlhLink( $title, $result ) {
 120                 $wlh = SpecialPage::getTitleFor( 'Whatlinkshere', $title->getPrefixedText() );
 121                 $label = $this->msg( 'ntransclusions' )->numParams( $result->value )->text();
 122
 123                 return $this->getLinkRenderer()->makeLink( $wlh, $label );
 124         }
 125
 126         protected function getGroupName() {
 127                 return 'highuse';
 128         }
 129 }