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