MediaWiki  master
ApiQueryCategoryInfo.php
Go to the documentation of this file.
1 <?php
30 
31  public function __construct( ApiQuery $query, $moduleName ) {
32  parent::__construct( $query, $moduleName, 'ci' );
33  }
34 
35  public function execute() {
36  $params = $this->extractRequestParams();
37  $alltitles = $this->getPageSet()->getGoodAndMissingTitlesByNamespace();
38  if ( empty( $alltitles[NS_CATEGORY] ) ) {
39  return;
40  }
41  $categories = $alltitles[NS_CATEGORY];
42 
43  $titles = $this->getPageSet()->getGoodAndMissingPages();
44  $cattitles = [];
45  foreach ( $categories as $c ) {
47  $t = $titles[$c];
48  $cattitles[$c] = $t->getDBkey();
49  }
50 
51  $this->addTables( [ 'category', 'page', 'page_props' ] );
52  $this->addJoinConds( [
53  'page' => [ 'LEFT JOIN', [
54  'page_namespace' => NS_CATEGORY,
55  'page_title=cat_title' ] ],
56  'page_props' => [ 'LEFT JOIN', [
57  'pp_page=page_id',
58  'pp_propname' => 'hiddencat' ] ],
59  ] );
60 
61  $this->addFields( [
62  'cat_title',
63  'cat_pages',
64  'cat_subcats',
65  'cat_files',
66  'cat_hidden' => 'pp_propname'
67  ] );
68  $this->addWhere( [ 'cat_title' => $cattitles ] );
69 
70  if ( $params['continue'] !== null ) {
71  $title = $this->getDB()->addQuotes( $params['continue'] );
72  $this->addWhere( "cat_title >= $title" );
73  }
74  $this->addOption( 'ORDER BY', 'cat_title' );
75 
76  $res = $this->select( __METHOD__ );
77 
78  $catids = array_flip( $cattitles );
79  foreach ( $res as $row ) {
80  $vals = [];
81  $vals['size'] = (int)$row->cat_pages;
82  $vals['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files;
83  $vals['files'] = (int)$row->cat_files;
84  $vals['subcats'] = (int)$row->cat_subcats;
85  $vals['hidden'] = (bool)$row->cat_hidden;
86  $fit = $this->addPageSubItems( $catids[$row->cat_title], $vals );
87  if ( !$fit ) {
88  $this->setContinueEnumParameter( 'continue', $row->cat_title );
89  break;
90  }
91  }
92  }
93 
94  public function getCacheMode( $params ) {
95  return 'public';
96  }
97 
98  public function getAllowedParams() {
99  return [
100  'continue' => [
101  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
102  ],
103  ];
104  }
105 
106  protected function getExamplesMessages() {
107  return [
108  'action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar'
109  => 'apihelp-query+categoryinfo-example-simple',
110  ];
111  }
112 
113  public function getHelpUrls() {
114  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Categoryinfo';
115  }
116 }
const NS_CATEGORY
Definition: Defines.php:78
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
This is a base class for all Query modules.
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
addPageSubItems( $pageId, $data)
Add a sub-element under the page element with the given page ID.
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.
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
getPageSet()
Get the PageSet object to work on.
addWhere( $value)
Add a set of WHERE clauses to the internal array.
This query adds the "<categories>" subelement to all pages with the list of categories the page is in...
__construct(ApiQuery $query, $moduleName)
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
getExamplesMessages()
Returns usage examples for this module.
getHelpUrls()
Return links to more detailed help pages about the module.
getCacheMode( $params)
Get the cache mode for the data generated by this module.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
This is the main query class.
Definition: ApiQuery.php:40