Merge "Update docs/hooks.txt for ShowSearchHitTitle"
[mediawiki.git] / includes / specials / SpecialMostlinked.php
blob712574cf14e39cb0394c1eb43fe50447173b02b7
1 <?php
2 /**
3 * Implements Special:Mostlinked
5 * Copyright © 2005 Ævar Arnfjörð Bjarmason, 2006 Rob Church
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
22 * @file
23 * @ingroup SpecialPage
24 * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
25 * @author Rob Church <robchur@gmail.com>
28 /**
29 * A special page to show pages ordered by the number of pages linking to them.
31 * @ingroup SpecialPage
33 class MostlinkedPage extends QueryPage {
34 function __construct( $name = 'Mostlinked' ) {
35 parent::__construct( $name );
38 public function isExpensive() {
39 return true;
42 function isSyndicated() {
43 return false;
46 public function getQueryInfo() {
47 return [
48 'tables' => [ 'pagelinks', 'page' ],
49 'fields' => [
50 'namespace' => 'pl_namespace',
51 'title' => 'pl_title',
52 'value' => 'COUNT(*)',
53 'page_namespace'
55 'options' => [
56 'HAVING' => 'COUNT(*) > 1',
57 'GROUP BY' => [
58 'pl_namespace', 'pl_title',
59 'page_namespace'
62 'join_conds' => [
63 'page' => [
64 'LEFT JOIN',
66 'page_namespace = pl_namespace',
67 'page_title = pl_title'
74 /**
75 * Pre-fill the link cache
77 * @param IDatabase $db
78 * @param ResultWrapper $res
80 function preprocessResults( $db, $res ) {
81 $this->executeLBFromResultWrapper( $res );
84 /**
85 * Make a link to "what links here" for the specified title
87 * @param Title $title Title being queried
88 * @param string $caption Text to display on the link
89 * @return string
91 function makeWlhLink( $title, $caption ) {
92 $wlh = SpecialPage::getTitleFor( 'Whatlinkshere', $title->getPrefixedDBkey() );
94 $linkRenderer = $this->getLinkRenderer();
95 return $linkRenderer->makeKnownLink( $wlh, $caption );
98 /**
99 * Make links to the page corresponding to the item,
100 * and the "what links here" page for it
102 * @param Skin $skin Skin to be used
103 * @param object $result Result row
104 * @return string
106 function formatResult( $skin, $result ) {
107 $title = Title::makeTitleSafe( $result->namespace, $result->title );
108 if ( !$title ) {
109 return Html::element(
110 'span',
111 [ 'class' => 'mw-invalidtitle' ],
112 Linker::getInvalidTitleDescription(
113 $this->getContext(),
114 $result->namespace,
115 $result->title )
119 $linkRenderer = $this->getLinkRenderer();
120 $link = $linkRenderer->makeLink( $title );
121 $wlh = $this->makeWlhLink(
122 $title,
123 $this->msg( 'nlinks' )->numParams( $result->value )->text()
126 return $this->getLanguage()->specialList( $link, $wlh );
129 protected function getGroupName() {
130 return 'highuse';