MediaWiki  1.23.6
ApiQueryAllCategories.php
Go to the documentation of this file.
1 <?php
34 
35  public function __construct( $query, $moduleName ) {
36  parent::__construct( $query, $moduleName, 'ac' );
37  }
38 
39  public function execute() {
40  $this->run();
41  }
42 
43  public function getCacheMode( $params ) {
44  return 'public';
45  }
46 
47  public function executeGenerator( $resultPageSet ) {
48  $this->run( $resultPageSet );
49  }
50 
54  private function run( $resultPageSet = null ) {
55  $db = $this->getDB();
56  $params = $this->extractRequestParams();
57 
58  $this->addTables( 'category' );
59  $this->addFields( 'cat_title' );
60 
61  if ( !is_null( $params['continue'] ) ) {
62  $cont = explode( '|', $params['continue'] );
63  $this->dieContinueUsageIf( count( $cont ) != 1 );
64  $op = $params['dir'] == 'descending' ? '<' : '>';
65  $cont_from = $db->addQuotes( $cont[0] );
66  $this->addWhere( "cat_title $op= $cont_from" );
67  }
68 
69  $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
70  $from = ( $params['from'] === null
71  ? null
72  : $this->titlePartToKey( $params['from'], NS_CATEGORY ) );
73  $to = ( $params['to'] === null
74  ? null
75  : $this->titlePartToKey( $params['to'], NS_CATEGORY ) );
76  $this->addWhereRange( 'cat_title', $dir, $from, $to );
77 
78  $min = $params['min'];
79  $max = $params['max'];
80  if ( $dir == 'newer' ) {
81  $this->addWhereRange( 'cat_pages', 'newer', $min, $max );
82  } else {
83  $this->addWhereRange( 'cat_pages', 'older', $max, $min );
84  }
85 
86  if ( isset( $params['prefix'] ) ) {
87  $this->addWhere( 'cat_title' . $db->buildLike(
88  $this->titlePartToKey( $params['prefix'], NS_CATEGORY ),
89  $db->anyString() ) );
90  }
91 
92  $this->addOption( 'LIMIT', $params['limit'] + 1 );
93  $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
94  $this->addOption( 'ORDER BY', 'cat_title' . $sort );
95 
96  $prop = array_flip( $params['prop'] );
97  $this->addFieldsIf( array( 'cat_pages', 'cat_subcats', 'cat_files' ), isset( $prop['size'] ) );
98  if ( isset( $prop['hidden'] ) ) {
99  $this->addTables( array( 'page', 'page_props' ) );
100  $this->addJoinConds( array(
101  'page' => array( 'LEFT JOIN', array(
102  'page_namespace' => NS_CATEGORY,
103  'page_title=cat_title' ) ),
104  'page_props' => array( 'LEFT JOIN', array(
105  'pp_page=page_id',
106  'pp_propname' => 'hiddencat' ) ),
107  ) );
108  $this->addFields( array( 'cat_hidden' => 'pp_propname' ) );
109  }
110 
111  $res = $this->select( __METHOD__ );
112 
113  $pages = array();
114 
115  $result = $this->getResult();
116  $count = 0;
117  foreach ( $res as $row ) {
118  if ( ++$count > $params['limit'] ) {
119  // We've reached the one extra which shows that there are
120  // additional cats to be had. Stop here...
121  $this->setContinueEnumParameter( 'continue', $row->cat_title );
122  break;
123  }
124 
125  // Normalize titles
126  $titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title );
127  if ( !is_null( $resultPageSet ) ) {
128  $pages[] = $titleObj;
129  } else {
130  $item = array();
131  ApiResult::setContent( $item, $titleObj->getText() );
132  if ( isset( $prop['size'] ) ) {
133  $item['size'] = intval( $row->cat_pages );
134  $item['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files;
135  $item['files'] = intval( $row->cat_files );
136  $item['subcats'] = intval( $row->cat_subcats );
137  }
138  if ( isset( $prop['hidden'] ) && $row->cat_hidden ) {
139  $item['hidden'] = '';
140  }
141  $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $item );
142  if ( !$fit ) {
143  $this->setContinueEnumParameter( 'continue', $row->cat_title );
144  break;
145  }
146  }
147  }
148 
149  if ( is_null( $resultPageSet ) ) {
150  $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'c' );
151  } else {
152  $resultPageSet->populateFromTitles( $pages );
153  }
154  }
155 
156  public function getAllowedParams() {
157  return array(
158  'from' => null,
159  'continue' => null,
160  'to' => null,
161  'prefix' => null,
162  'dir' => array(
163  ApiBase::PARAM_DFLT => 'ascending',
165  'ascending',
166  'descending'
167  ),
168  ),
169  'min' => array(
170  ApiBase::PARAM_DFLT => null,
171  ApiBase::PARAM_TYPE => 'integer'
172  ),
173  'max' => array(
174  ApiBase::PARAM_DFLT => null,
175  ApiBase::PARAM_TYPE => 'integer'
176  ),
177  'limit' => array(
178  ApiBase::PARAM_DFLT => 10,
179  ApiBase::PARAM_TYPE => 'limit',
180  ApiBase::PARAM_MIN => 1,
183  ),
184  'prop' => array(
185  ApiBase::PARAM_TYPE => array( 'size', 'hidden' ),
186  ApiBase::PARAM_DFLT => '',
187  ApiBase::PARAM_ISMULTI => true
188  ),
189  );
190  }
191 
192  public function getParamDescription() {
193  return array(
194  'from' => 'The category to start enumerating from',
195  'continue' => 'When more results are available, use this to continue',
196  'to' => 'The category to stop enumerating at',
197  'prefix' => 'Search for all category titles that begin with this value',
198  'dir' => 'Direction to sort in',
199  'min' => 'Minimum number of category members',
200  'max' => 'Maximum number of category members',
201  'limit' => 'How many categories to return',
202  'prop' => array(
203  'Which properties to get',
204  ' size - Adds number of pages in the category',
205  ' hidden - Tags categories that are hidden with __HIDDENCAT__',
206  ),
207  );
208  }
209 
210  public function getResultProperties() {
211  return array(
212  '' => array(
213  '*' => 'string'
214  ),
215  'size' => array(
216  'size' => 'integer',
217  'pages' => 'integer',
218  'files' => 'integer',
219  'subcats' => 'integer'
220  ),
221  'hidden' => array(
222  'hidden' => 'boolean'
223  )
224  );
225  }
226 
227  public function getDescription() {
228  return 'Enumerate all categories.';
229  }
230 
231  public function getExamples() {
232  return array(
233  'api.php?action=query&list=allcategories&acprop=size',
234  'api.php?action=query&generator=allcategories&gacprefix=List&prop=info',
235  );
236  }
237 
238  public function getHelpUrls() {
239  return 'https://www.mediawiki.org/wiki/API:Allcategories';
240  }
241 }
Title\makeTitle
static & makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:398
$result
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. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag '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 '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. '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 '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 '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 wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() '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 User::isValidEmailAddr(), 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 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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:Associative array mapping language codes to prefixed links of the form "language:title". & $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. 'LinkBegin':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:1528
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:117
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
ApiQueryAllCategories\executeGenerator
executeGenerator( $resultPageSet)
Execute this module as a generator.
Definition: ApiQueryAllCategories.php:47
ApiResult\setContent
static setContent(&$arr, $value, $subElemName=null)
Adds a content element to an array.
Definition: ApiResult.php:201
ApiQueryAllCategories\getExamples
getExamples()
Returns usage examples for this module.
Definition: ApiQueryAllCategories.php:231
ApiQueryAllCategories\getResultProperties
getResultProperties()
Returns possible properties in the result, grouped by the value of the prop parameter that shows them...
Definition: ApiQueryAllCategories.php:210
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:50
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:205
ApiQueryBase\select
select( $method, $extraQuery=array())
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:274
$from
$from
Definition: importImages.php:90
$params
$params
Definition: styleTest.css.php:40
ApiQueryAllCategories\getHelpUrls
getHelpUrls()
Definition: ApiQueryAllCategories.php:238
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:252
ApiQueryBase\addFieldsIf
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
Definition: ApiQueryBase.php:131
ApiQueryAllCategories
Query module to enumerate all categories, even the ones that don't have category pages.
Definition: ApiQueryAllCategories.php:33
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overrides base in case of generator & smart continue to notify ApiQueryMain instead of adding them to...
Definition: ApiQueryBase.php:676
ApiBase\PARAM_MIN
const PARAM_MIN
Definition: ApiBase.php:56
ApiQueryAllCategories\getParamDescription
getParamDescription()
Returns an array of parameter descriptions.
Definition: ApiQueryAllCategories.php:192
ApiQueryAllCategories\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryAllCategories.php:39
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Definition: ApiBase.php:78
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:417
ApiBase\PARAM_MAX
const PARAM_MAX
Definition: ApiBase.php:52
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:82
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
NS_CATEGORY
const NS_CATEGORY
Definition: Defines.php:93
$sort
$sort
Definition: profileinfo.php:301
ApiQueryBase\addWhereRange
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.
Definition: ApiQueryBase.php:205
ApiQueryAllCategories\getDescription
getDescription()
Returns the description string for this module.
Definition: ApiQueryAllCategories.php:227
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the $prefix.
Definition: ApiBase.php:1965
ApiQueryAllCategories\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryAllCategories.php:43
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:106
ApiQueryBase\titlePartToKey
titlePartToKey( $titlePart, $defaultNamespace=NS_MAIN)
An alternative to titleToKey() that doesn't trim trailing spaces, and does not mangle the input if st...
Definition: ApiQueryBase.php:491
ApiQueryAllCategories\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryAllCategories.php:156
$count
$count
Definition: UtfNormalTest2.php:96
ApiQueryGeneratorBase
Definition: ApiQueryBase.php:626
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Definition: ApiBase.php:79
$dir
if(count( $args)==0) $dir
Definition: importImages.php:49
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:46
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:9
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
Definition: ApiBase.php:48
ApiBase\PARAM_MAX2
const PARAM_MAX2
Definition: ApiBase.php:54
ApiQueryAllCategories\run
run( $resultPageSet=null)
Definition: ApiQueryAllCategories.php:54
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:152
ApiQueryAllCategories\__construct
__construct( $query, $moduleName)
Definition: ApiQueryAllCategories.php:35
$query
return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1105
$res
$res
Definition: database.txt:21