MediaWiki  1.28.0
ApiQueryCategoryMembers.php
Go to the documentation of this file.
1 <?php
33 
34  public function __construct( ApiQuery $query, $moduleName ) {
35  parent::__construct( $query, $moduleName, 'cm' );
36  }
37 
38  public function execute() {
39  $this->run();
40  }
41 
42  public function getCacheMode( $params ) {
43  return 'public';
44  }
45 
46  public function executeGenerator( $resultPageSet ) {
47  $this->run( $resultPageSet );
48  }
49 
54  private function validateHexSortkey( $hexSortkey ) {
55  // A hex sortkey has an unbound number of 2 letter pairs
56  return preg_match( '/^(?:[a-fA-F0-9]{2})*$/D', $hexSortkey );
57  }
58 
63  private function run( $resultPageSet = null ) {
64  $params = $this->extractRequestParams();
65 
66  $categoryTitle = $this->getTitleOrPageId( $params )->getTitle();
67  if ( $categoryTitle->getNamespace() != NS_CATEGORY ) {
68  $this->dieUsage( 'The category name you entered is not valid', 'invalidcategory' );
69  }
70 
71  $prop = array_flip( $params['prop'] );
72  $fld_ids = isset( $prop['ids'] );
73  $fld_title = isset( $prop['title'] );
74  $fld_sortkey = isset( $prop['sortkey'] );
75  $fld_sortkeyprefix = isset( $prop['sortkeyprefix'] );
76  $fld_timestamp = isset( $prop['timestamp'] );
77  $fld_type = isset( $prop['type'] );
78 
79  if ( is_null( $resultPageSet ) ) {
80  $this->addFields( [ 'cl_from', 'cl_sortkey', 'cl_type', 'page_namespace', 'page_title' ] );
81  $this->addFieldsIf( 'page_id', $fld_ids );
82  $this->addFieldsIf( 'cl_sortkey_prefix', $fld_sortkeyprefix );
83  } else {
84  $this->addFields( $resultPageSet->getPageTableFields() ); // will include page_ id, ns, title
85  $this->addFields( [ 'cl_from', 'cl_sortkey', 'cl_type' ] );
86  }
87 
88  $this->addFieldsIf( 'cl_timestamp', $fld_timestamp || $params['sort'] == 'timestamp' );
89 
90  $this->addTables( [ 'page', 'categorylinks' ] ); // must be in this order for 'USE INDEX'
91 
92  $this->addWhereFld( 'cl_to', $categoryTitle->getDBkey() );
93  $queryTypes = $params['type'];
94  $contWhere = false;
95 
96  // Scanning large datasets for rare categories sucks, and I already told
97  // how to have efficient subcategory access :-) ~~~~ (oh well, domas)
98  $miser_ns = [];
99  if ( $this->getConfig()->get( 'MiserMode' ) ) {
100  $miser_ns = $params['namespace'];
101  } else {
102  $this->addWhereFld( 'page_namespace', $params['namespace'] );
103  }
104 
105  $dir = in_array( $params['dir'], [ 'asc', 'ascending', 'newer' ] ) ? 'newer' : 'older';
106 
107  if ( $params['sort'] == 'timestamp' ) {
108  $this->addTimestampWhereRange( 'cl_timestamp',
109  $dir,
110  $params['start'],
111  $params['end'] );
112  // Include in ORDER BY for uniqueness
113  $this->addWhereRange( 'cl_from', $dir, null, null );
114 
115  if ( !is_null( $params['continue'] ) ) {
116  $cont = explode( '|', $params['continue'] );
117  $this->dieContinueUsageIf( count( $cont ) != 2 );
118  $op = ( $dir === 'newer' ? '>' : '<' );
119  $db = $this->getDB();
120  $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
121  $continueFrom = (int)$cont[1];
122  $this->dieContinueUsageIf( $continueFrom != $cont[1] );
123  $this->addWhere( "cl_timestamp $op $continueTimestamp OR " .
124  "(cl_timestamp = $continueTimestamp AND " .
125  "cl_from $op= $continueFrom)"
126  );
127  }
128 
129  $this->addOption( 'USE INDEX', 'cl_timestamp' );
130  } else {
131  if ( $params['continue'] ) {
132  $cont = explode( '|', $params['continue'], 3 );
133  $this->dieContinueUsageIf( count( $cont ) != 3 );
134 
135  // Remove the types to skip from $queryTypes
136  $contTypeIndex = array_search( $cont[0], $queryTypes );
137  $queryTypes = array_slice( $queryTypes, $contTypeIndex );
138 
139  // Add a WHERE clause for sortkey and from
140  $this->dieContinueUsageIf( !$this->validateHexSortkey( $cont[1] ) );
141  $escSortkey = $this->getDB()->addQuotes( hex2bin( $cont[1] ) );
142  $from = intval( $cont[2] );
143  $op = $dir == 'newer' ? '>' : '<';
144  // $contWhere is used further down
145  $contWhere = "cl_sortkey $op $escSortkey OR " .
146  "(cl_sortkey = $escSortkey AND " .
147  "cl_from $op= $from)";
148  // The below produces ORDER BY cl_sortkey, cl_from, possibly with DESC added to each of them
149  $this->addWhereRange( 'cl_sortkey', $dir, null, null );
150  $this->addWhereRange( 'cl_from', $dir, null, null );
151  } else {
152  if ( $params['startsortkeyprefix'] !== null ) {
153  $startsortkey = Collation::singleton()->getSortKey( $params['startsortkeyprefix'] );
154  } elseif ( $params['starthexsortkey'] !== null ) {
155  if ( !$this->validateHexSortkey( $params['starthexsortkey'] ) ) {
156  $this->dieUsage( 'The starthexsortkey provided is not valid', 'bad_starthexsortkey' );
157  }
158  $startsortkey = hex2bin( $params['starthexsortkey'] );
159  } else {
160  $startsortkey = $params['startsortkey'];
161  }
162  if ( $params['endsortkeyprefix'] !== null ) {
163  $endsortkey = Collation::singleton()->getSortKey( $params['endsortkeyprefix'] );
164  } elseif ( $params['endhexsortkey'] !== null ) {
165  if ( !$this->validateHexSortkey( $params['endhexsortkey'] ) ) {
166  $this->dieUsage( 'The endhexsortkey provided is not valid', 'bad_endhexsortkey' );
167  }
168  $endsortkey = hex2bin( $params['endhexsortkey'] );
169  } else {
170  $endsortkey = $params['endsortkey'];
171  }
172 
173  // The below produces ORDER BY cl_sortkey, cl_from, possibly with DESC added to each of them
174  $this->addWhereRange( 'cl_sortkey',
175  $dir,
176  $startsortkey,
177  $endsortkey );
178  $this->addWhereRange( 'cl_from', $dir, null, null );
179  }
180  $this->addOption( 'USE INDEX', 'cl_sortkey' );
181  }
182 
183  $this->addWhere( 'cl_from=page_id' );
184 
185  $limit = $params['limit'];
186  $this->addOption( 'LIMIT', $limit + 1 );
187 
188  if ( $params['sort'] == 'sortkey' ) {
189  // Run a separate SELECT query for each value of cl_type.
190  // This is needed because cl_type is an enum, and MySQL has
191  // inconsistencies between ORDER BY cl_type and
192  // WHERE cl_type >= 'foo' making proper paging impossible
193  // and unindexed.
194  $rows = [];
195  $first = true;
196  foreach ( $queryTypes as $type ) {
197  $extraConds = [ 'cl_type' => $type ];
198  if ( $first && $contWhere ) {
199  // Continuation condition. Only added to the
200  // first query, otherwise we'll skip things
201  $extraConds[] = $contWhere;
202  }
203  $res = $this->select( __METHOD__, [ 'where' => $extraConds ] );
204  $rows = array_merge( $rows, iterator_to_array( $res ) );
205  if ( count( $rows ) >= $limit + 1 ) {
206  break;
207  }
208  $first = false;
209  }
210  } else {
211  // Sorting by timestamp
212  // No need to worry about per-type queries because we
213  // aren't sorting or filtering by type anyway
214  $res = $this->select( __METHOD__ );
215  $rows = iterator_to_array( $res );
216  }
217 
218  $result = $this->getResult();
219  $count = 0;
220  foreach ( $rows as $row ) {
221  if ( ++$count > $limit ) {
222  // We've reached the one extra which shows that there are
223  // additional pages to be had. Stop here...
224  // @todo Security issue - if the user has no right to view next
225  // title, it will still be shown
226  if ( $params['sort'] == 'timestamp' ) {
227  $this->setContinueEnumParameter( 'continue', "$row->cl_timestamp|$row->cl_from" );
228  } else {
229  $sortkey = bin2hex( $row->cl_sortkey );
230  $this->setContinueEnumParameter( 'continue',
231  "{$row->cl_type}|$sortkey|{$row->cl_from}"
232  );
233  }
234  break;
235  }
236 
237  // Since domas won't tell anyone what he told long ago, apply
238  // cmnamespace here. This means the query may return 0 actual
239  // results, but on the other hand it could save returning 5000
240  // useless results to the client. ~~~~
241  if ( count( $miser_ns ) && !in_array( $row->page_namespace, $miser_ns ) ) {
242  continue;
243  }
244 
245  if ( is_null( $resultPageSet ) ) {
246  $vals = [
247  ApiResult::META_TYPE => 'assoc',
248  ];
249  if ( $fld_ids ) {
250  $vals['pageid'] = intval( $row->page_id );
251  }
252  if ( $fld_title ) {
253  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
255  }
256  if ( $fld_sortkey ) {
257  $vals['sortkey'] = bin2hex( $row->cl_sortkey );
258  }
259  if ( $fld_sortkeyprefix ) {
260  $vals['sortkeyprefix'] = $row->cl_sortkey_prefix;
261  }
262  if ( $fld_type ) {
263  $vals['type'] = $row->cl_type;
264  }
265  if ( $fld_timestamp ) {
266  $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->cl_timestamp );
267  }
268  $fit = $result->addValue( [ 'query', $this->getModuleName() ],
269  null, $vals );
270  if ( !$fit ) {
271  if ( $params['sort'] == 'timestamp' ) {
272  $this->setContinueEnumParameter( 'continue', "$row->cl_timestamp|$row->cl_from" );
273  } else {
274  $sortkey = bin2hex( $row->cl_sortkey );
275  $this->setContinueEnumParameter( 'continue',
276  "{$row->cl_type}|$sortkey|{$row->cl_from}"
277  );
278  }
279  break;
280  }
281  } else {
282  $resultPageSet->processDbRow( $row );
283  }
284  }
285 
286  if ( is_null( $resultPageSet ) ) {
287  $result->addIndexedTagName(
288  [ 'query', $this->getModuleName() ], 'cm' );
289  }
290  }
291 
292  public function getAllowedParams() {
293  $ret = [
294  'title' => [
295  ApiBase::PARAM_TYPE => 'string',
296  ],
297  'pageid' => [
298  ApiBase::PARAM_TYPE => 'integer'
299  ],
300  'prop' => [
301  ApiBase::PARAM_DFLT => 'ids|title',
302  ApiBase::PARAM_ISMULTI => true,
304  'ids',
305  'title',
306  'sortkey',
307  'sortkeyprefix',
308  'type',
309  'timestamp',
310  ],
312  ],
313  'namespace' => [
314  ApiBase::PARAM_ISMULTI => true,
315  ApiBase::PARAM_TYPE => 'namespace',
316  ],
317  'type' => [
318  ApiBase::PARAM_ISMULTI => true,
319  ApiBase::PARAM_DFLT => 'page|subcat|file',
321  'page',
322  'subcat',
323  'file'
324  ]
325  ],
326  'continue' => [
327  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
328  ],
329  'limit' => [
330  ApiBase::PARAM_TYPE => 'limit',
331  ApiBase::PARAM_DFLT => 10,
332  ApiBase::PARAM_MIN => 1,
335  ],
336  'sort' => [
337  ApiBase::PARAM_DFLT => 'sortkey',
339  'sortkey',
340  'timestamp'
341  ]
342  ],
343  'dir' => [
344  ApiBase::PARAM_DFLT => 'ascending',
346  'asc',
347  'desc',
348  // Normalising with other modules
349  'ascending',
350  'descending',
351  'newer',
352  'older',
353  ]
354  ],
355  'start' => [
356  ApiBase::PARAM_TYPE => 'timestamp'
357  ],
358  'end' => [
359  ApiBase::PARAM_TYPE => 'timestamp'
360  ],
361  'starthexsortkey' => null,
362  'endhexsortkey' => null,
363  'startsortkeyprefix' => null,
364  'endsortkeyprefix' => null,
365  'startsortkey' => [
367  ],
368  'endsortkey' => [
370  ],
371  ];
372 
373  if ( $this->getConfig()->get( 'MiserMode' ) ) {
374  $ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [
375  'api-help-param-limited-in-miser-mode',
376  ];
377  }
378 
379  return $ret;
380  }
381 
382  protected function getExamplesMessages() {
383  return [
384  'action=query&list=categorymembers&cmtitle=Category:Physics'
385  => 'apihelp-query+categorymembers-example-simple',
386  'action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info'
387  => 'apihelp-query+categorymembers-example-generator',
388  ];
389  }
390 
391  public function getHelpUrls() {
392  return 'https://www.mediawiki.org/wiki/API:Categorymembers';
393  }
394 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
getDB()
Get the Query database connection (read-only)
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:179
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:1555
getResult()
Get the result object.
Definition: ApiBase.php:577
if(count($args)==0) $dir
addWhereFld($field, $value)
Equivalent to addWhere(array($field => $value))
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1936
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:177
static singleton()
Definition: Collation.php:34
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...
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:91
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:678
const META_TYPE
Key for the 'type' metadata item.
Definition: ApiResult.php:108
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:157
select($method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
addTimestampWhereRange($field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
setContinueEnumParameter($paramName, $paramValue)
Overridden to set the generator param if in generator mode.
addWhere($value)
Add a set of WHERE clauses to the internal array.
const TS_ISO_8601
ISO 8601 format with no timezone: 1986-02-09T20:00:00Z.
Definition: defines.php:28
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 '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. '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) '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 '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. '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!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:1934
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition: ApiBase.php:132
getTitleOrPageId($params, $load=false)
Get a WikiPage object from a title or pageid param, if possible.
Definition: ApiBase.php:833
$res
Definition: database.txt:21
getConfig()
Get the Config object.
addOption($name, $value=null)
Add an option such as LIMIT or USE INDEX.
$params
const NS_CATEGORY
Definition: Defines.php:70
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:457
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'.
Definition: ApiBase.php:97
This is the main query class.
Definition: ApiQuery.php:38
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
dieContinueUsageIf($condition)
Die with the $prefix.
Definition: ApiBase.php:2229
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
addFieldsIf($value, $condition)
Same as addFields(), but add the fields only if a condition is met.
$from
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
addFields($value)
Add a set of fields to select to the internal array.
__construct(ApiQuery $query, $moduleName)
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:53
dieUsage($description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1574
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
Definition: hooks.txt:1046
$count
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition: ApiBase.php:106
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:100
static addTitleInfo(&$arr, $title, $prefix= '')
Add information (title and namespace) about a Title object to a result array.
addTables($tables, $alias=null)
Add a set of tables to the internal array.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:511
A query module to enumerate pages that belong to a category.