MediaWiki  master
ApiQuery.php
Go to the documentation of this file.
1 <?php
24 
36 class ApiQuery extends ApiBase {
37 
42  private static $QueryPropModules = [
43  'categories' => ApiQueryCategories::class,
44  'categoryinfo' => ApiQueryCategoryInfo::class,
45  'contributors' => ApiQueryContributors::class,
46  'deletedrevisions' => ApiQueryDeletedRevisions::class,
47  'duplicatefiles' => ApiQueryDuplicateFiles::class,
48  'extlinks' => ApiQueryExternalLinks::class,
49  'fileusage' => ApiQueryBacklinksprop::class,
50  'images' => ApiQueryImages::class,
51  'imageinfo' => ApiQueryImageInfo::class,
52  'info' => ApiQueryInfo::class,
53  'links' => ApiQueryLinks::class,
54  'linkshere' => ApiQueryBacklinksprop::class,
55  'iwlinks' => ApiQueryIWLinks::class,
56  'langlinks' => ApiQueryLangLinks::class,
57  'pageprops' => ApiQueryPageProps::class,
58  'redirects' => ApiQueryBacklinksprop::class,
59  'revisions' => ApiQueryRevisions::class,
60  'stashimageinfo' => ApiQueryStashImageInfo::class,
61  'templates' => ApiQueryLinks::class,
62  'transcludedin' => ApiQueryBacklinksprop::class,
63  ];
64 
69  private static $QueryListModules = [
70  'allcategories' => ApiQueryAllCategories::class,
71  'alldeletedrevisions' => ApiQueryAllDeletedRevisions::class,
72  'allfileusages' => ApiQueryAllLinks::class,
73  'allimages' => ApiQueryAllImages::class,
74  'alllinks' => ApiQueryAllLinks::class,
75  'allpages' => ApiQueryAllPages::class,
76  'allredirects' => ApiQueryAllLinks::class,
77  'allrevisions' => ApiQueryAllRevisions::class,
78  'mystashedfiles' => ApiQueryMyStashedFiles::class,
79  'alltransclusions' => ApiQueryAllLinks::class,
80  'allusers' => ApiQueryAllUsers::class,
81  'backlinks' => ApiQueryBacklinks::class,
82  'blocks' => ApiQueryBlocks::class,
83  'categorymembers' => ApiQueryCategoryMembers::class,
84  'deletedrevs' => ApiQueryDeletedrevs::class,
85  'embeddedin' => ApiQueryBacklinks::class,
86  'exturlusage' => ApiQueryExtLinksUsage::class,
87  'filearchive' => ApiQueryFilearchive::class,
88  'imageusage' => ApiQueryBacklinks::class,
89  'iwbacklinks' => ApiQueryIWBacklinks::class,
90  'langbacklinks' => ApiQueryLangBacklinks::class,
91  'logevents' => ApiQueryLogEvents::class,
92  'pageswithprop' => ApiQueryPagesWithProp::class,
93  'pagepropnames' => ApiQueryPagePropNames::class,
94  'prefixsearch' => ApiQueryPrefixSearch::class,
95  'protectedtitles' => ApiQueryProtectedTitles::class,
96  'querypage' => ApiQueryQueryPage::class,
97  'random' => ApiQueryRandom::class,
98  'recentchanges' => ApiQueryRecentChanges::class,
99  'search' => ApiQuerySearch::class,
100  'tags' => ApiQueryTags::class,
101  'usercontribs' => ApiQueryUserContribs::class,
102  'users' => ApiQueryUsers::class,
103  'watchlist' => ApiQueryWatchlist::class,
104  'watchlistraw' => ApiQueryWatchlistRaw::class,
105  ];
106 
111  private static $QueryMetaModules = [
112  'allmessages' => ApiQueryAllMessages::class,
113  'authmanagerinfo' => ApiQueryAuthManagerInfo::class,
114  'siteinfo' => ApiQuerySiteinfo::class,
115  'userinfo' => ApiQueryUserInfo::class,
116  'filerepoinfo' => ApiQueryFileRepoInfo::class,
117  'tokens' => ApiQueryTokens::class,
118  ];
119 
123  private $mPageSet;
124 
125  private $mParams;
126  private $mNamedDB = [];
127  private $mModuleMgr;
128 
133  public function __construct( ApiMain $main, $action ) {
134  parent::__construct( $main, $action );
135 
136  $this->mModuleMgr = new ApiModuleManager( $this );
137 
138  // Allow custom modules to be added in LocalSettings.php
139  $config = $this->getConfig();
140  $this->mModuleMgr->addModules( self::$QueryPropModules, 'prop' );
141  $this->mModuleMgr->addModules( $config->get( 'APIPropModules' ), 'prop' );
142  $this->mModuleMgr->addModules( self::$QueryListModules, 'list' );
143  $this->mModuleMgr->addModules( $config->get( 'APIListModules' ), 'list' );
144  $this->mModuleMgr->addModules( self::$QueryMetaModules, 'meta' );
145  $this->mModuleMgr->addModules( $config->get( 'APIMetaModules' ), 'meta' );
146 
147  Hooks::run( 'ApiQuery::moduleManager', [ $this->mModuleMgr ] );
148 
149  // Create PageSet that will process titles/pageids/revids/generator
150  $this->mPageSet = new ApiPageSet( $this );
151  }
152 
157  public function getModuleManager() {
158  return $this->mModuleMgr;
159  }
160 
171  public function getNamedDB( $name, $db, $groups ) {
172  if ( !array_key_exists( $name, $this->mNamedDB ) ) {
173  $this->mNamedDB[$name] = wfGetDB( $db, $groups );
174  }
175 
176  return $this->mNamedDB[$name];
177  }
178 
183  public function getPageSet() {
184  return $this->mPageSet;
185  }
186 
190  public function getCustomPrinter() {
191  // If &exportnowrap is set, use the raw formatter
192  if ( $this->getParameter( 'export' ) &&
193  $this->getParameter( 'exportnowrap' )
194  ) {
195  return new ApiFormatRaw( $this->getMain(),
196  $this->getMain()->createPrinterByName( 'xml' ) );
197  } else {
198  return null;
199  }
200  }
201 
212  public function execute() {
213  $this->mParams = $this->extractRequestParams();
214 
215  // Instantiate requested modules
216  $allModules = [];
217  $this->instantiateModules( $allModules, 'prop' );
218  $propModules = array_keys( $allModules );
219  $this->instantiateModules( $allModules, 'list' );
220  $this->instantiateModules( $allModules, 'meta' );
221 
222  // Filter modules based on continue parameter
223  $continuationManager = new ApiContinuationManager( $this, $allModules, $propModules );
224  $this->setContinuationManager( $continuationManager );
225  $modules = $continuationManager->getRunModules();
226 
227  if ( !$continuationManager->isGeneratorDone() ) {
228  // Query modules may optimize data requests through the $this->getPageSet()
229  // object by adding extra fields from the page table.
230  foreach ( $modules as $module ) {
231  $module->requestExtraData( $this->mPageSet );
232  }
233  // Populate page/revision information
234  $this->mPageSet->execute();
235  // Record page information (title, namespace, if exists, etc)
236  $this->outputGeneralPageInfo();
237  } else {
238  $this->mPageSet->executeDryRun();
239  }
240 
241  $cacheMode = $this->mPageSet->getCacheMode();
242 
243  // Execute all unfinished modules
245  foreach ( $modules as $module ) {
246  $params = $module->extractRequestParams();
247  $cacheMode = $this->mergeCacheMode(
248  $cacheMode, $module->getCacheMode( $params ) );
249  $module->execute();
250  Hooks::run( 'APIQueryAfterExecute', [ &$module ] );
251  }
252 
253  // Set the cache mode
254  $this->getMain()->setCacheMode( $cacheMode );
255 
256  // Write the continuation data into the result
257  $this->setContinuationManager( null );
258  if ( $this->mParams['rawcontinue'] ) {
259  $data = $continuationManager->getRawNonContinuation();
260  if ( $data ) {
261  $this->getResult()->addValue( null, 'query-noncontinue', $data,
263  }
264  $data = $continuationManager->getRawContinuation();
265  if ( $data ) {
266  $this->getResult()->addValue( null, 'query-continue', $data,
268  }
269  } else {
270  $continuationManager->setContinuationIntoResult( $this->getResult() );
271  }
272  }
273 
283  protected function mergeCacheMode( $cacheMode, $modCacheMode ) {
284  if ( $modCacheMode === 'anon-public-user-private' ) {
285  if ( $cacheMode !== 'private' ) {
286  $cacheMode = 'anon-public-user-private';
287  }
288  } elseif ( $modCacheMode === 'public' ) {
289  // do nothing, if it's public already it will stay public
290  } else {
291  $cacheMode = 'private';
292  }
293 
294  return $cacheMode;
295  }
296 
302  private function instantiateModules( &$modules, $param ) {
303  $wasPosted = $this->getRequest()->wasPosted();
304  if ( isset( $this->mParams[$param] ) ) {
305  foreach ( $this->mParams[$param] as $moduleName ) {
306  $instance = $this->mModuleMgr->getModule( $moduleName, $param );
307  if ( $instance === null ) {
308  ApiBase::dieDebug( __METHOD__, 'Error instantiating module' );
309  }
310  if ( !$wasPosted && $instance->mustBePosted() ) {
311  $this->dieWithErrorOrDebug( [ 'apierror-mustbeposted', $moduleName ] );
312  }
313  // Ignore duplicates. TODO 2.0: die()?
314  if ( !array_key_exists( $moduleName, $modules ) ) {
315  $modules[$moduleName] = $instance;
316  }
317  }
318  }
319  }
320 
326  private function outputGeneralPageInfo() {
327  $pageSet = $this->getPageSet();
328  $result = $this->getResult();
329 
330  // We can't really handle max-result-size failure here, but we need to
331  // check anyway in case someone set the limit stupidly low.
332  $fit = true;
333 
334  $values = $pageSet->getNormalizedTitlesAsResult( $result );
335  if ( $values ) {
336  $fit = $fit && $result->addValue( 'query', 'normalized', $values );
337  }
338  $values = $pageSet->getConvertedTitlesAsResult( $result );
339  if ( $values ) {
340  $fit = $fit && $result->addValue( 'query', 'converted', $values );
341  }
342  $values = $pageSet->getInterwikiTitlesAsResult( $result, $this->mParams['iwurl'] );
343  if ( $values ) {
344  $fit = $fit && $result->addValue( 'query', 'interwiki', $values );
345  }
346  $values = $pageSet->getRedirectTitlesAsResult( $result );
347  if ( $values ) {
348  $fit = $fit && $result->addValue( 'query', 'redirects', $values );
349  }
350  $values = $pageSet->getMissingRevisionIDsAsResult( $result );
351  if ( $values ) {
352  $fit = $fit && $result->addValue( 'query', 'badrevids', $values );
353  }
354 
355  // Page elements
356  $pages = [];
357 
358  // Report any missing titles
359  foreach ( $pageSet->getMissingTitles() as $fakeId => $title ) {
360  $vals = [];
362  $vals['missing'] = true;
363  if ( $title->isKnown() ) {
364  $vals['known'] = true;
365  }
366  $pages[$fakeId] = $vals;
367  }
368  // Report any invalid titles
369  foreach ( $pageSet->getInvalidTitlesAndReasons() as $fakeId => $data ) {
370  $pages[$fakeId] = $data + [ 'invalid' => true ];
371  }
372  // Report any missing page ids
373  foreach ( $pageSet->getMissingPageIDs() as $pageid ) {
374  $pages[$pageid] = [
375  'pageid' => $pageid,
376  'missing' => true,
377  ];
378  }
379  // Report special pages
381  foreach ( $pageSet->getSpecialTitles() as $fakeId => $title ) {
382  $vals = [];
384  $vals['special'] = true;
385  if ( !$title->isKnown() ) {
386  $vals['missing'] = true;
387  }
388  $pages[$fakeId] = $vals;
389  }
390 
391  // Output general page information for found titles
392  foreach ( $pageSet->getGoodTitles() as $pageid => $title ) {
393  $vals = [];
394  $vals['pageid'] = $pageid;
396  $pages[$pageid] = $vals;
397  }
398 
399  if ( count( $pages ) ) {
400  $pageSet->populateGeneratorData( $pages );
401  ApiResult::setArrayType( $pages, 'BCarray' );
402 
403  if ( $this->mParams['indexpageids'] ) {
404  $pageIDs = array_keys( ApiResult::stripMetadataNonRecursive( $pages ) );
405  // json treats all map keys as strings - converting to match
406  $pageIDs = array_map( 'strval', $pageIDs );
407  ApiResult::setIndexedTagName( $pageIDs, 'id' );
408  $fit = $fit && $result->addValue( 'query', 'pageids', $pageIDs );
409  }
410 
411  ApiResult::setIndexedTagName( $pages, 'page' );
412  $fit = $fit && $result->addValue( 'query', 'pages', $pages );
413  }
414 
415  if ( !$fit ) {
416  $this->dieWithError( 'apierror-badconfig-resulttoosmall', 'badconfig' );
417  }
418 
419  if ( $this->mParams['export'] ) {
420  $this->doExport( $pageSet, $result );
421  }
422  }
423 
428  private function doExport( $pageSet, $result ) {
429  $exportTitles = [];
430  $titles = $pageSet->getGoodTitles();
431  if ( count( $titles ) ) {
432  $user = $this->getUser();
434  foreach ( $titles as $title ) {
435  if ( $title->userCan( 'read', $user ) ) {
436  $exportTitles[] = $title;
437  }
438  }
439  }
440 
441  $exporter = new WikiExporter( $this->getDB() );
442  $sink = new DumpStringOutput;
443  $exporter->setOutputSink( $sink );
444  $exporter->openStream();
445  foreach ( $exportTitles as $title ) {
446  $exporter->pageByTitle( $title );
447  }
448  $exporter->closeStream();
449 
450  // Don't check the size of exported stuff
451  // It's not continuable, so it would cause more
452  // problems than it'd solve
453  if ( $this->mParams['exportnowrap'] ) {
454  $result->reset();
455  // Raw formatter will handle this
456  $result->addValue( null, 'text', $sink, ApiResult::NO_SIZE_CHECK );
457  $result->addValue( null, 'mime', 'text/xml', ApiResult::NO_SIZE_CHECK );
458  $result->addValue( null, 'filename', 'export.xml', ApiResult::NO_SIZE_CHECK );
459  } else {
460  $result->addValue( 'query', 'export', $sink, ApiResult::NO_SIZE_CHECK );
461  $result->addValue( 'query', ApiResult::META_BC_SUBELEMENTS, [ 'export' ] );
462  }
463  }
464 
465  public function getAllowedParams( $flags = 0 ) {
466  $result = [
467  'prop' => [
468  ApiBase::PARAM_ISMULTI => true,
469  ApiBase::PARAM_TYPE => 'submodule',
470  ],
471  'list' => [
472  ApiBase::PARAM_ISMULTI => true,
473  ApiBase::PARAM_TYPE => 'submodule',
474  ],
475  'meta' => [
476  ApiBase::PARAM_ISMULTI => true,
477  ApiBase::PARAM_TYPE => 'submodule',
478  ],
479  'indexpageids' => false,
480  'export' => false,
481  'exportnowrap' => false,
482  'iwurl' => false,
483  'continue' => [
484  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
485  ],
486  'rawcontinue' => false,
487  ];
488  if ( $flags ) {
489  $result += $this->getPageSet()->getFinalParams( $flags );
490  }
491 
492  return $result;
493  }
494 
495  public function isReadMode() {
496  // We need to make an exception for certain meta modules that should be
497  // accessible even without the 'read' right. Restrict the exception as
498  // much as possible: no other modules allowed, and no pageset
499  // parameters either. We do allow the 'rawcontinue' and 'indexpageids'
500  // parameters since frameworks might add these unconditionally and they
501  // can't expose anything here.
502  $this->mParams = $this->extractRequestParams();
503  $params = array_filter(
504  array_diff_key(
505  $this->mParams + $this->getPageSet()->extractRequestParams(),
506  [ 'rawcontinue' => 1, 'indexpageids' => 1 ]
507  )
508  );
509  if ( array_keys( $params ) !== [ 'meta' ] ) {
510  return true;
511  }
512 
513  // Ask each module if it requires read mode. Any true => this returns
514  // true.
515  $modules = [];
516  $this->instantiateModules( $modules, 'meta' );
517  foreach ( $modules as $module ) {
518  if ( $module->isReadMode() ) {
519  return true;
520  }
521  }
522 
523  return false;
524  }
525 
526  protected function getExamplesMessages() {
527  return [
528  'action=query&prop=revisions&meta=siteinfo&' .
529  'titles=Main%20Page&rvprop=user|comment&continue='
530  => 'apihelp-query-example-revisions',
531  'action=query&generator=allpages&gapprefix=API/&prop=revisions&continue='
532  => 'apihelp-query-example-allpages',
533  ];
534  }
535 
536  public function getHelpUrls() {
537  return [
538  'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Query',
539  'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Meta',
540  'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Properties',
541  'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Lists',
542  ];
543  }
544 }
getHelpUrls()
Definition: ApiQuery.php:536
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
getResult()
Get the result object.
Definition: ApiBase.php:633
execute()
Query execution happens in the following steps: #1 Create a PageSet object with any pages requested b...
Definition: ApiQuery.php:212
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:40
This class holds a list of modules and handles instantiation.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getMain()
Get the main module.
Definition: ApiBase.php:529
getDB()
Gets a default replica DB connection object.
Definition: ApiBase.php:661
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Formatter that spits out anything you like with any desired MIME type.
This manages continuation state.
mergeCacheMode( $cacheMode, $modCacheMode)
Update a cache mode string, applying the cache mode of a new module to it.
Definition: ApiQuery.php:283
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1991
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:744
getPageSet()
Gets the set of pages the user has requested (or generated)
Definition: ApiQuery.php:183
const ADD_ON_TOP
For addValue(), setValue() and similar functions, if the value does not exist, add it as the first el...
Definition: ApiResult.php:49
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
instantiateModules(&$modules, $param)
Create instances of all modules requested by the client.
Definition: ApiQuery.php:302
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
Definition: ApiBase.php:859
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 '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. '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 '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 since 1.28! 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:1980
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 just before the function returns a value If you return true
Definition: hooks.txt:1982
static array $QueryPropModules
List of Api Query prop modules.
Definition: ApiQuery.php:42
outputGeneralPageInfo()
Appends an element for each page in the current pageSet with the most general information (id...
Definition: ApiQuery.php:326
$modules
getNamedDB( $name, $db, $groups)
Get the query database connection with the given name.
Definition: ApiQuery.php:171
setContinuationManager(ApiContinuationManager $manager=null)
Set the continuation manager.
Definition: ApiBase.php:687
$params
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:41
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
const NO_SIZE_CHECK
For addValue() and similar functions, do not check size while adding a value Don&#39;t use this unless yo...
Definition: ApiResult.php:58
static stripMetadataNonRecursive( $data, &$metadata=null)
Remove metadata keys from a data array or object, non-recursive.
Definition: ApiResult.php:1056
getExamplesMessages()
Definition: ApiQuery.php:526
This is the main query class.
Definition: ApiQuery.php:36
getModuleManager()
Overrides to return this instance&#39;s module manager.
Definition: ApiQuery.php:157
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
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
static array static array $QueryListModules
List of Api Query list modules.
Definition: ApiQuery.php:69
isReadMode()
Definition: ApiQuery.php:495
getAllowedParams( $flags=0)
Definition: ApiQuery.php:465
doExport( $pageSet, $result)
Definition: ApiQuery.php:428
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
dieWithErrorOrDebug( $msg, $code=null, $data=null, $httpCode=null)
Will only set a warning instead of failing if the global $wgDebugAPI is set to true.
Definition: ApiBase.php:2189
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
__construct(ApiMain $main, $action)
Definition: ApiQuery.php:133
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:52
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:2218
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:38
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
Definition: ApiResult.php:728
static array static array static array ApiPageSet $mPageSet
Definition: ApiQuery.php:113
const META_BC_SUBELEMENTS
Key for the &#39;BC subelements&#39; metadata item.
Definition: ApiResult.php:143
getCustomPrinter()
Definition: ApiQuery.php:190
static array static array static array $QueryMetaModules
List of Api Query meta modules.
Definition: ApiQuery.php:111
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200