MediaWiki  REL1_31
ApiQueryCategoryMembers.php
Go to the documentation of this file.
1 <?php
29 
30  public function __construct( ApiQuery $query, $moduleName ) {
31  parent::__construct( $query, $moduleName, 'cm' );
32  }
33 
34  public function execute() {
35  $this->run();
36  }
37 
38  public function getCacheMode( $params ) {
39  return 'public';
40  }
41 
42  public function executeGenerator( $resultPageSet ) {
43  $this->run( $resultPageSet );
44  }
45 
50  private function validateHexSortkey( $hexSortkey ) {
51  // A hex sortkey has an unbound number of 2 letter pairs
52  return (bool)preg_match( '/^(?:[a-fA-F0-9]{2})*$/D', $hexSortkey );
53  }
54 
59  private function run( $resultPageSet = null ) {
60  $params = $this->extractRequestParams();
61 
62  $categoryTitle = $this->getTitleOrPageId( $params )->getTitle();
63  if ( $categoryTitle->getNamespace() != NS_CATEGORY ) {
64  $this->dieWithError( 'apierror-invalidcategory' );
65  }
66 
67  $prop = array_flip( $params['prop'] );
68  $fld_ids = isset( $prop['ids'] );
69  $fld_title = isset( $prop['title'] );
70  $fld_sortkey = isset( $prop['sortkey'] );
71  $fld_sortkeyprefix = isset( $prop['sortkeyprefix'] );
72  $fld_timestamp = isset( $prop['timestamp'] );
73  $fld_type = isset( $prop['type'] );
74 
75  if ( is_null( $resultPageSet ) ) {
76  $this->addFields( [ 'cl_from', 'cl_sortkey', 'cl_type', 'page_namespace', 'page_title' ] );
77  $this->addFieldsIf( 'page_id', $fld_ids );
78  $this->addFieldsIf( 'cl_sortkey_prefix', $fld_sortkeyprefix );
79  } else {
80  $this->addFields( $resultPageSet->getPageTableFields() ); // will include page_ id, ns, title
81  $this->addFields( [ 'cl_from', 'cl_sortkey', 'cl_type' ] );
82  }
83 
84  $this->addFieldsIf( 'cl_timestamp', $fld_timestamp || $params['sort'] == 'timestamp' );
85 
86  $this->addTables( [ 'page', 'categorylinks' ] ); // must be in this order for 'USE INDEX'
87 
88  $this->addWhereFld( 'cl_to', $categoryTitle->getDBkey() );
89  $queryTypes = $params['type'];
90  $contWhere = false;
91 
92  // Scanning large datasets for rare categories sucks, and I already told
93  // how to have efficient subcategory access :-) ~~~~ (oh well, domas)
94  $miser_ns = [];
95  if ( $this->getConfig()->get( 'MiserMode' ) ) {
96  $miser_ns = $params['namespace'] ?: [];
97  } else {
98  $this->addWhereFld( 'page_namespace', $params['namespace'] );
99  }
100 
101  $dir = in_array( $params['dir'], [ 'asc', 'ascending', 'newer' ] ) ? 'newer' : 'older';
102 
103  if ( $params['sort'] == 'timestamp' ) {
104  $this->addTimestampWhereRange( 'cl_timestamp',
105  $dir,
106  $params['start'],
107  $params['end'] );
108  // Include in ORDER BY for uniqueness
109  $this->addWhereRange( 'cl_from', $dir, null, null );
110 
111  if ( !is_null( $params['continue'] ) ) {
112  $cont = explode( '|', $params['continue'] );
113  $this->dieContinueUsageIf( count( $cont ) != 2 );
114  $op = ( $dir === 'newer' ? '>' : '<' );
115  $db = $this->getDB();
116  $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
117  $continueFrom = (int)$cont[1];
118  $this->dieContinueUsageIf( $continueFrom != $cont[1] );
119  $this->addWhere( "cl_timestamp $op $continueTimestamp OR " .
120  "(cl_timestamp = $continueTimestamp AND " .
121  "cl_from $op= $continueFrom)"
122  );
123  }
124 
125  $this->addOption( 'USE INDEX', 'cl_timestamp' );
126  } else {
127  if ( $params['continue'] ) {
128  $cont = explode( '|', $params['continue'], 3 );
129  $this->dieContinueUsageIf( count( $cont ) != 3 );
130 
131  // Remove the types to skip from $queryTypes
132  $contTypeIndex = array_search( $cont[0], $queryTypes );
133  $queryTypes = array_slice( $queryTypes, $contTypeIndex );
134 
135  // Add a WHERE clause for sortkey and from
136  $this->dieContinueUsageIf( !$this->validateHexSortkey( $cont[1] ) );
137  $escSortkey = $this->getDB()->addQuotes( hex2bin( $cont[1] ) );
138  $from = intval( $cont[2] );
139  $op = $dir == 'newer' ? '>' : '<';
140  // $contWhere is used further down
141  $contWhere = "cl_sortkey $op $escSortkey OR " .
142  "(cl_sortkey = $escSortkey AND " .
143  "cl_from $op= $from)";
144  // The below produces ORDER BY cl_sortkey, cl_from, possibly with DESC added to each of them
145  $this->addWhereRange( 'cl_sortkey', $dir, null, null );
146  $this->addWhereRange( 'cl_from', $dir, null, null );
147  } else {
148  if ( $params['startsortkeyprefix'] !== null ) {
149  $startsortkey = Collation::singleton()->getSortKey( $params['startsortkeyprefix'] );
150  } elseif ( $params['starthexsortkey'] !== null ) {
151  if ( !$this->validateHexSortkey( $params['starthexsortkey'] ) ) {
152  $encParamName = $this->encodeParamName( 'starthexsortkey' );
153  $this->dieWithError( [ 'apierror-badparameter', $encParamName ], "badvalue_$encParamName" );
154  }
155  $startsortkey = hex2bin( $params['starthexsortkey'] );
156  } else {
157  $startsortkey = $params['startsortkey'];
158  }
159  if ( $params['endsortkeyprefix'] !== null ) {
160  $endsortkey = Collation::singleton()->getSortKey( $params['endsortkeyprefix'] );
161  } elseif ( $params['endhexsortkey'] !== null ) {
162  if ( !$this->validateHexSortkey( $params['endhexsortkey'] ) ) {
163  $encParamName = $this->encodeParamName( 'endhexsortkey' );
164  $this->dieWithError( [ 'apierror-badparameter', $encParamName ], "badvalue_$encParamName" );
165  }
166  $endsortkey = hex2bin( $params['endhexsortkey'] );
167  } else {
168  $endsortkey = $params['endsortkey'];
169  }
170 
171  // The below produces ORDER BY cl_sortkey, cl_from, possibly with DESC added to each of them
172  $this->addWhereRange( 'cl_sortkey',
173  $dir,
174  $startsortkey,
175  $endsortkey );
176  $this->addWhereRange( 'cl_from', $dir, null, null );
177  }
178  $this->addOption( 'USE INDEX', 'cl_sortkey' );
179  }
180 
181  $this->addWhere( 'cl_from=page_id' );
182 
183  $limit = $params['limit'];
184  $this->addOption( 'LIMIT', $limit + 1 );
185 
186  if ( $params['sort'] == 'sortkey' ) {
187  // Run a separate SELECT query for each value of cl_type.
188  // This is needed because cl_type is an enum, and MySQL has
189  // inconsistencies between ORDER BY cl_type and
190  // WHERE cl_type >= 'foo' making proper paging impossible
191  // and unindexed.
192  $rows = [];
193  $first = true;
194  foreach ( $queryTypes as $type ) {
195  $extraConds = [ 'cl_type' => $type ];
196  if ( $first && $contWhere ) {
197  // Continuation condition. Only added to the
198  // first query, otherwise we'll skip things
199  $extraConds[] = $contWhere;
200  }
201  $res = $this->select( __METHOD__, [ 'where' => $extraConds ] );
202  $rows = array_merge( $rows, iterator_to_array( $res ) );
203  if ( count( $rows ) >= $limit + 1 ) {
204  break;
205  }
206  $first = false;
207  }
208  } else {
209  // Sorting by timestamp
210  // No need to worry about per-type queries because we
211  // aren't sorting or filtering by type anyway
212  $res = $this->select( __METHOD__ );
213  $rows = iterator_to_array( $res );
214  }
215 
216  $result = $this->getResult();
217  $count = 0;
218  foreach ( $rows as $row ) {
219  if ( ++$count > $limit ) {
220  // We've reached the one extra which shows that there are
221  // additional pages to be had. Stop here...
222  // @todo Security issue - if the user has no right to view next
223  // title, it will still be shown
224  if ( $params['sort'] == 'timestamp' ) {
225  $this->setContinueEnumParameter( 'continue', "$row->cl_timestamp|$row->cl_from" );
226  } else {
227  $sortkey = bin2hex( $row->cl_sortkey );
228  $this->setContinueEnumParameter( 'continue',
229  "{$row->cl_type}|$sortkey|{$row->cl_from}"
230  );
231  }
232  break;
233  }
234 
235  // Since domas won't tell anyone what he told long ago, apply
236  // cmnamespace here. This means the query may return 0 actual
237  // results, but on the other hand it could save returning 5000
238  // useless results to the client. ~~~~
239  if ( count( $miser_ns ) && !in_array( $row->page_namespace, $miser_ns ) ) {
240  continue;
241  }
242 
243  if ( is_null( $resultPageSet ) ) {
244  $vals = [
245  ApiResult::META_TYPE => 'assoc',
246  ];
247  if ( $fld_ids ) {
248  $vals['pageid'] = intval( $row->page_id );
249  }
250  if ( $fld_title ) {
251  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
253  }
254  if ( $fld_sortkey ) {
255  $vals['sortkey'] = bin2hex( $row->cl_sortkey );
256  }
257  if ( $fld_sortkeyprefix ) {
258  $vals['sortkeyprefix'] = $row->cl_sortkey_prefix;
259  }
260  if ( $fld_type ) {
261  $vals['type'] = $row->cl_type;
262  }
263  if ( $fld_timestamp ) {
264  $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->cl_timestamp );
265  }
266  $fit = $result->addValue( [ 'query', $this->getModuleName() ],
267  null, $vals );
268  if ( !$fit ) {
269  if ( $params['sort'] == 'timestamp' ) {
270  $this->setContinueEnumParameter( 'continue', "$row->cl_timestamp|$row->cl_from" );
271  } else {
272  $sortkey = bin2hex( $row->cl_sortkey );
273  $this->setContinueEnumParameter( 'continue',
274  "{$row->cl_type}|$sortkey|{$row->cl_from}"
275  );
276  }
277  break;
278  }
279  } else {
280  $resultPageSet->processDbRow( $row );
281  }
282  }
283 
284  if ( is_null( $resultPageSet ) ) {
285  $result->addIndexedTagName(
286  [ 'query', $this->getModuleName() ], 'cm' );
287  }
288  }
289 
290  public function getAllowedParams() {
291  $ret = [
292  'title' => [
293  ApiBase::PARAM_TYPE => 'string',
294  ],
295  'pageid' => [
296  ApiBase::PARAM_TYPE => 'integer'
297  ],
298  'prop' => [
299  ApiBase::PARAM_DFLT => 'ids|title',
300  ApiBase::PARAM_ISMULTI => true,
302  'ids',
303  'title',
304  'sortkey',
305  'sortkeyprefix',
306  'type',
307  'timestamp',
308  ],
310  ],
311  'namespace' => [
312  ApiBase::PARAM_ISMULTI => true,
313  ApiBase::PARAM_TYPE => 'namespace',
314  ],
315  'type' => [
316  ApiBase::PARAM_ISMULTI => true,
317  ApiBase::PARAM_DFLT => 'page|subcat|file',
319  'page',
320  'subcat',
321  'file'
322  ]
323  ],
324  'continue' => [
325  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
326  ],
327  'limit' => [
328  ApiBase::PARAM_TYPE => 'limit',
329  ApiBase::PARAM_DFLT => 10,
330  ApiBase::PARAM_MIN => 1,
333  ],
334  'sort' => [
335  ApiBase::PARAM_DFLT => 'sortkey',
337  'sortkey',
338  'timestamp'
339  ]
340  ],
341  'dir' => [
342  ApiBase::PARAM_DFLT => 'ascending',
344  'asc',
345  'desc',
346  // Normalising with other modules
347  'ascending',
348  'descending',
349  'newer',
350  'older',
351  ]
352  ],
353  'start' => [
354  ApiBase::PARAM_TYPE => 'timestamp'
355  ],
356  'end' => [
357  ApiBase::PARAM_TYPE => 'timestamp'
358  ],
359  'starthexsortkey' => null,
360  'endhexsortkey' => null,
361  'startsortkeyprefix' => null,
362  'endsortkeyprefix' => null,
363  'startsortkey' => [
365  ],
366  'endsortkey' => [
368  ],
369  ];
370 
371  if ( $this->getConfig()->get( 'MiserMode' ) ) {
372  $ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [
373  'api-help-param-limited-in-miser-mode',
374  ];
375  }
376 
377  return $ret;
378  }
379 
380  protected function getExamplesMessages() {
381  return [
382  'action=query&list=categorymembers&cmtitle=Category:Physics'
383  => 'apihelp-query+categorymembers-example-simple',
384  'action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info'
385  => 'apihelp-query+categorymembers-example-generator',
386  ];
387  }
388 
389  public function getHelpUrls() {
390  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Categorymembers';
391  }
392 }
ContextSource\getConfig
getConfig()
Definition: ContextSource.php:63
ApiQueryCategoryMembers\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryCategoryMembers.php:290
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
ApiQueryGeneratorBase\encodeParamName
encodeParamName( $paramName)
Overrides ApiBase to prepend 'g' to every generator parameter.
Definition: ApiQueryGeneratorBase.php:71
$rows
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
Definition: hooks.txt:2783
ApiResult\META_TYPE
const META_TYPE
Key for the 'type' metadata item.
Definition: ApiResult.php:108
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1895
ApiQueryBase\addTimestampWhereRange
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
Definition: ApiQueryBase.php:313
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
$ret
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:2005
ApiBase\getTitleOrPageId
getTitleOrPageId( $params, $load=false)
Get a WikiPage object from a title or pageid param, if possible.
Definition: ApiBase.php:926
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:87
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:641
ApiQueryCategoryMembers
A query module to enumerate pages that belong to a category.
Definition: ApiQueryCategoryMembers.php:28
$params
$params
Definition: styleTest.css.php:40
$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
$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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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. '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: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! 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:1993
ApiBase\PARAM_HELP_MSG_APPEND
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition: ApiBase.php:131
ApiQueryBase\addFieldsIf
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
Definition: ApiQueryBase.php:206
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
Collation\singleton
static singleton()
Definition: Collation.php:34
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:84
ApiBase\PARAM_DEPRECATED
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition: ApiBase.php:105
ApiBase\PARAM_MIN
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:99
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:234
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:105
ApiBase\PARAM_MAX
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:90
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
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:534
NS_CATEGORY
const NS_CATEGORY
Definition: Defines.php:88
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:278
ApiQueryCategoryMembers\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryCategoryMembers.php:380
ApiQueryCategoryMembers\run
run( $resultPageSet=null)
Definition: ApiQueryCategoryMembers.php:59
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:749
ApiQueryCategoryMembers\validateHexSortkey
validateHexSortkey( $hexSortkey)
Definition: ApiQueryCategoryMembers.php:50
ApiQueryCategoryMembers\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryCategoryMembers.php:389
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:2066
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:260
ApiQueryCategoryMembers\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryCategoryMembers.php:38
ApiQueryCategoryMembers\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryCategoryMembers.php:30
ApiQueryGeneratorBase
Definition: ApiQueryGeneratorBase.php:26
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:236
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
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
ApiQueryCategoryMembers\executeGenerator
executeGenerator( $resultPageSet)
Execute this module as a generator.
Definition: ApiQueryCategoryMembers.php:42
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:521
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:51
ApiBase\PARAM_MAX2
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition: ApiBase.php:96
ApiQueryCategoryMembers\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryCategoryMembers.php:34
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:227
$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
ApiBase\PARAM_HELP_MSG_PER_VALUE
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
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:482
$type
$type
Definition: testCompression.php:48