3 * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
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.
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.
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
24 * Query module to enumerate all categories, even the ones that don't have
29 class ApiQueryAllCategories
extends ApiQueryGeneratorBase
{
31 public function __construct( ApiQuery
$query, $moduleName ) {
32 parent
::__construct( $query, $moduleName, 'ac' );
35 public function execute() {
39 public function getCacheMode( $params ) {
43 public function executeGenerator( $resultPageSet ) {
44 $this->run( $resultPageSet );
48 * @param ApiPageSet $resultPageSet
50 private function run( $resultPageSet = null ) {
52 $params = $this->extractRequestParams();
54 $this->addTables( 'category' );
55 $this->addFields( 'cat_title' );
57 if ( !is_null( $params['continue'] ) ) {
58 $cont = explode( '|', $params['continue'] );
59 $this->dieContinueUsageIf( count( $cont ) != 1 );
60 $op = $params['dir'] == 'descending' ?
'<' : '>';
61 $cont_from = $db->addQuotes( $cont[0] );
62 $this->addWhere( "cat_title $op= $cont_from" );
65 $dir = ( $params['dir'] == 'descending' ?
'older' : 'newer' );
66 $from = ( $params['from'] === null
68 : $this->titlePartToKey( $params['from'], NS_CATEGORY
) );
69 $to = ( $params['to'] === null
71 : $this->titlePartToKey( $params['to'], NS_CATEGORY
) );
72 $this->addWhereRange( 'cat_title', $dir, $from, $to );
74 $min = $params['min'];
75 $max = $params['max'];
76 if ( $dir == 'newer' ) {
77 $this->addWhereRange( 'cat_pages', 'newer', $min, $max );
79 $this->addWhereRange( 'cat_pages', 'older', $max, $min );
82 if ( isset( $params['prefix'] ) ) {
83 $this->addWhere( 'cat_title' . $db->buildLike(
84 $this->titlePartToKey( $params['prefix'], NS_CATEGORY
),
88 $this->addOption( 'LIMIT', $params['limit'] +
1 );
89 $sort = ( $params['dir'] == 'descending' ?
' DESC' : '' );
90 $this->addOption( 'ORDER BY', 'cat_title' . $sort );
92 $prop = array_flip( $params['prop'] );
93 $this->addFieldsIf( [ 'cat_pages', 'cat_subcats', 'cat_files' ], isset( $prop['size'] ) );
94 if ( isset( $prop['hidden'] ) ) {
95 $this->addTables( [ 'page', 'page_props' ] );
96 $this->addJoinConds( [
97 'page' => [ 'LEFT JOIN', [
98 'page_namespace' => NS_CATEGORY
,
99 'page_title=cat_title' ] ],
100 'page_props' => [ 'LEFT JOIN', [
102 'pp_propname' => 'hiddencat' ] ],
104 $this->addFields( [ 'cat_hidden' => 'pp_propname' ] );
107 $res = $this->select( __METHOD__
);
111 $result = $this->getResult();
113 foreach ( $res as $row ) {
114 if ( ++
$count > $params['limit'] ) {
115 // We've reached the one extra which shows that there are
116 // additional cats to be had. Stop here...
117 $this->setContinueEnumParameter( 'continue', $row->cat_title
);
122 $titleObj = Title
::makeTitle( NS_CATEGORY
, $row->cat_title
);
123 if ( !is_null( $resultPageSet ) ) {
124 $pages[] = $titleObj;
127 ApiResult
::setContentValue( $item, 'category', $titleObj->getText() );
128 if ( isset( $prop['size'] ) ) {
129 $item['size'] = (int)$row->cat_pages
;
130 $item['pages'] = $row->cat_pages
- $row->cat_subcats
- $row->cat_files
;
131 $item['files'] = (int)$row->cat_files
;
132 $item['subcats'] = (int)$row->cat_subcats
;
134 if ( isset( $prop['hidden'] ) ) {
135 $item['hidden'] = (bool)$row->cat_hidden
;
137 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $item );
139 $this->setContinueEnumParameter( 'continue', $row->cat_title
);
145 if ( is_null( $resultPageSet ) ) {
146 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'c' );
148 $resultPageSet->populateFromTitles( $pages );
152 public function getAllowedParams() {
156 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
161 ApiBase
::PARAM_DFLT
=> 'ascending',
162 ApiBase
::PARAM_TYPE
=> [
168 ApiBase
::PARAM_TYPE
=> 'integer'
171 ApiBase
::PARAM_TYPE
=> 'integer'
174 ApiBase
::PARAM_DFLT
=> 10,
175 ApiBase
::PARAM_TYPE
=> 'limit',
176 ApiBase
::PARAM_MIN
=> 1,
177 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
178 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
181 ApiBase
::PARAM_TYPE
=> [ 'size', 'hidden' ],
182 ApiBase
::PARAM_DFLT
=> '',
183 ApiBase
::PARAM_ISMULTI
=> true,
184 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
189 protected function getExamplesMessages() {
191 'action=query&list=allcategories&acprop=size'
192 => 'apihelp-query+allcategories-example-size',
193 'action=query&generator=allcategories&gacprefix=List&prop=info'
194 => 'apihelp-query+allcategories-example-generator',
198 public function getHelpUrls() {
199 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allcategories';