SpecialUnusedTemplates.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use MediaWiki\Deferred\LinksUpdate\TemplateLinksTable;
use MediaWiki\Skin\Skin;
use MediaWiki\SpecialPage\QueryPage;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Title\Title;
use stdClass;
use Wikimedia\Rdbms\IConnectionProvider;
 
class SpecialUnusedTemplates extends QueryPage {
 
    public function __construct(
        IConnectionProvider $dbProvider,
    ) {
        parent::__construct( 'Unusedtemplates' );
        $this->setDatabaseProvider( $dbProvider );
    }
 
    public function isExpensive() {
        return true;
    }
 
    public function isSyndicated() {
        return false;
    }
 
    protected function sortDescending() {
        return false;
    }
 
    protected function getOrderFields() {
        return [ 'title' ];
    }
 
    public function getQueryInfo() {
        return [
            'tables' => [ 'linktarget', 'templatelinks', 'page', 'page_props' ],
            'fields' => [
                'namespace' => 'page_namespace',
                'title' => 'page_title',
            ],
            'conds' => [
                'page_namespace' => NS_TEMPLATE,
                'tl_from' => null,
                'page_is_redirect' => 0,
                'pp_page' => null
            ],
            'join_conds' => [
                'linktarget' => [ 'LEFT JOIN', [ 'lt_title = page_title', 'lt_namespace = page_namespace' ] ],
                'templatelinks' => [ 'LEFT JOIN', [ 'tl_target_id = lt_id' ] ],
                'page_props' => [ 'LEFT JOIN', [ 'page_id = pp_page', 'pp_propname' => 'expectunusedtemplate' ] ]
            ]
        ];
    }
 
    public function preprocessResults( $db, $res ) {
        $this->executeLBFromResultWrapper( $res );
    }
 
    public function formatResult( $skin, $result ) {
        $linkRenderer = $this->getLinkRenderer();
        $title = Title::makeTitle( NS_TEMPLATE, $result->title );
        $pageLink = $linkRenderer->makeKnownLink( $title );
        $wlhLink = $linkRenderer->makeKnownLink(
            SpecialPage::getTitleFor( 'Whatlinkshere', $title->getPrefixedText() ),
            $this->msg( 'unusedtemplateswlh' )->text()
        );
 
        return $this->getLanguage()->specialList( $pageLink, $wlhLink );
    }
 
    protected function getPageHeader() {
        return $this->msg( 'unusedtemplatestext' )->parseAsBlock();
    }
 
    protected function getGroupName() {
        return 'maintenance';
    }
 
    protected function getRecacheDB() {
        return $this->getDatabaseProvider()->getReplicaDatabase(
            TemplateLinksTable::VIRTUAL_DOMAIN,
            'vslow'
        );
    }
}
 
class_alias( SpecialUnusedTemplates::class, 'SpecialUnusedTemplates' );