MediaWiki REL1_35
ApiQueryAllCategories.php
Go to the documentation of this file.
1<?php
30
31 public function __construct( ApiQuery $query, $moduleName ) {
32 parent::__construct( $query, $moduleName, 'ac' );
33 }
34
35 public function execute() {
36 $this->run();
37 }
38
39 public function getCacheMode( $params ) {
40 return 'public';
41 }
42
43 public function executeGenerator( $resultPageSet ) {
44 $this->run( $resultPageSet );
45 }
46
50 private function run( $resultPageSet = null ) {
51 $db = $this->getDB();
52 $params = $this->extractRequestParams();
53
54 $this->addTables( 'category' );
55 $this->addFields( 'cat_title' );
56
57 if ( $params['continue'] !== null ) {
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" );
63 }
64
65 $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
66 $from = ( $params['from'] === null
67 ? null
68 : $this->titlePartToKey( $params['from'], NS_CATEGORY ) );
69 $to = ( $params['to'] === null
70 ? null
71 : $this->titlePartToKey( $params['to'], NS_CATEGORY ) );
72 $this->addWhereRange( 'cat_title', $dir, $from, $to );
73
74 $min = $params['min'];
75 $max = $params['max'];
76 if ( $dir == 'newer' ) {
77 $this->addWhereRange( 'cat_pages', 'newer', $min, $max );
78 } else {
79 $this->addWhereRange( 'cat_pages', 'older', $max, $min );
80 }
81
82 if ( isset( $params['prefix'] ) ) {
83 $this->addWhere( 'cat_title' . $db->buildLike(
84 $this->titlePartToKey( $params['prefix'], NS_CATEGORY ),
85 $db->anyString() ) );
86 }
87
88 $this->addOption( 'LIMIT', $params['limit'] + 1 );
89 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
90 $this->addOption( 'ORDER BY', 'cat_title' . $sort );
91
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', [
101 'pp_page=page_id',
102 'pp_propname' => 'hiddencat' ] ],
103 ] );
104 $this->addFields( [ 'cat_hidden' => 'pp_propname' ] );
105 }
106
107 $res = $this->select( __METHOD__ );
108
109 $pages = [];
110
111 $result = $this->getResult();
112 $count = 0;
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 );
118 break;
119 }
120
121 // Normalize titles
122 $titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title );
123 if ( $resultPageSet !== null ) {
124 $pages[] = $titleObj;
125 } else {
126 $item = [];
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;
133 }
134 if ( isset( $prop['hidden'] ) ) {
135 $item['hidden'] = (bool)$row->cat_hidden;
136 }
137 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $item );
138 if ( !$fit ) {
139 $this->setContinueEnumParameter( 'continue', $row->cat_title );
140 break;
141 }
142 }
143 }
144
145 if ( $resultPageSet === null ) {
146 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'c' );
147 } else {
148 $resultPageSet->populateFromTitles( $pages );
149 }
150 }
151
152 public function getAllowedParams() {
153 return [
154 'from' => null,
155 'continue' => [
156 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
157 ],
158 'to' => null,
159 'prefix' => null,
160 'dir' => [
161 ApiBase::PARAM_DFLT => 'ascending',
163 'ascending',
164 'descending'
165 ],
166 ],
167 'min' => [
168 ApiBase::PARAM_TYPE => 'integer'
169 ],
170 'max' => [
171 ApiBase::PARAM_TYPE => 'integer'
172 ],
173 'limit' => [
175 ApiBase::PARAM_TYPE => 'limit',
179 ],
180 'prop' => [
181 ApiBase::PARAM_TYPE => [ 'size', 'hidden' ],
185 ],
186 ];
187 }
188
189 protected function getExamplesMessages() {
190 return [
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',
195 ];
196 }
197
198 public function getHelpUrls() {
199 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allcategories';
200 }
201}
const PARAM_MAX2
Definition ApiBase.php:86
const PARAM_MAX
Definition ApiBase.php:82
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition ApiBase.php:1617
const PARAM_TYPE
Definition ApiBase.php:78
const PARAM_DFLT
Definition ApiBase.php:70
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:195
const PARAM_MIN
Definition ApiBase.php:90
const LIMIT_BIG1
Fast query, standard limit.
Definition ApiBase.php:220
getResult()
Get the result object.
Definition ApiBase.php:620
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:772
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:162
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition ApiBase.php:222
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:499
const PARAM_ISMULTI
Definition ApiBase.php:74
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.
run( $resultPageSet=null)
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) Stable to override.
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:37
const NS_CATEGORY
Definition Defines.php:84