MediaWiki master
ApiQueryAllCategories.php
Go to the documentation of this file.
1<?php
28
36
41 public function __construct( ApiQuery $query, $moduleName ) {
42 parent::__construct( $query, $moduleName, 'ac' );
43 }
44
45 public function execute() {
46 $this->run();
47 }
48
49 public function getCacheMode( $params ) {
50 return 'public';
51 }
52
53 public function executeGenerator( $resultPageSet ) {
54 $this->run( $resultPageSet );
55 }
56
60 private function run( $resultPageSet = null ) {
61 $db = $this->getDB();
63
64 $this->addTables( 'category' );
65 $this->addFields( 'cat_title' );
66
67 if ( $params['continue'] !== null ) {
68 $cont = $this->parseContinueParamOrDie( $params['continue'], [ 'string' ] );
69 $op = $params['dir'] == 'descending' ? '<=' : '>=';
70 $this->addWhere( $db->expr( 'cat_title', $op, $cont[0] ) );
71 }
72
73 $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
74 $from = ( $params['from'] === null
75 ? null
76 : $this->titlePartToKey( $params['from'], NS_CATEGORY ) );
77 $to = ( $params['to'] === null
78 ? null
79 : $this->titlePartToKey( $params['to'], NS_CATEGORY ) );
80 $this->addWhereRange( 'cat_title', $dir, $from, $to );
81
82 $min = $params['min'];
83 $max = $params['max'];
84 if ( $dir == 'newer' ) {
85 $this->addWhereRange( 'cat_pages', 'newer', $min, $max );
86 } else {
87 $this->addWhereRange( 'cat_pages', 'older', $max, $min );
88 }
89
90 if ( isset( $params['prefix'] ) ) {
91 $this->addWhere(
92 $db->expr(
93 'cat_title',
94 IExpression::LIKE,
95 new LikeValue( $this->titlePartToKey( $params['prefix'], NS_CATEGORY ), $db->anyString() )
96 )
97 );
98 }
99
100 $this->addOption( 'LIMIT', $params['limit'] + 1 );
101 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
102 $this->addOption( 'ORDER BY', 'cat_title' . $sort );
103
104 $prop = array_fill_keys( $params['prop'], true );
105 $this->addFieldsIf( [ 'cat_pages', 'cat_subcats', 'cat_files' ], isset( $prop['size'] ) );
106 if ( isset( $prop['hidden'] ) ) {
107 $this->addTables( [ 'page', 'page_props' ] );
108 $this->addJoinConds( [
109 'page' => [ 'LEFT JOIN', [
110 'page_namespace' => NS_CATEGORY,
111 'page_title=cat_title' ] ],
112 'page_props' => [ 'LEFT JOIN', [
113 'pp_page=page_id',
114 'pp_propname' => 'hiddencat' ] ],
115 ] );
116 $this->addFields( [ 'cat_hidden' => 'pp_propname' ] );
117 }
118
119 $res = $this->select( __METHOD__ );
120
121 $pages = [];
122
123 $result = $this->getResult();
124 $count = 0;
125 foreach ( $res as $row ) {
126 if ( ++$count > $params['limit'] ) {
127 // We've reached the one extra which shows that there are
128 // additional cats to be had. Stop here...
129 $this->setContinueEnumParameter( 'continue', $row->cat_title );
130 break;
131 }
132
133 // Normalize titles
134 $titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title );
135 if ( $resultPageSet !== null ) {
136 $pages[] = $titleObj;
137 } else {
138 $item = [];
139 ApiResult::setContentValue( $item, 'category', $titleObj->getText() );
140 if ( isset( $prop['size'] ) ) {
141 $item['size'] = (int)$row->cat_pages;
142 $item['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files;
143 $item['files'] = (int)$row->cat_files;
144 $item['subcats'] = (int)$row->cat_subcats;
145 }
146 if ( isset( $prop['hidden'] ) ) {
147 $item['hidden'] = (bool)$row->cat_hidden;
148 }
149 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $item );
150 if ( !$fit ) {
151 $this->setContinueEnumParameter( 'continue', $row->cat_title );
152 break;
153 }
154 }
155 }
156
157 if ( $resultPageSet === null ) {
158 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'c' );
159 } else {
160 $resultPageSet->populateFromTitles( $pages );
161 }
162 }
163
164 public function getAllowedParams() {
165 return [
166 'from' => null,
167 'continue' => [
168 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
169 ],
170 'to' => null,
171 'prefix' => null,
172 'dir' => [
173 ParamValidator::PARAM_DEFAULT => 'ascending',
174 ParamValidator::PARAM_TYPE => [
175 'ascending',
176 'descending'
177 ],
178 ],
179 'min' => [
180 ParamValidator::PARAM_TYPE => 'integer'
181 ],
182 'max' => [
183 ParamValidator::PARAM_TYPE => 'integer'
184 ],
185 'limit' => [
186 ParamValidator::PARAM_DEFAULT => 10,
187 ParamValidator::PARAM_TYPE => 'limit',
188 IntegerDef::PARAM_MIN => 1,
189 IntegerDef::PARAM_MAX => ApiBase::LIMIT_BIG1,
190 IntegerDef::PARAM_MAX2 => ApiBase::LIMIT_BIG2
191 ],
192 'prop' => [
193 ParamValidator::PARAM_TYPE => [ 'size', 'hidden' ],
194 ParamValidator::PARAM_DEFAULT => '',
195 ParamValidator::PARAM_ISMULTI => true,
197 ],
198 ];
199 }
200
201 protected function getExamplesMessages() {
202 return [
203 'action=query&list=allcategories&acprop=size'
204 => 'apihelp-query+allcategories-example-size',
205 'action=query&generator=allcategories&gacprefix=List&prop=info'
206 => 'apihelp-query+allcategories-example-generator',
207 ];
208 }
209
210 public function getHelpUrls() {
211 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allcategories';
212 }
213}
const NS_CATEGORY
Definition Defines.php:79
array $params
The job parameters.
run()
Run the job.
parseContinueParamOrDie(string $continue, array $types)
Parse the 'continue' parameter in the usual format and validate the types of each part,...
Definition ApiBase.php:1731
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, or 'string' with PARAM_ISMULTI,...
Definition ApiBase.php:212
const LIMIT_BIG1
Fast query, standard limit.
Definition ApiBase.php:237
getResult()
Get the result object.
Definition ApiBase.php:681
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:821
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:172
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition ApiBase.php:239
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:542
Query module to enumerate all categories, even the ones that don't have category pages.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
__construct(ApiQuery $query, $moduleName)
executeGenerator( $resultPageSet)
Execute this module as a generator.
getExamplesMessages()
Returns usage examples for this module.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
getCacheMode( $params)
Get the cache mode for the data generated by this module.
getHelpUrls()
Return links to more detailed help pages about the module.
addWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction.
addFields( $value)
Add a set of fields to select to the internal array.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
getDB()
Get the Query database connection (read-only)
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
addWhere( $value)
Add a set of WHERE clauses to the internal array.
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
This is the main query class.
Definition ApiQuery.php:43
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
Represents a title within MediaWiki.
Definition Title.php:79
Service for formatting and validating API parameters.
Type definition for integer types.
Content of like value.
Definition LikeValue.php:14