wiki.techinc.nl/includes/specials/SpecialMostLinked.php
Umherirrender 6ca2883ce8 Improve doc about object to be stdClass in QueryPage::formatResult
Change-Id: Ib1fadd74f2f3223ea8a9343d1524533f00b991df
2020-11-15 13:50:59 +01:00

147 lines
3.7 KiB
PHP

<?php
/**
* Implements Special:Mostlinked
*
* Copyright © 2005 Ævar Arnfjörð Bjarmason, 2006 Rob Church
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup SpecialPage
* @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
* @author Rob Church <robchur@gmail.com>
*/
use MediaWiki\Cache\LinkBatchFactory;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\ILoadBalancer;
use Wikimedia\Rdbms\IResultWrapper;
/**
* A special page to show pages ordered by the number of pages linking to them.
*
* @ingroup SpecialPage
*/
class SpecialMostLinked extends QueryPage {
/**
* @param ILoadBalancer $loadBalancer
* @param LinkBatchFactory $linkBatchFactory
*/
public function __construct(
ILoadBalancer $loadBalancer,
LinkBatchFactory $linkBatchFactory
) {
parent::__construct( 'Mostlinked' );
$this->setDBLoadBalancer( $loadBalancer );
$this->setLinkBatchFactory( $linkBatchFactory );
}
public function isExpensive() {
return true;
}
public function isSyndicated() {
return false;
}
public function getQueryInfo() {
return [
'tables' => [ 'pagelinks', 'page' ],
'fields' => [
'namespace' => 'pl_namespace',
'title' => 'pl_title',
'value' => 'COUNT(*)',
'page_namespace'
],
'options' => [
'HAVING' => 'COUNT(*) > 1',
'GROUP BY' => [
'pl_namespace', 'pl_title',
'page_namespace'
]
],
'join_conds' => [
'page' => [
'LEFT JOIN',
[
'page_namespace = pl_namespace',
'page_title = pl_title'
]
]
]
];
}
/**
* Pre-fill the link cache
*
* @param IDatabase $db
* @param IResultWrapper $res
*/
public function preprocessResults( $db, $res ) {
$this->executeLBFromResultWrapper( $res );
}
/**
* Make a link to "what links here" for the specified title
*
* @param Title $title Title being queried
* @param string $caption Text to display on the link
* @return string
*/
private function makeWlhLink( $title, $caption ) {
$wlh = SpecialPage::getTitleFor( 'Whatlinkshere', $title->getPrefixedDBkey() );
$linkRenderer = $this->getLinkRenderer();
return $linkRenderer->makeKnownLink( $wlh, $caption );
}
/**
* Make links to the page corresponding to the item,
* and the "what links here" page for it
*
* @param Skin $skin Skin to be used
* @param stdClass $result Result row
* @return string
*/
public function formatResult( $skin, $result ) {
$title = Title::makeTitleSafe( $result->namespace, $result->title );
if ( !$title ) {
return Html::element(
'span',
[ 'class' => 'mw-invalidtitle' ],
Linker::getInvalidTitleDescription(
$this->getContext(),
$result->namespace,
$result->title )
);
}
$linkRenderer = $this->getLinkRenderer();
$link = $linkRenderer->makeLink( $title );
$wlh = $this->makeWlhLink(
$title,
$this->msg( 'nlinks' )->numParams( $result->value )->text()
);
return $this->getLanguage()->specialList( $link, $wlh );
}
protected function getGroupName() {
return 'highuse';
}
}