wiki.techinc.nl/includes/specials/SpecialUnusedCategories.php
Timo Tijhof 8e40193659 specials: Improve docs and @ingroup tags, fix file headers
* Add relevant `@ingroup` to special pages that belong to a specific
  component and for which a doc group is already defined (defgroup),
  e.g. "Upload" for SpecialUpload, "JobQueue" for SpecialRunJobs.

* Remove duplicate descriptions from file blocks in favour of class
  doc blocks. This reduces needless duplication and was often
  incorrect or outdated, and helps make file headers more consistently
  (visually) ignorable.

  Add missing `ingroup` to class blocks (and remove any from file blocks)
  as otherwise the file is indexed twice (e.g. in Doxygen) which makes
  navigation on doc.wikimedia.org rather messy.

  Ref https://gerrit.wikimedia.org/r/q/message:ingroup+is:merged

Bug: T364652
Change-Id: I795c43b6d72782d457c963e352d7e1b022c2b641
2024-05-15 11:59:50 +00:00

117 lines
2.9 KiB
PHP

<?php
/**
* 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
*/
namespace MediaWiki\Specials;
use MediaWiki\Cache\LinkBatchFactory;
use MediaWiki\SpecialPage\QueryPage;
use MediaWiki\Title\Title;
use Skin;
use stdClass;
use Wikimedia\Rdbms\IConnectionProvider;
/**
* Implements Special:Unusedcategories
*
* @ingroup SpecialPage
*/
class SpecialUnusedCategories extends QueryPage {
/**
* @param IConnectionProvider $dbProvider
* @param LinkBatchFactory $linkBatchFactory
*/
public function __construct(
IConnectionProvider $dbProvider,
LinkBatchFactory $linkBatchFactory
) {
parent::__construct( 'Unusedcategories' );
$this->setDatabaseProvider( $dbProvider );
$this->setLinkBatchFactory( $linkBatchFactory );
}
public function isExpensive() {
return true;
}
protected function getPageHeader() {
return $this->msg( 'unusedcategoriestext' )->parseAsBlock();
}
protected function getOrderFields() {
return [ 'title' ];
}
public function getQueryInfo() {
return [
'tables' => [ 'page', 'categorylinks', 'page_props' ],
'fields' => [
'namespace' => 'page_namespace',
'title' => 'page_title',
],
'conds' => [
'cl_from' => null,
'page_namespace' => NS_CATEGORY,
'page_is_redirect' => 0,
'pp_page' => null,
],
'join_conds' => [
'categorylinks' => [ 'LEFT JOIN', 'cl_to = page_title' ],
'page_props' => [ 'LEFT JOIN', [
'page_id = pp_page',
'pp_propname' => 'expectunusedcategory'
] ]
]
];
}
/**
* A should come before Z (T32907)
* @return bool
*/
protected function sortDescending() {
return false;
}
/**
* @param Skin $skin
* @param stdClass $result Result row
* @return string
*/
public function formatResult( $skin, $result ) {
$title = Title::makeTitle( NS_CATEGORY, $result->title );
return $this->getLinkRenderer()->makeLink( $title, $title->getText() );
}
protected function getGroupName() {
return 'maintenance';
}
public function preprocessResults( $db, $res ) {
$this->executeLBFromResultWrapper( $res );
}
}
/**
* Retain the old class name for backwards compatibility.
* @deprecated since 1.41
*/
class_alias( SpecialUnusedCategories::class, 'SpecialUnusedCategories' );