MediaWiki REL1_39
ApiQueryAllCategories.php
Go to the documentation of this file.
1<?php
25
33
38 public function __construct( ApiQuery $query, $moduleName ) {
39 parent::__construct( $query, $moduleName, 'ac' );
40 }
41
42 public function execute() {
43 $this->run();
44 }
45
46 public function getCacheMode( $params ) {
47 return 'public';
48 }
49
50 public function executeGenerator( $resultPageSet ) {
51 $this->run( $resultPageSet );
52 }
53
57 private function run( $resultPageSet = null ) {
58 $db = $this->getDB();
59 $params = $this->extractRequestParams();
60
61 $this->addTables( 'category' );
62 $this->addFields( 'cat_title' );
63
64 if ( $params['continue'] !== null ) {
65 $cont = explode( '|', $params['continue'] );
66 $this->dieContinueUsageIf( count( $cont ) != 1 );
67 $op = $params['dir'] == 'descending' ? '<' : '>';
68 $cont_from = $db->addQuotes( $cont[0] );
69 $this->addWhere( "cat_title $op= $cont_from" );
70 }
71
72 $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
73 $from = ( $params['from'] === null
74 ? null
75 : $this->titlePartToKey( $params['from'], NS_CATEGORY ) );
76 $to = ( $params['to'] === null
77 ? null
78 : $this->titlePartToKey( $params['to'], NS_CATEGORY ) );
79 $this->addWhereRange( 'cat_title', $dir, $from, $to );
80
81 $min = $params['min'];
82 $max = $params['max'];
83 if ( $dir == 'newer' ) {
84 $this->addWhereRange( 'cat_pages', 'newer', $min, $max );
85 } else {
86 $this->addWhereRange( 'cat_pages', 'older', $max, $min );
87 }
88
89 if ( isset( $params['prefix'] ) ) {
90 $this->addWhere( 'cat_title' . $db->buildLike(
91 $this->titlePartToKey( $params['prefix'], NS_CATEGORY ),
92 $db->anyString() ) );
93 }
94
95 $this->addOption( 'LIMIT', $params['limit'] + 1 );
96 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
97 $this->addOption( 'ORDER BY', 'cat_title' . $sort );
98
99 $prop = array_fill_keys( $params['prop'], true );
100 $this->addFieldsIf( [ 'cat_pages', 'cat_subcats', 'cat_files' ], isset( $prop['size'] ) );
101 if ( isset( $prop['hidden'] ) ) {
102 $this->addTables( [ 'page', 'page_props' ] );
103 $this->addJoinConds( [
104 'page' => [ 'LEFT JOIN', [
105 'page_namespace' => NS_CATEGORY,
106 'page_title=cat_title' ] ],
107 'page_props' => [ 'LEFT JOIN', [
108 'pp_page=page_id',
109 'pp_propname' => 'hiddencat' ] ],
110 ] );
111 $this->addFields( [ 'cat_hidden' => 'pp_propname' ] );
112 }
113
114 $res = $this->select( __METHOD__ );
115
116 $pages = [];
117
118 $result = $this->getResult();
119 $count = 0;
120 foreach ( $res as $row ) {
121 if ( ++$count > $params['limit'] ) {
122 // We've reached the one extra which shows that there are
123 // additional cats to be had. Stop here...
124 $this->setContinueEnumParameter( 'continue', $row->cat_title );
125 break;
126 }
127
128 // Normalize titles
129 $titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title );
130 if ( $resultPageSet !== null ) {
131 $pages[] = $titleObj;
132 } else {
133 $item = [];
134 ApiResult::setContentValue( $item, 'category', $titleObj->getText() );
135 if ( isset( $prop['size'] ) ) {
136 $item['size'] = (int)$row->cat_pages;
137 $item['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files;
138 $item['files'] = (int)$row->cat_files;
139 $item['subcats'] = (int)$row->cat_subcats;
140 }
141 if ( isset( $prop['hidden'] ) ) {
142 $item['hidden'] = (bool)$row->cat_hidden;
143 }
144 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $item );
145 if ( !$fit ) {
146 $this->setContinueEnumParameter( 'continue', $row->cat_title );
147 break;
148 }
149 }
150 }
151
152 if ( $resultPageSet === null ) {
153 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'c' );
154 } else {
155 $resultPageSet->populateFromTitles( $pages );
156 }
157 }
158
159 public function getAllowedParams() {
160 return [
161 'from' => null,
162 'continue' => [
163 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
164 ],
165 'to' => null,
166 'prefix' => null,
167 'dir' => [
168 ParamValidator::PARAM_DEFAULT => 'ascending',
169 ParamValidator::PARAM_TYPE => [
170 'ascending',
171 'descending'
172 ],
173 ],
174 'min' => [
175 ParamValidator::PARAM_TYPE => 'integer'
176 ],
177 'max' => [
178 ParamValidator::PARAM_TYPE => 'integer'
179 ],
180 'limit' => [
181 ParamValidator::PARAM_DEFAULT => 10,
182 ParamValidator::PARAM_TYPE => 'limit',
183 IntegerDef::PARAM_MIN => 1,
184 IntegerDef::PARAM_MAX => ApiBase::LIMIT_BIG1,
185 IntegerDef::PARAM_MAX2 => ApiBase::LIMIT_BIG2
186 ],
187 'prop' => [
188 ParamValidator::PARAM_TYPE => [ 'size', 'hidden' ],
189 ParamValidator::PARAM_DEFAULT => '',
190 ParamValidator::PARAM_ISMULTI => true,
192 ],
193 ];
194 }
195
196 protected function getExamplesMessages() {
197 return [
198 'action=query&list=allcategories&acprop=size'
199 => 'apihelp-query+allcategories-example-size',
200 'action=query&generator=allcategories&gacprefix=List&prop=info'
201 => 'apihelp-query+allcategories-example-generator',
202 ];
203 }
204
205 public function getHelpUrls() {
206 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allcategories';
207 }
208}
const NS_CATEGORY
Definition Defines.php:78
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition ApiBase.php:1643
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition ApiBase.php:196
const LIMIT_BIG1
Fast query, standard limit.
Definition ApiBase.php:221
getResult()
Get the result object.
Definition ApiBase.php:629
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:765
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:163
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition ApiBase.php:223
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:498
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:41
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition Title.php:638
Service for formatting and validating API parameters.
Type definition for integer types.