MediaWiki  REL1_31
ApiQueryBase.php
Go to the documentation of this file.
1 <?php
25 
33 abstract class ApiQueryBase extends ApiBase {
34 
36 
42  public function __construct( ApiQuery $queryModule, $moduleName, $paramPrefix = '' ) {
43  parent::__construct( $queryModule->getMain(), $moduleName, $paramPrefix );
44  $this->mQueryModule = $queryModule;
45  $this->mDb = null;
46  $this->resetQueryParams();
47  }
48 
49  /************************************************************************/
65  public function getCacheMode( $params ) {
66  return 'private';
67  }
68 
78  public function requestExtraData( $pageSet ) {
79  }
80 
83  /************************************************************************/
92  public function getQuery() {
93  return $this->mQueryModule;
94  }
95 
97  public function getParent() {
98  return $this->getQuery();
99  }
100 
105  protected function getDB() {
106  if ( is_null( $this->mDb ) ) {
107  $this->mDb = $this->getQuery()->getDB();
108  }
109 
110  return $this->mDb;
111  }
112 
121  public function selectNamedDB( $name, $db, $groups ) {
122  $this->mDb = $this->getQuery()->getNamedDB( $name, $db, $groups );
123  return $this->mDb;
124  }
125 
130  protected function getPageSet() {
131  return $this->getQuery()->getPageSet();
132  }
133 
136  /************************************************************************/
144  protected function resetQueryParams() {
145  $this->tables = [];
146  $this->where = [];
147  $this->fields = [];
148  $this->options = [];
149  $this->join_conds = [];
150  }
151 
158  protected function addTables( $tables, $alias = null ) {
159  if ( is_array( $tables ) ) {
160  if ( !is_null( $alias ) ) {
161  ApiBase::dieDebug( __METHOD__, 'Multiple table aliases not supported' );
162  }
163  $this->tables = array_merge( $this->tables, $tables );
164  } else {
165  if ( !is_null( $alias ) ) {
166  $this->tables[$alias] = $tables;
167  } else {
168  $this->tables[] = $tables;
169  }
170  }
171  }
172 
181  protected function addJoinConds( $join_conds ) {
182  if ( !is_array( $join_conds ) ) {
183  ApiBase::dieDebug( __METHOD__, 'Join conditions have to be arrays' );
184  }
185  $this->join_conds = array_merge( $this->join_conds, $join_conds );
186  }
187 
192  protected function addFields( $value ) {
193  if ( is_array( $value ) ) {
194  $this->fields = array_merge( $this->fields, $value );
195  } else {
196  $this->fields[] = $value;
197  }
198  }
199 
206  protected function addFieldsIf( $value, $condition ) {
207  if ( $condition ) {
208  $this->addFields( $value );
209 
210  return true;
211  }
212 
213  return false;
214  }
215 
227  protected function addWhere( $value ) {
228  if ( is_array( $value ) ) {
229  // Sanity check: don't insert empty arrays,
230  // Database::makeList() chokes on them
231  if ( count( $value ) ) {
232  $this->where = array_merge( $this->where, $value );
233  }
234  } else {
235  $this->where[] = $value;
236  }
237  }
238 
245  protected function addWhereIf( $value, $condition ) {
246  if ( $condition ) {
247  $this->addWhere( $value );
248 
249  return true;
250  }
251 
252  return false;
253  }
254 
260  protected function addWhereFld( $field, $value ) {
261  if ( $value !== null && !( is_array( $value ) && !$value ) ) {
262  $this->where[$field] = $value;
263  }
264  }
265 
278  protected function addWhereRange( $field, $dir, $start, $end, $sort = true ) {
279  $isDirNewer = ( $dir === 'newer' );
280  $after = ( $isDirNewer ? '>=' : '<=' );
281  $before = ( $isDirNewer ? '<=' : '>=' );
282  $db = $this->getDB();
283 
284  if ( !is_null( $start ) ) {
285  $this->addWhere( $field . $after . $db->addQuotes( $start ) );
286  }
287 
288  if ( !is_null( $end ) ) {
289  $this->addWhere( $field . $before . $db->addQuotes( $end ) );
290  }
291 
292  if ( $sort ) {
293  $order = $field . ( $isDirNewer ? '' : ' DESC' );
294  // Append ORDER BY
295  $optionOrderBy = isset( $this->options['ORDER BY'] )
296  ? (array)$this->options['ORDER BY']
297  : [];
298  $optionOrderBy[] = $order;
299  $this->addOption( 'ORDER BY', $optionOrderBy );
300  }
301  }
302 
313  protected function addTimestampWhereRange( $field, $dir, $start, $end, $sort = true ) {
314  $db = $this->getDB();
315  $this->addWhereRange( $field, $dir,
316  $db->timestampOrNull( $start ), $db->timestampOrNull( $end ), $sort );
317  }
318 
325  protected function addOption( $name, $value = null ) {
326  if ( is_null( $value ) ) {
327  $this->options[] = $name;
328  } else {
329  $this->options[$name] = $value;
330  }
331  }
332 
350  protected function select( $method, $extraQuery = [], array &$hookData = null ) {
351  $tables = array_merge(
352  $this->tables,
353  isset( $extraQuery['tables'] ) ? (array)$extraQuery['tables'] : []
354  );
355  $fields = array_merge(
356  $this->fields,
357  isset( $extraQuery['fields'] ) ? (array)$extraQuery['fields'] : []
358  );
359  $where = array_merge(
360  $this->where,
361  isset( $extraQuery['where'] ) ? (array)$extraQuery['where'] : []
362  );
363  $options = array_merge(
364  $this->options,
365  isset( $extraQuery['options'] ) ? (array)$extraQuery['options'] : []
366  );
367  $join_conds = array_merge(
368  $this->join_conds,
369  isset( $extraQuery['join_conds'] ) ? (array)$extraQuery['join_conds'] : []
370  );
371 
372  if ( $hookData !== null ) {
373  Hooks::run( 'ApiQueryBaseBeforeQuery',
374  [ $this, &$tables, &$fields, &$where, &$options, &$join_conds, &$hookData ]
375  );
376  }
377 
378  $res = $this->getDB()->select( $tables, $fields, $where, $method, $options, $join_conds );
379 
380  if ( $hookData !== null ) {
381  Hooks::run( 'ApiQueryBaseAfterQuery', [ $this, $res, &$hookData ] );
382  }
383 
384  return $res;
385  }
386 
400  protected function processRow( $row, array &$data, array &$hookData ) {
401  return Hooks::run( 'ApiQueryBaseProcessRow', [ $this, $row, &$data, &$hookData ] );
402  }
403 
409  public function prepareUrlQuerySearchString( $query = null, $protocol = null ) {
410  $db = $this->getDB();
411  if ( !is_null( $query ) || $query != '' ) {
412  if ( is_null( $protocol ) ) {
413  $protocol = 'http://';
414  }
415 
416  $likeQuery = LinkFilter::makeLikeArray( $query, $protocol );
417  if ( !$likeQuery ) {
418  $this->dieWithError( 'apierror-badquery' );
419  }
420 
421  $likeQuery = LinkFilter::keepOneWildcard( $likeQuery );
422 
423  return 'el_index ' . $db->buildLike( $likeQuery );
424  } elseif ( !is_null( $protocol ) ) {
425  return 'el_index ' . $db->buildLike( "$protocol", $db->anyString() );
426  }
427 
428  return null;
429  }
430 
438  public function showHiddenUsersAddBlockInfo( $showBlockInfo ) {
439  $this->addTables( 'ipblocks' );
440  $this->addJoinConds( [
441  'ipblocks' => [ 'LEFT JOIN', 'ipb_user=user_id' ],
442  ] );
443 
444  $this->addFields( 'ipb_deleted' );
445 
446  if ( $showBlockInfo ) {
447  $this->addFields( [
448  'ipb_id',
449  'ipb_expiry',
450  'ipb_timestamp'
451  ] );
452  $actorQuery = ActorMigration::newMigration()->getJoin( 'ipb_by' );
453  $this->addTables( $actorQuery['tables'] );
454  $this->addFields( $actorQuery['fields'] );
455  $this->addJoinConds( $actorQuery['joins'] );
456  $commentQuery = CommentStore::getStore()->getJoin( 'ipb_reason' );
457  $this->addTables( $commentQuery['tables'] );
458  $this->addFields( $commentQuery['fields'] );
459  $this->addJoinConds( $commentQuery['joins'] );
460  }
461 
462  // Don't show hidden names
463  if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
464  $this->addWhere( 'ipb_deleted = 0 OR ipb_deleted IS NULL' );
465  }
466  }
467 
470  /************************************************************************/
482  public static function addTitleInfo( &$arr, $title, $prefix = '' ) {
483  $arr[$prefix . 'ns'] = intval( $title->getNamespace() );
484  $arr[$prefix . 'title'] = $title->getPrefixedText();
485  }
486 
493  protected function addPageSubItems( $pageId, $data ) {
494  $result = $this->getResult();
496 
497  return $result->addValue( [ 'query', 'pages', intval( $pageId ) ],
498  $this->getModuleName(),
499  $data );
500  }
501 
510  protected function addPageSubItem( $pageId, $item, $elemname = null ) {
511  if ( is_null( $elemname ) ) {
512  $elemname = $this->getModulePrefix();
513  }
514  $result = $this->getResult();
515  $fit = $result->addValue( [ 'query', 'pages', $pageId,
516  $this->getModuleName() ], null, $item );
517  if ( !$fit ) {
518  return false;
519  }
520  $result->addIndexedTagName( [ 'query', 'pages', $pageId,
521  $this->getModuleName() ], $elemname );
522 
523  return true;
524  }
525 
531  protected function setContinueEnumParameter( $paramName, $paramValue ) {
532  $this->getContinuationManager()->addContinueParam( $this, $paramName, $paramValue );
533  }
534 
545  public function titlePartToKey( $titlePart, $namespace = NS_MAIN ) {
546  $t = Title::makeTitleSafe( $namespace, $titlePart . 'x' );
547  if ( !$t || $t->hasFragment() ) {
548  // Invalid title (e.g. bad chars) or contained a '#'.
549  $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $titlePart ) ] );
550  }
551  if ( $namespace != $t->getNamespace() || $t->isExternal() ) {
552  // This can happen in two cases. First, if you call titlePartToKey with a title part
553  // that looks like a namespace, but with $defaultNamespace = NS_MAIN. It would be very
554  // difficult to handle such a case. Such cases cannot exist and are therefore treated
555  // as invalid user input. The second case is when somebody specifies a title interwiki
556  // prefix.
557  $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $titlePart ) ] );
558  }
559 
560  return substr( $t->getDBkey(), 0, -1 );
561  }
562 
571  public function prefixedTitlePartToKey( $titlePart, $defaultNamespace = NS_MAIN ) {
572  $t = Title::newFromText( $titlePart . 'x', $defaultNamespace );
573  if ( !$t || $t->hasFragment() || $t->isExternal() ) {
574  // Invalid title (e.g. bad chars) or contained a '#'.
575  $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $titlePart ) ] );
576  }
577 
578  return [ $t->getNamespace(), substr( $t->getDBkey(), 0, -1 ) ];
579  }
580 
585  public function validateSha1Hash( $hash ) {
586  return (bool)preg_match( '/^[a-f0-9]{40}$/', $hash );
587  }
588 
593  public function validateSha1Base36Hash( $hash ) {
594  return (bool)preg_match( '/^[a-z0-9]{31}$/', $hash );
595  }
596 
602  public function userCanSeeRevDel() {
603  return $this->getUser()->isAllowedAny(
604  'deletedhistory',
605  'deletedtext',
606  'suppressrevision',
607  'viewsuppressed'
608  );
609  }
610 
612 }
ApiQueryBase\validateSha1Base36Hash
validateSha1Base36Hash( $hash)
Definition: ApiQueryBase.php:593
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:438
ApiQueryBase\addPageSubItems
addPageSubItems( $pageId, $data)
Add a sub-element under the page element with the given page ID.
Definition: ApiQueryBase.php:493
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:273
ApiQueryBase\processRow
processRow( $row, array &$data, array &$hookData)
Call the ApiQueryBaseProcessRow hook.
Definition: ApiQueryBase.php:400
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
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
ApiQueryBase\resetQueryParams
resetQueryParams()
Blank the internal arrays with query parameters.
Definition: ApiQueryBase.php:144
array
the array() calling protocol came about after MediaWiki 1.4rc1.
ApiQueryBase\getParent
getParent()
@inheritDoc
Definition: ApiQueryBase.php:97
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
LinkFilter\keepOneWildcard
static keepOneWildcard( $arr)
Filters an array returned by makeLikeArray(), removing everything past first pattern placeholder.
Definition: LinkFilter.php:178
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:641
ApiQueryBase\getQuery
getQuery()
Get the main Query module.
Definition: ApiQueryBase.php:92
ApiQueryBase\$fields
$fields
Definition: ApiQueryBase.php:35
$params
$params
Definition: styleTest.css.php:40
$res
$res
Definition: database.txt:21
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: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
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
ActorMigration\newMigration
static newMigration()
Static constructor.
Definition: ActorMigration.php:89
ApiQueryBase\$options
$options
Definition: ApiQueryBase.php:35
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
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:37
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:38
NS_MAIN
const NS_MAIN
Definition: Defines.php:74
ApiQueryBase
This is a base class for all Query modules.
Definition: ApiQueryBase.php:33
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:105
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: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
ApiQueryBase\$mDb
$mDb
Definition: ApiQueryBase.php:35
$sort
$sort
Definition: profileinfo.php:317
ApiQueryBase\$where
$where
Definition: ApiQueryBase.php:35
ApiBase\getModulePrefix
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:529
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
ApiBase\getContinuationManager
getContinuationManager()
Get the continuation manager.
Definition: ApiBase.php:681
Title\makeTitleSafe
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:562
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
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\requestExtraData
requestExtraData( $pageSet)
Override this method to request extra fields from the pageSet using $pageSet->requestField('fieldName...
Definition: ApiQueryBase.php:78
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:181
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1643
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:260
ApiQueryBase\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryBase.php:65
ApiQueryBase\prefixedTitlePartToKey
prefixedTitlePartToKey( $titlePart, $defaultNamespace=NS_MAIN)
Convert an input title or title prefix into a namespace constant and dbkey.
Definition: ApiQueryBase.php:571
ApiQueryBase\getPageSet
getPageSet()
Get the PageSet object to work on.
Definition: ApiQueryBase.php:130
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
ApiQueryBase\selectNamedDB
selectNamedDB( $name, $db, $groups)
Selects the query database connection with the given name.
Definition: ApiQueryBase.php:121
ApiQueryBase\$join_conds
$join_conds
Definition: ApiQueryBase.php:35
ApiQueryBase\$tables
$tables
Definition: ApiQueryBase.php:35
ApiQueryBase\__construct
__construct(ApiQuery $queryModule, $moduleName, $paramPrefix='')
Definition: ApiQueryBase.php:42
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:521
ApiQueryBase\$mQueryModule
$mQueryModule
Definition: ApiQueryBase.php:35
ApiBase\getMain
getMain()
Get the main module.
Definition: ApiBase.php:537
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:227
$t
$t
Definition: testCompression.php:69
ApiQueryBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
Definition: ApiQueryBase.php:531
$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
ApiQueryBase\prepareUrlQuerySearchString
prepareUrlQuerySearchString( $query=null, $protocol=null)
Definition: ApiQueryBase.php:409
ApiQueryBase\titlePartToKey
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
Definition: ApiQueryBase.php:545
CommentStore\getStore
static getStore()
Definition: CommentStore.php:130
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
ApiQueryBase\userCanSeeRevDel
userCanSeeRevDel()
Check whether the current user has permission to view revision-deleted fields.
Definition: ApiQueryBase.php:602
ApiQueryBase\addPageSubItem
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
Definition: ApiQueryBase.php:510
ApiBase\dieDebug
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:2078
ApiQueryBase\addWhereIf
addWhereIf( $value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
Definition: ApiQueryBase.php:245
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:482
ApiQueryBase\validateSha1Hash
validateSha1Hash( $hash)
Definition: ApiQueryBase.php:585