39 parent::__construct( $query, $moduleName,
'ac' );
51 $this->run( $resultPageSet );
57 private function run( $resultPageSet =
null ) {
64 if ( $params[
'continue'] !==
null ) {
65 $cont = explode(
'|', $params[
'continue'] );
67 $op = $params[
'dir'] ==
'descending' ?
'<' :
'>';
68 $cont_from = $db->addQuotes( $cont[0] );
69 $this->
addWhere(
"cat_title $op= $cont_from" );
72 $dir = ( $params[
'dir'] ==
'descending' ?
'older' :
'newer' );
73 $from = ( $params[
'from'] ===
null
76 $to = ( $params[
'to'] ===
null
81 $min = $params[
'min'];
82 $max = $params[
'max'];
83 if ( $dir ==
'newer' ) {
89 if ( isset( $params[
'prefix'] ) ) {
90 $this->
addWhere(
'cat_title' . $db->buildLike(
91 $this->titlePartToKey( $params[
'prefix'],
NS_CATEGORY ),
95 $this->
addOption(
'LIMIT', $params[
'limit'] + 1 );
96 $sort = ( $params[
'dir'] ==
'descending' ?
' DESC' :
'' );
97 $this->
addOption(
'ORDER BY',
'cat_title' . $sort );
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' ] );
104 'page' => [
'LEFT JOIN', [
106 'page_title=cat_title' ] ],
107 'page_props' => [
'LEFT JOIN', [
109 'pp_propname' =>
'hiddencat' ] ],
111 $this->
addFields( [
'cat_hidden' =>
'pp_propname' ] );
120 foreach (
$res as $row ) {
121 if ( ++$count > $params[
'limit'] ) {
130 if ( $resultPageSet !==
null ) {
131 $pages[] = $titleObj;
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;
141 if ( isset( $prop[
'hidden'] ) ) {
142 $item[
'hidden'] = (bool)$row->cat_hidden;
144 $fit = $result->addValue( [
'query', $this->
getModuleName() ],
null, $item );
152 if ( $resultPageSet ===
null ) {
153 $result->addIndexedTagName( [
'query', $this->
getModuleName() ],
'c' );
155 $resultPageSet->populateFromTitles( $pages );
168 ParamValidator::PARAM_DEFAULT =>
'ascending',
169 ParamValidator::PARAM_TYPE => [
175 ParamValidator::PARAM_TYPE =>
'integer'
178 ParamValidator::PARAM_TYPE =>
'integer'
181 ParamValidator::PARAM_DEFAULT => 10,
182 ParamValidator::PARAM_TYPE =>
'limit',
183 IntegerDef::PARAM_MIN => 1,
188 ParamValidator::PARAM_TYPE => [
'size',
'hidden' ],
189 ParamValidator::PARAM_DEFAULT =>
'',
190 ParamValidator::PARAM_ISMULTI =>
true,
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',
206 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allcategories';
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
const LIMIT_BIG1
Fast query, standard limit.
getResult()
Get the result object.
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
const LIMIT_BIG2
Fast query, apihighlimits limit.
getModuleName()
Get the name of the module being executed by this instance.
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.
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.