MediaWiki  1.29.1
ApiQueryBase.php
Go to the documentation of this file.
1 <?php
29 
37 abstract class ApiQueryBase extends ApiBase {
38 
40 
46  public function __construct( ApiQuery $queryModule, $moduleName, $paramPrefix = '' ) {
47  parent::__construct( $queryModule->getMain(), $moduleName, $paramPrefix );
48  $this->mQueryModule = $queryModule;
49  $this->mDb = null;
50  $this->resetQueryParams();
51  }
52 
53  /************************************************************************/
69  public function getCacheMode( $params ) {
70  return 'private';
71  }
72 
82  public function requestExtraData( $pageSet ) {
83  }
84 
87  /************************************************************************/
96  public function getQuery() {
97  return $this->mQueryModule;
98  }
99 
103  public function getParent() {
104  return $this->getQuery();
105  }
106 
111  protected function getDB() {
112  if ( is_null( $this->mDb ) ) {
113  $this->mDb = $this->getQuery()->getDB();
114  }
115 
116  return $this->mDb;
117  }
118 
127  public function selectNamedDB( $name, $db, $groups ) {
128  $this->mDb = $this->getQuery()->getNamedDB( $name, $db, $groups );
129  return $this->mDb;
130  }
131 
136  protected function getPageSet() {
137  return $this->getQuery()->getPageSet();
138  }
139 
142  /************************************************************************/
150  protected function resetQueryParams() {
151  $this->tables = [];
152  $this->where = [];
153  $this->fields = [];
154  $this->options = [];
155  $this->join_conds = [];
156  }
157 
164  protected function addTables( $tables, $alias = null ) {
165  if ( is_array( $tables ) ) {
166  if ( !is_null( $alias ) ) {
167  ApiBase::dieDebug( __METHOD__, 'Multiple table aliases not supported' );
168  }
169  $this->tables = array_merge( $this->tables, $tables );
170  } else {
171  if ( !is_null( $alias ) ) {
172  $this->tables[$alias] = $tables;
173  } else {
174  $this->tables[] = $tables;
175  }
176  }
177  }
178 
187  protected function addJoinConds( $join_conds ) {
188  if ( !is_array( $join_conds ) ) {
189  ApiBase::dieDebug( __METHOD__, 'Join conditions have to be arrays' );
190  }
191  $this->join_conds = array_merge( $this->join_conds, $join_conds );
192  }
193 
198  protected function addFields( $value ) {
199  if ( is_array( $value ) ) {
200  $this->fields = array_merge( $this->fields, $value );
201  } else {
202  $this->fields[] = $value;
203  }
204  }
205 
212  protected function addFieldsIf( $value, $condition ) {
213  if ( $condition ) {
214  $this->addFields( $value );
215 
216  return true;
217  }
218 
219  return false;
220  }
221 
233  protected function addWhere( $value ) {
234  if ( is_array( $value ) ) {
235  // Sanity check: don't insert empty arrays,
236  // Database::makeList() chokes on them
237  if ( count( $value ) ) {
238  $this->where = array_merge( $this->where, $value );
239  }
240  } else {
241  $this->where[] = $value;
242  }
243  }
244 
251  protected function addWhereIf( $value, $condition ) {
252  if ( $condition ) {
253  $this->addWhere( $value );
254 
255  return true;
256  }
257 
258  return false;
259  }
260 
266  protected function addWhereFld( $field, $value ) {
267  // Use count() to its full documented capabilities to simultaneously
268  // test for null, empty array or empty countable object
269  if ( count( $value ) ) {
270  $this->where[$field] = $value;
271  }
272  }
273 
286  protected function addWhereRange( $field, $dir, $start, $end, $sort = true ) {
287  $isDirNewer = ( $dir === 'newer' );
288  $after = ( $isDirNewer ? '>=' : '<=' );
289  $before = ( $isDirNewer ? '<=' : '>=' );
290  $db = $this->getDB();
291 
292  if ( !is_null( $start ) ) {
293  $this->addWhere( $field . $after . $db->addQuotes( $start ) );
294  }
295 
296  if ( !is_null( $end ) ) {
297  $this->addWhere( $field . $before . $db->addQuotes( $end ) );
298  }
299 
300  if ( $sort ) {
301  $order = $field . ( $isDirNewer ? '' : ' DESC' );
302  // Append ORDER BY
303  $optionOrderBy = isset( $this->options['ORDER BY'] )
304  ? (array)$this->options['ORDER BY']
305  : [];
306  $optionOrderBy[] = $order;
307  $this->addOption( 'ORDER BY', $optionOrderBy );
308  }
309  }
310 
321  protected function addTimestampWhereRange( $field, $dir, $start, $end, $sort = true ) {
322  $db = $this->getDB();
323  $this->addWhereRange( $field, $dir,
324  $db->timestampOrNull( $start ), $db->timestampOrNull( $end ), $sort );
325  }
326 
333  protected function addOption( $name, $value = null ) {
334  if ( is_null( $value ) ) {
335  $this->options[] = $name;
336  } else {
337  $this->options[$name] = $value;
338  }
339  }
340 
358  protected function select( $method, $extraQuery = [], array &$hookData = null ) {
359 
360  $tables = array_merge(
361  $this->tables,
362  isset( $extraQuery['tables'] ) ? (array)$extraQuery['tables'] : []
363  );
364  $fields = array_merge(
365  $this->fields,
366  isset( $extraQuery['fields'] ) ? (array)$extraQuery['fields'] : []
367  );
368  $where = array_merge(
369  $this->where,
370  isset( $extraQuery['where'] ) ? (array)$extraQuery['where'] : []
371  );
372  $options = array_merge(
373  $this->options,
374  isset( $extraQuery['options'] ) ? (array)$extraQuery['options'] : []
375  );
376  $join_conds = array_merge(
377  $this->join_conds,
378  isset( $extraQuery['join_conds'] ) ? (array)$extraQuery['join_conds'] : []
379  );
380 
381  if ( $hookData !== null ) {
382  Hooks::run( 'ApiQueryBaseBeforeQuery',
383  [ $this, &$tables, &$fields, &$where, &$options, &$join_conds, &$hookData ]
384  );
385  }
386 
387  $res = $this->getDB()->select( $tables, $fields, $where, $method, $options, $join_conds );
388 
389  if ( $hookData !== null ) {
390  Hooks::run( 'ApiQueryBaseAfterQuery', [ $this, $res, &$hookData ] );
391  }
392 
393  return $res;
394  }
395 
409  protected function processRow( $row, array &$data, array &$hookData ) {
410  return Hooks::run( 'ApiQueryBaseProcessRow', [ $this, $row, &$data, &$hookData ] );
411  }
412 
418  public function prepareUrlQuerySearchString( $query = null, $protocol = null ) {
419  $db = $this->getDB();
420  if ( !is_null( $query ) || $query != '' ) {
421  if ( is_null( $protocol ) ) {
422  $protocol = 'http://';
423  }
424 
425  $likeQuery = LinkFilter::makeLikeArray( $query, $protocol );
426  if ( !$likeQuery ) {
427  $this->dieWithError( 'apierror-badquery' );
428  }
429 
430  $likeQuery = LinkFilter::keepOneWildcard( $likeQuery );
431 
432  return 'el_index ' . $db->buildLike( $likeQuery );
433  } elseif ( !is_null( $protocol ) ) {
434  return 'el_index ' . $db->buildLike( "$protocol", $db->anyString() );
435  }
436 
437  return null;
438  }
439 
447  public function showHiddenUsersAddBlockInfo( $showBlockInfo ) {
448  $this->addTables( 'ipblocks' );
449  $this->addJoinConds( [
450  'ipblocks' => [ 'LEFT JOIN', 'ipb_user=user_id' ],
451  ] );
452 
453  $this->addFields( 'ipb_deleted' );
454 
455  if ( $showBlockInfo ) {
456  $this->addFields( [
457  'ipb_id',
458  'ipb_by',
459  'ipb_by_text',
460  'ipb_reason',
461  'ipb_expiry',
462  'ipb_timestamp'
463  ] );
464  }
465 
466  // Don't show hidden names
467  if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
468  $this->addWhere( 'ipb_deleted = 0 OR ipb_deleted IS NULL' );
469  }
470  }
471 
474  /************************************************************************/
486  public static function addTitleInfo( &$arr, $title, $prefix = '' ) {
487  $arr[$prefix . 'ns'] = intval( $title->getNamespace() );
488  $arr[$prefix . 'title'] = $title->getPrefixedText();
489  }
490 
497  protected function addPageSubItems( $pageId, $data ) {
498  $result = $this->getResult();
500 
501  return $result->addValue( [ 'query', 'pages', intval( $pageId ) ],
502  $this->getModuleName(),
503  $data );
504  }
505 
514  protected function addPageSubItem( $pageId, $item, $elemname = null ) {
515  if ( is_null( $elemname ) ) {
516  $elemname = $this->getModulePrefix();
517  }
518  $result = $this->getResult();
519  $fit = $result->addValue( [ 'query', 'pages', $pageId,
520  $this->getModuleName() ], null, $item );
521  if ( !$fit ) {
522  return false;
523  }
524  $result->addIndexedTagName( [ 'query', 'pages', $pageId,
525  $this->getModuleName() ], $elemname );
526 
527  return true;
528  }
529 
535  protected function setContinueEnumParameter( $paramName, $paramValue ) {
536  $this->getContinuationManager()->addContinueParam( $this, $paramName, $paramValue );
537  }
538 
549  public function titlePartToKey( $titlePart, $namespace = NS_MAIN ) {
550  $t = Title::makeTitleSafe( $namespace, $titlePart . 'x' );
551  if ( !$t || $t->hasFragment() ) {
552  // Invalid title (e.g. bad chars) or contained a '#'.
553  $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $titlePart ) ] );
554  }
555  if ( $namespace != $t->getNamespace() || $t->isExternal() ) {
556  // This can happen in two cases. First, if you call titlePartToKey with a title part
557  // that looks like a namespace, but with $defaultNamespace = NS_MAIN. It would be very
558  // difficult to handle such a case. Such cases cannot exist and are therefore treated
559  // as invalid user input. The second case is when somebody specifies a title interwiki
560  // prefix.
561  $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $titlePart ) ] );
562  }
563 
564  return substr( $t->getDBkey(), 0, -1 );
565  }
566 
575  public function prefixedTitlePartToKey( $titlePart, $defaultNamespace = NS_MAIN ) {
576  $t = Title::newFromText( $titlePart . 'x', $defaultNamespace );
577  if ( !$t || $t->hasFragment() || $t->isExternal() ) {
578  // Invalid title (e.g. bad chars) or contained a '#'.
579  $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $titlePart ) ] );
580  }
581 
582  return [ $t->getNamespace(), substr( $t->getDBkey(), 0, -1 ) ];
583  }
584 
589  public function validateSha1Hash( $hash ) {
590  return (bool)preg_match( '/^[a-f0-9]{40}$/', $hash );
591  }
592 
597  public function validateSha1Base36Hash( $hash ) {
598  return (bool)preg_match( '/^[a-z0-9]{31}$/', $hash );
599  }
600 
606  public function userCanSeeRevDel() {
607  return $this->getUser()->isAllowedAny(
608  'deletedhistory',
609  'deletedtext',
610  'suppressrevision',
611  'viewsuppressed'
612  );
613  }
614 
616 }
ApiQueryBase\validateSha1Base36Hash
validateSha1Base36Hash( $hash)
Definition: ApiQueryBase.php:597
ApiQueryBase\showHiddenUsersAddBlockInfo
showHiddenUsersAddBlockInfo( $showBlockInfo)
Filters hidden users (where the user doesn't have the right to view them) Also adds relevant block in...
Definition: ApiQueryBase.php:447
ApiQueryBase\addPageSubItems
addPageSubItems( $pageId, $data)
Add a sub-element under the page element with the given page ID.
Definition: ApiQueryBase.php:497
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:265
ApiQueryBase\processRow
processRow( $row, array &$data, array &$hookData)
Call the ApiQueryBaseProcessRow hook.
Definition: ApiQueryBase.php:409
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:198
ApiQuery
This is the main query class.
Definition: ApiQuery.php:40
ApiQueryBase\resetQueryParams
resetQueryParams()
Blank the internal arrays with query parameters.
Definition: ApiQueryBase.php:150
captcha-old.count
count
Definition: captcha-old.py:225
ApiQueryBase\getParent
getParent()
Definition: ApiQueryBase.php:103
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1796
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:321
LinkFilter\keepOneWildcard
static keepOneWildcard( $arr)
Filters an array returned by makeLikeArray(), removing everything past first pattern placeholder.
Definition: LinkFilter.php:178
$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. 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: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:1954
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:610
ApiQueryBase\getQuery
getQuery()
Get the main Query module.
Definition: ApiQueryBase.php:96
ApiQueryBase\$fields
$fields
Definition: ApiQueryBase.php:39
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$params
$params
Definition: styleTest.css.php:40
$res
$res
Definition: database.txt:21
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
Wikimedia\Rdbms\ResultWrapper
Result wrapper for grabbing data queried from an IDatabase object.
Definition: ResultWrapper.php:24
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:333
ContextSource\getUser
getUser()
Get the User object.
Definition: ContextSource.php:133
ApiQueryBase\$options
$options
Definition: ApiQueryBase.php:39
ApiQueryBase\addFieldsIf
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
Definition: ApiQueryBase.php:212
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:35
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:41
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:40
NS_MAIN
const NS_MAIN
Definition: Defines.php:62
$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:1572
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:934
ApiQueryBase
This is a base class for all Query modules.
Definition: ApiQueryBase.php:37
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:111
LinkFilter\makeLikeArray
static makeLikeArray( $filterEntry, $protocol='http://')
Make an array to be used for calls to Database::buildLike(), which will match the specified string.
Definition: LinkFilter.php:95
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:164
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:358
ApiQueryBase\$mDb
$mDb
Definition: ApiQueryBase.php:39
$dir
$dir
Definition: Autoload.php:8
$sort
$sort
Definition: profileinfo.php:323
ApiQueryBase\$where
$where
Definition: ApiQueryBase.php:39
ApiBase\getModulePrefix
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:498
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:286
ApiBase\getContinuationManager
getContinuationManager()
Get the continuation manager.
Definition: ApiBase.php:650
Title\makeTitleSafe
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:538
ApiResult\setIndexedTagName
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
$value
$value
Definition: styleTest.css.php:45
ApiQueryBase\requestExtraData
requestExtraData( $pageSet)
Override this method to request extra fields from the pageSet using $pageSet->requestField('fieldName...
Definition: ApiQueryBase.php:82
options
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing options(say) and put it in one place. Instead of having little title-reversing if-blocks spread all over the codebase in showAnArticle
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:187
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1657
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:266
ApiQueryBase\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryBase.php:69
ApiQueryBase\prefixedTitlePartToKey
prefixedTitlePartToKey( $titlePart, $defaultNamespace=NS_MAIN)
Convert an input title or title prefix into a namespace constant and dbkey.
Definition: ApiQueryBase.php:575
ApiQueryBase\getPageSet
getPageSet()
Get the PageSet object to work on.
Definition: ApiQueryBase.php:136
ApiQueryBase\selectNamedDB
selectNamedDB( $name, $db, $groups)
Selects the query database connection with the given name.
Definition: ApiQueryBase.php:127
ApiQueryBase\$join_conds
$join_conds
Definition: ApiQueryBase.php:39
ApiQueryBase\$tables
$tables
Definition: ApiQueryBase.php:39
ApiQueryBase\__construct
__construct(ApiQuery $queryModule, $moduleName, $paramPrefix='')
Definition: ApiQueryBase.php:46
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:490
ApiQueryBase\$mQueryModule
$mQueryModule
Definition: ApiQueryBase.php:39
ApiBase\getMain
getMain()
Get the main module.
Definition: ApiBase.php:506
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:233
$t
$t
Definition: testCompression.php:67
ApiQueryBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
Definition: ApiQueryBase.php:535
ApiQueryBase\prepareUrlQuerySearchString
prepareUrlQuerySearchString( $query=null, $protocol=null)
Definition: ApiQueryBase.php:418
ApiQueryBase\titlePartToKey
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
Definition: ApiQueryBase.php:549
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
ApiQueryBase\userCanSeeRevDel
userCanSeeRevDel()
Check whether the current user has permission to view revision-deleted fields.
Definition: ApiQueryBase.php:606
ApiQueryBase\addPageSubItem
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
Definition: ApiQueryBase.php:514
ApiBase\dieDebug
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:1962
ApiQueryBase\addWhereIf
addWhereIf( $value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
Definition: ApiQueryBase.php:251
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:486
array
the array() calling protocol came about after MediaWiki 1.4rc1.
ApiQueryBase\validateSha1Hash
validateSha1Hash( $hash)
Definition: ApiQueryBase.php:589