MediaWiki  master
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 ( !is_null( $params['continue'] ) ) {
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 ( !is_null( $resultPageSet ) ) {
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 ( is_null( $resultPageSet ) ) {
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' => [
174  ApiBase::PARAM_DFLT => 10,
175  ApiBase::PARAM_TYPE => 'limit',
176  ApiBase::PARAM_MIN => 1,
179  ],
180  'prop' => [
181  ApiBase::PARAM_TYPE => [ 'size', 'hidden' ],
182  ApiBase::PARAM_DFLT => '',
183  ApiBase::PARAM_ISMULTI => true,
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 }
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
getDB()
Get the Query database connection (read-only)
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:261
null for the local 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:1585
getResult()
Get the result object.
Definition: ApiBase.php:639
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:259
executeGenerator( $resultPageSet)
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:97
Query module to enumerate all categories, even the ones that don&#39;t have category pages.
$sort
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:760
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:164
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
__construct(ApiQuery $query, $moduleName)
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
Definition: ApiResult.php:478
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1980
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
$res
Definition: database.txt:21
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2199
$params
const NS_CATEGORY
Definition: Defines.php:74
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:519
addFields( $value)
Add a set of fields to select to the internal array.
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE &#39;limit&#39;.
Definition: ApiBase.php:103
This is the main query class.
Definition: ApiQuery.php:36
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:9
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:589
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:35
addWhere( $value)
Add a set of WHERE clauses to the internal array.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:106
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...