MediaWiki  REL1_31
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()->getGoodAndMissingTitles();
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 ( !is_null( $params['continue'] ) ) {
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'] = intval( $row->cat_pages );
82  $vals['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files;
83  $vals['files'] = intval( $row->cat_files );
84  $vals['subcats'] = intval( $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 }
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:192
ApiQuery
This is the main query class.
Definition: ApiQuery.php:36
ApiQueryCategoryInfo
This query adds the "<categories>" subelement to all pages with the list of categories the page is in...
Definition: ApiQueryCategoryInfo.php:29
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
ApiQueryCategoryInfo\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryCategoryInfo.php:113
$params
$params
Definition: styleTest.css.php:40
ApiQueryCategoryInfo\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryCategoryInfo.php:94
$res
$res
Definition: database.txt:21
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:325
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
$titles
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
ApiQueryBase
This is a base class for all Query modules.
Definition: ApiQueryBase.php:33
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:105
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:158
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:350
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
NS_CATEGORY
const NS_CATEGORY
Definition: Defines.php:88
ApiQueryCategoryInfo\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryCategoryInfo.php:35
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:749
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:181
ApiQueryCategoryInfo\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryCategoryInfo.php:98
ApiQueryCategoryInfo\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryCategoryInfo.php:106
ApiQueryBase\getPageSet
getPageSet()
Get the PageSet object to work on.
Definition: ApiQueryBase.php:130
ApiQueryCategoryInfo\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryCategoryInfo.php:31
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:227
$t
$t
Definition: testCompression.php:69
ApiQueryBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
Definition: ApiQueryBase.php:531
$query
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1620