MediaWiki  1.29.1
ApiQuery.php
Go to the documentation of this file.
1 <?php
28 
40 class ApiQuery extends ApiBase {
41 
46  private static $QueryPropModules = [
47  'categories' => 'ApiQueryCategories',
48  'categoryinfo' => 'ApiQueryCategoryInfo',
49  'contributors' => 'ApiQueryContributors',
50  'deletedrevisions' => 'ApiQueryDeletedRevisions',
51  'duplicatefiles' => 'ApiQueryDuplicateFiles',
52  'extlinks' => 'ApiQueryExternalLinks',
53  'fileusage' => 'ApiQueryBacklinksprop',
54  'images' => 'ApiQueryImages',
55  'imageinfo' => 'ApiQueryImageInfo',
56  'info' => 'ApiQueryInfo',
57  'links' => 'ApiQueryLinks',
58  'linkshere' => 'ApiQueryBacklinksprop',
59  'iwlinks' => 'ApiQueryIWLinks',
60  'langlinks' => 'ApiQueryLangLinks',
61  'pageprops' => 'ApiQueryPageProps',
62  'redirects' => 'ApiQueryBacklinksprop',
63  'revisions' => 'ApiQueryRevisions',
64  'stashimageinfo' => 'ApiQueryStashImageInfo',
65  'templates' => 'ApiQueryLinks',
66  'transcludedin' => 'ApiQueryBacklinksprop',
67  ];
68 
73  private static $QueryListModules = [
74  'allcategories' => 'ApiQueryAllCategories',
75  'alldeletedrevisions' => 'ApiQueryAllDeletedRevisions',
76  'allfileusages' => 'ApiQueryAllLinks',
77  'allimages' => 'ApiQueryAllImages',
78  'alllinks' => 'ApiQueryAllLinks',
79  'allpages' => 'ApiQueryAllPages',
80  'allredirects' => 'ApiQueryAllLinks',
81  'allrevisions' => 'ApiQueryAllRevisions',
82  'mystashedfiles' => 'ApiQueryMyStashedFiles',
83  'alltransclusions' => 'ApiQueryAllLinks',
84  'allusers' => 'ApiQueryAllUsers',
85  'backlinks' => 'ApiQueryBacklinks',
86  'blocks' => 'ApiQueryBlocks',
87  'categorymembers' => 'ApiQueryCategoryMembers',
88  'deletedrevs' => 'ApiQueryDeletedrevs',
89  'embeddedin' => 'ApiQueryBacklinks',
90  'exturlusage' => 'ApiQueryExtLinksUsage',
91  'filearchive' => 'ApiQueryFilearchive',
92  'imageusage' => 'ApiQueryBacklinks',
93  'iwbacklinks' => 'ApiQueryIWBacklinks',
94  'langbacklinks' => 'ApiQueryLangBacklinks',
95  'logevents' => 'ApiQueryLogEvents',
96  'pageswithprop' => 'ApiQueryPagesWithProp',
97  'pagepropnames' => 'ApiQueryPagePropNames',
98  'prefixsearch' => 'ApiQueryPrefixSearch',
99  'protectedtitles' => 'ApiQueryProtectedTitles',
100  'querypage' => 'ApiQueryQueryPage',
101  'random' => 'ApiQueryRandom',
102  'recentchanges' => 'ApiQueryRecentChanges',
103  'search' => 'ApiQuerySearch',
104  'tags' => 'ApiQueryTags',
105  'usercontribs' => 'ApiQueryContributions',
106  'users' => 'ApiQueryUsers',
107  'watchlist' => 'ApiQueryWatchlist',
108  'watchlistraw' => 'ApiQueryWatchlistRaw',
109  ];
110 
115  private static $QueryMetaModules = [
116  'allmessages' => 'ApiQueryAllMessages',
117  'authmanagerinfo' => 'ApiQueryAuthManagerInfo',
118  'siteinfo' => 'ApiQuerySiteinfo',
119  'userinfo' => 'ApiQueryUserInfo',
120  'filerepoinfo' => 'ApiQueryFileRepoInfo',
121  'tokens' => 'ApiQueryTokens',
122  ];
123 
127  private $mPageSet;
128 
129  private $mParams;
130  private $mNamedDB = [];
131  private $mModuleMgr;
132 
137  public function __construct( ApiMain $main, $action ) {
138  parent::__construct( $main, $action );
139 
140  $this->mModuleMgr = new ApiModuleManager( $this );
141 
142  // Allow custom modules to be added in LocalSettings.php
143  $config = $this->getConfig();
144  $this->mModuleMgr->addModules( self::$QueryPropModules, 'prop' );
145  $this->mModuleMgr->addModules( $config->get( 'APIPropModules' ), 'prop' );
146  $this->mModuleMgr->addModules( self::$QueryListModules, 'list' );
147  $this->mModuleMgr->addModules( $config->get( 'APIListModules' ), 'list' );
148  $this->mModuleMgr->addModules( self::$QueryMetaModules, 'meta' );
149  $this->mModuleMgr->addModules( $config->get( 'APIMetaModules' ), 'meta' );
150 
151  Hooks::run( 'ApiQuery::moduleManager', [ $this->mModuleMgr ] );
152 
153  // Create PageSet that will process titles/pageids/revids/generator
154  $this->mPageSet = new ApiPageSet( $this );
155  }
156 
161  public function getModuleManager() {
162  return $this->mModuleMgr;
163  }
164 
175  public function getNamedDB( $name, $db, $groups ) {
176  if ( !array_key_exists( $name, $this->mNamedDB ) ) {
177  $this->mNamedDB[$name] = wfGetDB( $db, $groups );
178  }
179 
180  return $this->mNamedDB[$name];
181  }
182 
187  public function getPageSet() {
188  return $this->mPageSet;
189  }
190 
194  public function getCustomPrinter() {
195  // If &exportnowrap is set, use the raw formatter
196  if ( $this->getParameter( 'export' ) &&
197  $this->getParameter( 'exportnowrap' )
198  ) {
199  return new ApiFormatRaw( $this->getMain(),
200  $this->getMain()->createPrinterByName( 'xml' ) );
201  } else {
202  return null;
203  }
204  }
205 
216  public function execute() {
217  $this->mParams = $this->extractRequestParams();
218 
219  // Instantiate requested modules
220  $allModules = [];
221  $this->instantiateModules( $allModules, 'prop' );
222  $propModules = array_keys( $allModules );
223  $this->instantiateModules( $allModules, 'list' );
224  $this->instantiateModules( $allModules, 'meta' );
225 
226  // Filter modules based on continue parameter
227  $continuationManager = new ApiContinuationManager( $this, $allModules, $propModules );
228  $this->setContinuationManager( $continuationManager );
229  $modules = $continuationManager->getRunModules();
230 
231  if ( !$continuationManager->isGeneratorDone() ) {
232  // Query modules may optimize data requests through the $this->getPageSet()
233  // object by adding extra fields from the page table.
234  foreach ( $modules as $module ) {
235  $module->requestExtraData( $this->mPageSet );
236  }
237  // Populate page/revision information
238  $this->mPageSet->execute();
239  // Record page information (title, namespace, if exists, etc)
240  $this->outputGeneralPageInfo();
241  } else {
242  $this->mPageSet->executeDryRun();
243  }
244 
245  $cacheMode = $this->mPageSet->getCacheMode();
246 
247  // Execute all unfinished modules
249  foreach ( $modules as $module ) {
250  $params = $module->extractRequestParams();
251  $cacheMode = $this->mergeCacheMode(
252  $cacheMode, $module->getCacheMode( $params ) );
253  $module->execute();
254  Hooks::run( 'APIQueryAfterExecute', [ &$module ] );
255  }
256 
257  // Set the cache mode
258  $this->getMain()->setCacheMode( $cacheMode );
259 
260  // Write the continuation data into the result
261  $this->setContinuationManager( null );
262  if ( $this->mParams['rawcontinue'] ) {
263  $data = $continuationManager->getRawNonContinuation();
264  if ( $data ) {
265  $this->getResult()->addValue( null, 'query-noncontinue', $data,
267  }
268  $data = $continuationManager->getRawContinuation();
269  if ( $data ) {
270  $this->getResult()->addValue( null, 'query-continue', $data,
272  }
273  } else {
274  $continuationManager->setContinuationIntoResult( $this->getResult() );
275  }
276  }
277 
287  protected function mergeCacheMode( $cacheMode, $modCacheMode ) {
288  if ( $modCacheMode === 'anon-public-user-private' ) {
289  if ( $cacheMode !== 'private' ) {
290  $cacheMode = 'anon-public-user-private';
291  }
292  } elseif ( $modCacheMode === 'public' ) {
293  // do nothing, if it's public already it will stay public
294  } else { // private
295  $cacheMode = 'private';
296  }
297 
298  return $cacheMode;
299  }
300 
306  private function instantiateModules( &$modules, $param ) {
307  $wasPosted = $this->getRequest()->wasPosted();
308  if ( isset( $this->mParams[$param] ) ) {
309  foreach ( $this->mParams[$param] as $moduleName ) {
310  $instance = $this->mModuleMgr->getModule( $moduleName, $param );
311  if ( $instance === null ) {
312  ApiBase::dieDebug( __METHOD__, 'Error instantiating module' );
313  }
314  if ( !$wasPosted && $instance->mustBePosted() ) {
315  $this->dieWithErrorOrDebug( [ 'apierror-mustbeposted', $moduleName ] );
316  }
317  // Ignore duplicates. TODO 2.0: die()?
318  if ( !array_key_exists( $moduleName, $modules ) ) {
319  $modules[$moduleName] = $instance;
320  }
321  }
322  }
323  }
324 
330  private function outputGeneralPageInfo() {
331  $pageSet = $this->getPageSet();
332  $result = $this->getResult();
333 
334  // We can't really handle max-result-size failure here, but we need to
335  // check anyway in case someone set the limit stupidly low.
336  $fit = true;
337 
338  $values = $pageSet->getNormalizedTitlesAsResult( $result );
339  if ( $values ) {
340  $fit = $fit && $result->addValue( 'query', 'normalized', $values );
341  }
342  $values = $pageSet->getConvertedTitlesAsResult( $result );
343  if ( $values ) {
344  $fit = $fit && $result->addValue( 'query', 'converted', $values );
345  }
346  $values = $pageSet->getInterwikiTitlesAsResult( $result, $this->mParams['iwurl'] );
347  if ( $values ) {
348  $fit = $fit && $result->addValue( 'query', 'interwiki', $values );
349  }
350  $values = $pageSet->getRedirectTitlesAsResult( $result );
351  if ( $values ) {
352  $fit = $fit && $result->addValue( 'query', 'redirects', $values );
353  }
354  $values = $pageSet->getMissingRevisionIDsAsResult( $result );
355  if ( $values ) {
356  $fit = $fit && $result->addValue( 'query', 'badrevids', $values );
357  }
358 
359  // Page elements
360  $pages = [];
361 
362  // Report any missing titles
363  foreach ( $pageSet->getMissingTitles() as $fakeId => $title ) {
364  $vals = [];
366  $vals['missing'] = true;
367  if ( $title->isKnown() ) {
368  $vals['known'] = true;
369  }
370  $pages[$fakeId] = $vals;
371  }
372  // Report any invalid titles
373  foreach ( $pageSet->getInvalidTitlesAndReasons() as $fakeId => $data ) {
374  $pages[$fakeId] = $data + [ 'invalid' => true ];
375  }
376  // Report any missing page ids
377  foreach ( $pageSet->getMissingPageIDs() as $pageid ) {
378  $pages[$pageid] = [
379  'pageid' => $pageid,
380  'missing' => true,
381  ];
382  }
383  // Report special pages
385  foreach ( $pageSet->getSpecialTitles() as $fakeId => $title ) {
386  $vals = [];
388  $vals['special'] = true;
389  if ( !$title->isKnown() ) {
390  $vals['missing'] = true;
391  }
392  $pages[$fakeId] = $vals;
393  }
394 
395  // Output general page information for found titles
396  foreach ( $pageSet->getGoodTitles() as $pageid => $title ) {
397  $vals = [];
398  $vals['pageid'] = $pageid;
400  $pages[$pageid] = $vals;
401  }
402 
403  if ( count( $pages ) ) {
404  $pageSet->populateGeneratorData( $pages );
405  ApiResult::setArrayType( $pages, 'BCarray' );
406 
407  if ( $this->mParams['indexpageids'] ) {
408  $pageIDs = array_keys( ApiResult::stripMetadataNonRecursive( $pages ) );
409  // json treats all map keys as strings - converting to match
410  $pageIDs = array_map( 'strval', $pageIDs );
411  ApiResult::setIndexedTagName( $pageIDs, 'id' );
412  $fit = $fit && $result->addValue( 'query', 'pageids', $pageIDs );
413  }
414 
415  ApiResult::setIndexedTagName( $pages, 'page' );
416  $fit = $fit && $result->addValue( 'query', 'pages', $pages );
417  }
418 
419  if ( !$fit ) {
420  $this->dieWithError( 'apierror-badconfig-resulttoosmall', 'badconfig' );
421  }
422 
423  if ( $this->mParams['export'] ) {
424  $this->doExport( $pageSet, $result );
425  }
426  }
427 
432  private function doExport( $pageSet, $result ) {
433  $exportTitles = [];
434  $titles = $pageSet->getGoodTitles();
435  if ( count( $titles ) ) {
436  $user = $this->getUser();
438  foreach ( $titles as $title ) {
439  if ( $title->userCan( 'read', $user ) ) {
440  $exportTitles[] = $title;
441  }
442  }
443  }
444 
445  $exporter = new WikiExporter( $this->getDB() );
446  $sink = new DumpStringOutput;
447  $exporter->setOutputSink( $sink );
448  $exporter->openStream();
449  foreach ( $exportTitles as $title ) {
450  $exporter->pageByTitle( $title );
451  }
452  $exporter->closeStream();
453 
454  // Don't check the size of exported stuff
455  // It's not continuable, so it would cause more
456  // problems than it'd solve
457  if ( $this->mParams['exportnowrap'] ) {
458  $result->reset();
459  // Raw formatter will handle this
460  $result->addValue( null, 'text', $sink, ApiResult::NO_SIZE_CHECK );
461  $result->addValue( null, 'mime', 'text/xml', ApiResult::NO_SIZE_CHECK );
462  } else {
463  $result->addValue( 'query', 'export', $sink, ApiResult::NO_SIZE_CHECK );
464  $result->addValue( 'query', ApiResult::META_BC_SUBELEMENTS, [ 'export' ] );
465  }
466  }
467 
468  public function getAllowedParams( $flags = 0 ) {
469  $result = [
470  'prop' => [
471  ApiBase::PARAM_ISMULTI => true,
472  ApiBase::PARAM_TYPE => 'submodule',
473  ],
474  'list' => [
475  ApiBase::PARAM_ISMULTI => true,
476  ApiBase::PARAM_TYPE => 'submodule',
477  ],
478  'meta' => [
479  ApiBase::PARAM_ISMULTI => true,
480  ApiBase::PARAM_TYPE => 'submodule',
481  ],
482  'indexpageids' => false,
483  'export' => false,
484  'exportnowrap' => false,
485  'iwurl' => false,
486  'continue' => [
487  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
488  ],
489  'rawcontinue' => false,
490  ];
491  if ( $flags ) {
492  $result += $this->getPageSet()->getFinalParams( $flags );
493  }
494 
495  return $result;
496  }
497 
498  public function isReadMode() {
499  // We need to make an exception for certain meta modules that should be
500  // accessible even without the 'read' right. Restrict the exception as
501  // much as possible: no other modules allowed, and no pageset
502  // parameters either. We do allow the 'rawcontinue' and 'indexpageids'
503  // parameters since frameworks might add these unconditionally and they
504  // can't expose anything here.
505  $this->mParams = $this->extractRequestParams();
506  $params = array_filter(
507  array_diff_key(
508  $this->mParams + $this->getPageSet()->extractRequestParams(),
509  [ 'rawcontinue' => 1, 'indexpageids' => 1 ]
510  )
511  );
512  if ( array_keys( $params ) !== [ 'meta' ] ) {
513  return true;
514  }
515 
516  // Ask each module if it requires read mode. Any true => this returns
517  // true.
518  $modules = [];
519  $this->instantiateModules( $modules, 'meta' );
520  foreach ( $modules as $module ) {
521  if ( $module->isReadMode() ) {
522  return true;
523  }
524  }
525 
526  return false;
527  }
528 
529  protected function getExamplesMessages() {
530  return [
531  'action=query&prop=revisions&meta=siteinfo&' .
532  'titles=Main%20Page&rvprop=user|comment&continue='
533  => 'apihelp-query-example-revisions',
534  'action=query&generator=allpages&gapprefix=API/&prop=revisions&continue='
535  => 'apihelp-query-example-allpages',
536  ];
537  }
538 
539  public function getHelpUrls() {
540  return [
541  'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Query',
542  'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Meta',
543  'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Properties',
544  'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Lists',
545  ];
546  }
547 }
ApiQuery\$QueryMetaModules
static array $QueryMetaModules
List of Api Query meta modules.
Definition: ApiQuery.php:115
ApiMain
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:45
ContextSource\getConfig
getConfig()
Get the Config object.
Definition: ContextSource.php:68
ApiQuery\isReadMode
isReadMode()
Indicates whether this module requires read rights.
Definition: ApiQuery.php:498
ApiQuery\$mParams
$mParams
Definition: ApiQuery.php:129
ApiQuery
This is the main query class.
Definition: ApiQuery.php:40
ApiQuery\getPageSet
getPageSet()
Gets the set of pages the user has requested (or generated)
Definition: ApiQuery.php:187
captcha-old.count
count
Definition: captcha-old.py:225
ApiContinuationManager
This manages continuation state.
Definition: ApiContinuationManager.php:26
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1796
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:128
$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
ApiResult\META_BC_SUBELEMENTS
const META_BC_SUBELEMENTS
Key for the 'BC subelements' metadata item.
Definition: ApiResult.php:141
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:91
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:610
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
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:246
ApiBase\dieWithErrorOrDebug
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:1933
$params
$params
Definition: styleTest.css.php:40
ApiBase\getDB
getDB()
Gets a default replica DB connection object.
Definition: ApiBase.php:638
ApiResult\NO_SIZE_CHECK
const NO_SIZE_CHECK
For addValue() and similar functions, do not check size while adding a value Don't use this unless yo...
Definition: ApiResult.php:56
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
ContextSource\getRequest
getRequest()
Get the WebRequest object.
Definition: ContextSource.php:78
ContextSource\getUser
getUser()
Get the User object.
Definition: ContextSource.php:133
ApiQuery\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQuery.php:539
ApiPageSet
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:44
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
ApiQuery\__construct
__construct(ApiMain $main, $action)
Definition: ApiQuery.php:137
ApiResult\setArrayType
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
Definition: ApiResult.php:728
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:934
$titles
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
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:3060
$modules
$modules
Definition: HTMLFormElement.php:12
ApiFormatRaw
Formatter that spits out anything you like with any desired MIME type.
Definition: ApiFormatRaw.php:31
ApiQuery\getNamedDB
getNamedDB( $name, $db, $groups)
Get the query database connection with the given name.
Definition: ApiQuery.php:175
ApiResult\stripMetadataNonRecursive
static stripMetadataNonRecursive( $data, &$metadata=null)
Remove metadata keys from a data array or object, non-recursive.
Definition: ApiResult.php:1058
WikiExporter
Definition: WikiExporter.php:36
ApiModuleManager
This class holds a list of modules and handles instantiation.
Definition: ApiModuleManager.php:34
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:718
ApiResult\setIndexedTagName
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
ApiQuery\$QueryListModules
static array $QueryListModules
List of Api Query list modules.
Definition: ApiQuery.php:73
ApiQuery\doExport
doExport( $pageSet, $result)
Definition: ApiQuery.php:432
ApiQuery\getModuleManager
getModuleManager()
Overrides to return this instance's module manager.
Definition: ApiQuery.php:161
ApiQuery\getCustomPrinter
getCustomPrinter()
Definition: ApiQuery.php:194
ApiResult\ADD_ON_TOP
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:47
ApiBase\setContinuationManager
setContinuationManager( $manager)
Set the continuation manager.
Definition: ApiBase.php:664
ApiQuery\mergeCacheMode
mergeCacheMode( $cacheMode, $modCacheMode)
Update a cache mode string, applying the cache mode of a new module to it.
Definition: ApiQuery.php:287
ApiQuery\$mPageSet
ApiPageSet $mPageSet
Definition: ApiQuery.php:127
ApiQuery\outputGeneralPageInfo
outputGeneralPageInfo()
Appends an element for each page in the current pageSet with the most general information (id,...
Definition: ApiQuery.php:330
ApiQuery\getAllowedParams
getAllowedParams( $flags=0)
Definition: ApiQuery.php:468
ApiBase\getParameter
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
Definition: ApiBase.php:742
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:9
ApiQuery\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQuery.php:529
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:55
ApiQuery\$mModuleMgr
$mModuleMgr
Definition: ApiQuery.php:131
true
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:1956
ApiBase\getMain
getMain()
Get the main module.
Definition: ApiBase.php:506
ApiQuery\execute
execute()
Query execution happens in the following steps: #1 Create a PageSet object with any pages requested b...
Definition: ApiQuery.php:216
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
ApiQuery\$QueryPropModules
static array $QueryPropModules
List of Api Query prop modules.
Definition: ApiQuery.php:46
ApiBase\dieDebug
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:1962
ApiQuery\$mNamedDB
$mNamedDB
Definition: ApiQuery.php:130
DumpStringOutput
Definition: DumpStringOutput.php:27
ApiQuery\instantiateModules
instantiateModules(&$modules, $param)
Create instances of all modules requested by the client.
Definition: ApiQuery.php:306
$flags
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2749
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.