42 parent::__construct( $query, $moduleName,
'ac' );
54 $this->
run( $resultPageSet );
60 private function run( $resultPageSet =
null ) {
67 if (
$params[
'continue'] !==
null ) {
69 $op =
$params[
'dir'] ==
'descending' ?
'<=' :
'>=';
70 $this->
addWhere( $db->expr(
'cat_title', $op, $cont[0] ) );
73 $dir = (
$params[
'dir'] ==
'descending' ?
'older' :
'newer' );
74 $from = (
$params[
'from'] ===
null
84 if ( $dir ==
'newer' ) {
90 if ( isset(
$params[
'prefix'] ) ) {
101 $sort = (
$params[
'dir'] ==
'descending' ?
' DESC' :
'' );
102 $this->
addOption(
'ORDER BY',
'cat_title' . $sort );
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' ] );
109 'page' => [
'LEFT JOIN', [
111 'page_title=cat_title' ] ],
112 'page_props' => [
'LEFT JOIN', [
114 'pp_propname' =>
'hiddencat' ] ],
116 $this->
addFields( [
'cat_hidden' =>
'pp_propname' ] );
119 $res = $this->
select( __METHOD__ );
125 foreach ( $res as $row ) {
126 if ( ++$count >
$params[
'limit'] ) {
134 $titleObj = Title::makeTitle(
NS_CATEGORY, $row->cat_title );
135 if ( $resultPageSet !==
null ) {
136 $pages[] = $titleObj;
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;
146 if ( isset( $prop[
'hidden'] ) ) {
147 $item[
'hidden'] = (bool)$row->cat_hidden;
149 $fit = $result->addValue( [
'query', $this->
getModuleName() ],
null, $item );
157 if ( $resultPageSet ===
null ) {
158 $result->addIndexedTagName( [
'query', $this->
getModuleName() ],
'c' );
160 $resultPageSet->populateFromTitles( $pages );
173 ParamValidator::PARAM_DEFAULT =>
'ascending',
174 ParamValidator::PARAM_TYPE => [
180 ParamValidator::PARAM_TYPE =>
'integer'
183 ParamValidator::PARAM_TYPE =>
'integer'
186 ParamValidator::PARAM_DEFAULT => 10,
187 ParamValidator::PARAM_TYPE =>
'limit',
188 IntegerDef::PARAM_MIN => 1,
193 ParamValidator::PARAM_TYPE => [
'size',
'hidden' ],
194 ParamValidator::PARAM_DEFAULT =>
'',
195 ParamValidator::PARAM_ISMULTI =>
true,
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',
211 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allcategories';
array $params
The job parameters.
parseContinueParamOrDie(string $continue, array $types)
Parse the 'continue' parameter in the usual format and validate the types of each part,...
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, or 'string' with PARAM_ISMULTI,...
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.