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  'languageinfo' => ApiQueryLanguageinfo::class,
119  ];
120 
124  private $mPageSet;
125 
126  private $mParams;
127  private $mNamedDB = [];
128  private $mModuleMgr;
129 
134  public function __construct( ApiMain $main, $action ) {
135  parent::__construct( $main, $action );
136 
137  $this->mModuleMgr = new ApiModuleManager( $this );
138 
139  // Allow custom modules to be added in LocalSettings.php
140  $config = $this->getConfig();
141  $this->mModuleMgr->addModules( self::$QueryPropModules, 'prop' );
142  $this->mModuleMgr->addModules( $config->get( 'APIPropModules' ), 'prop' );
143  $this->mModuleMgr->addModules( self::$QueryListModules, 'list' );
144  $this->mModuleMgr->addModules( $config->get( 'APIListModules' ), 'list' );
145  $this->mModuleMgr->addModules( self::$QueryMetaModules, 'meta' );
146  $this->mModuleMgr->addModules( $config->get( 'APIMetaModules' ), 'meta' );
147 
148  Hooks::run( 'ApiQuery::moduleManager', [ $this->mModuleMgr ] );
149 
150  // Create PageSet that will process titles/pageids/revids/generator
151  $this->mPageSet = new ApiPageSet( $this );
152  }
153 
158  public function getModuleManager() {
159  return $this->mModuleMgr;
160  }
161 
172  public function getNamedDB( $name, $db, $groups ) {
173  if ( !array_key_exists( $name, $this->mNamedDB ) ) {
174  $this->mNamedDB[$name] = wfGetDB( $db, $groups );
175  }
176 
177  return $this->mNamedDB[$name];
178  }
179 
184  public function getPageSet() {
185  return $this->mPageSet;
186  }
187 
191  public function getCustomPrinter() {
192  // If &exportnowrap is set, use the raw formatter
193  if ( $this->getParameter( 'export' ) &&
194  $this->getParameter( 'exportnowrap' )
195  ) {
196  return new ApiFormatRaw( $this->getMain(),
197  $this->getMain()->createPrinterByName( 'xml' ) );
198  } else {
199  return null;
200  }
201  }
202 
213  public function execute() {
214  $this->mParams = $this->extractRequestParams();
215 
216  // Instantiate requested modules
217  $allModules = [];
218  $this->instantiateModules( $allModules, 'prop' );
219  $propModules = array_keys( $allModules );
220  $this->instantiateModules( $allModules, 'list' );
221  $this->instantiateModules( $allModules, 'meta' );
222 
223  // Filter modules based on continue parameter
224  $continuationManager = new ApiContinuationManager( $this, $allModules, $propModules );
225  $this->setContinuationManager( $continuationManager );
226  $modules = $continuationManager->getRunModules();
227 
228  if ( !$continuationManager->isGeneratorDone() ) {
229  // Query modules may optimize data requests through the $this->getPageSet()
230  // object by adding extra fields from the page table.
231  foreach ( $modules as $module ) {
232  $module->requestExtraData( $this->mPageSet );
233  }
234  // Populate page/revision information
235  $this->mPageSet->execute();
236  // Record page information (title, namespace, if exists, etc)
237  $this->outputGeneralPageInfo();
238  } else {
239  $this->mPageSet->executeDryRun();
240  }
241 
242  $cacheMode = $this->mPageSet->getCacheMode();
243 
244  // Execute all unfinished modules
246  foreach ( $modules as $module ) {
247  $params = $module->extractRequestParams();
248  $cacheMode = $this->mergeCacheMode(
249  $cacheMode, $module->getCacheMode( $params ) );
250  $module->execute();
251  Hooks::run( 'APIQueryAfterExecute', [ &$module ] );
252  }
253 
254  // Set the cache mode
255  $this->getMain()->setCacheMode( $cacheMode );
256 
257  // Write the continuation data into the result
258  $this->setContinuationManager( null );
259  if ( $this->mParams['rawcontinue'] ) {
260  $data = $continuationManager->getRawNonContinuation();
261  if ( $data ) {
262  $this->getResult()->addValue( null, 'query-noncontinue', $data,
264  }
265  $data = $continuationManager->getRawContinuation();
266  if ( $data ) {
267  $this->getResult()->addValue( null, 'query-continue', $data,
269  }
270  } else {
271  $continuationManager->setContinuationIntoResult( $this->getResult() );
272  }
273  }
274 
284  protected function mergeCacheMode( $cacheMode, $modCacheMode ) {
285  if ( $modCacheMode === 'anon-public-user-private' ) {
286  if ( $cacheMode !== 'private' ) {
287  $cacheMode = 'anon-public-user-private';
288  }
289  } elseif ( $modCacheMode === 'public' ) {
290  // do nothing, if it's public already it will stay public
291  } else {
292  $cacheMode = 'private';
293  }
294 
295  return $cacheMode;
296  }
297 
303  private function instantiateModules( &$modules, $param ) {
304  $wasPosted = $this->getRequest()->wasPosted();
305  if ( isset( $this->mParams[$param] ) ) {
306  foreach ( $this->mParams[$param] as $moduleName ) {
307  $instance = $this->mModuleMgr->getModule( $moduleName, $param );
308  if ( $instance === null ) {
309  ApiBase::dieDebug( __METHOD__, 'Error instantiating module' );
310  }
311  if ( !$wasPosted && $instance->mustBePosted() ) {
312  $this->dieWithErrorOrDebug( [ 'apierror-mustbeposted', $moduleName ] );
313  }
314  // Ignore duplicates. TODO 2.0: die()?
315  if ( !array_key_exists( $moduleName, $modules ) ) {
316  $modules[$moduleName] = $instance;
317  }
318  }
319  }
320  }
321 
327  private function outputGeneralPageInfo() {
328  $pageSet = $this->getPageSet();
329  $result = $this->getResult();
330 
331  // We can't really handle max-result-size failure here, but we need to
332  // check anyway in case someone set the limit stupidly low.
333  $fit = true;
334 
335  $values = $pageSet->getNormalizedTitlesAsResult( $result );
336  if ( $values ) {
337  $fit = $fit && $result->addValue( 'query', 'normalized', $values );
338  }
339  $values = $pageSet->getConvertedTitlesAsResult( $result );
340  if ( $values ) {
341  $fit = $fit && $result->addValue( 'query', 'converted', $values );
342  }
343  $values = $pageSet->getInterwikiTitlesAsResult( $result, $this->mParams['iwurl'] );
344  if ( $values ) {
345  $fit = $fit && $result->addValue( 'query', 'interwiki', $values );
346  }
347  $values = $pageSet->getRedirectTitlesAsResult( $result );
348  if ( $values ) {
349  $fit = $fit && $result->addValue( 'query', 'redirects', $values );
350  }
351  $values = $pageSet->getMissingRevisionIDsAsResult( $result );
352  if ( $values ) {
353  $fit = $fit && $result->addValue( 'query', 'badrevids', $values );
354  }
355 
356  // Page elements
357  $pages = [];
358 
359  // Report any missing titles
360  foreach ( $pageSet->getMissingTitles() as $fakeId => $title ) {
361  $vals = [];
363  $vals['missing'] = true;
364  if ( $title->isKnown() ) {
365  $vals['known'] = true;
366  }
367  $pages[$fakeId] = $vals;
368  }
369  // Report any invalid titles
370  foreach ( $pageSet->getInvalidTitlesAndReasons() as $fakeId => $data ) {
371  $pages[$fakeId] = $data + [ 'invalid' => true ];
372  }
373  // Report any missing page ids
374  foreach ( $pageSet->getMissingPageIDs() as $pageid ) {
375  $pages[$pageid] = [
376  'pageid' => $pageid,
377  'missing' => true,
378  ];
379  }
380  // Report special pages
382  foreach ( $pageSet->getSpecialTitles() as $fakeId => $title ) {
383  $vals = [];
385  $vals['special'] = true;
386  if ( !$title->isKnown() ) {
387  $vals['missing'] = true;
388  }
389  $pages[$fakeId] = $vals;
390  }
391 
392  // Output general page information for found titles
393  foreach ( $pageSet->getGoodTitles() as $pageid => $title ) {
394  $vals = [];
395  $vals['pageid'] = $pageid;
397  $pages[$pageid] = $vals;
398  }
399 
400  if ( count( $pages ) ) {
401  $pageSet->populateGeneratorData( $pages );
402  ApiResult::setArrayType( $pages, 'BCarray' );
403 
404  if ( $this->mParams['indexpageids'] ) {
405  $pageIDs = array_keys( ApiResult::stripMetadataNonRecursive( $pages ) );
406  // json treats all map keys as strings - converting to match
407  $pageIDs = array_map( 'strval', $pageIDs );
408  ApiResult::setIndexedTagName( $pageIDs, 'id' );
409  $fit = $fit && $result->addValue( 'query', 'pageids', $pageIDs );
410  }
411 
412  ApiResult::setIndexedTagName( $pages, 'page' );
413  $fit = $fit && $result->addValue( 'query', 'pages', $pages );
414  }
415 
416  if ( !$fit ) {
417  $this->dieWithError( 'apierror-badconfig-resulttoosmall', 'badconfig' );
418  }
419 
420  if ( $this->mParams['export'] ) {
421  $this->doExport( $pageSet, $result );
422  }
423  }
424 
429  private function doExport( $pageSet, $result ) {
430  $exportTitles = [];
431  $titles = $pageSet->getGoodTitles();
432  if ( count( $titles ) ) {
434  foreach ( $titles as $title ) {
435  if ( $this->getPermissionManager()->userCan( 'read', $this->getUser(), $title ) ) {
436  $exportTitles[] = $title;
437  }
438  }
439  }
440 
441  $exporter = new WikiExporter( $this->getDB() );
442  $sink = new DumpStringOutput;
443  $exporter->setOutputSink( $sink );
444  $exporter->setSchemaVersion( $this->mParams['exportschema'] );
445  $exporter->openStream();
446  foreach ( $exportTitles as $title ) {
447  $exporter->pageByTitle( $title );
448  }
449  $exporter->closeStream();
450 
451  // Don't check the size of exported stuff
452  // It's not continuable, so it would cause more
453  // problems than it'd solve
454  if ( $this->mParams['exportnowrap'] ) {
455  $result->reset();
456  // Raw formatter will handle this
457  $result->addValue( null, 'text', $sink, ApiResult::NO_SIZE_CHECK );
458  $result->addValue( null, 'mime', 'text/xml', ApiResult::NO_SIZE_CHECK );
459  $result->addValue( null, 'filename', 'export.xml', ApiResult::NO_SIZE_CHECK );
460  } else {
461  $result->addValue( 'query', 'export', $sink, ApiResult::NO_SIZE_CHECK );
462  $result->addValue( 'query', ApiResult::META_BC_SUBELEMENTS, [ 'export' ] );
463  }
464  }
465 
466  public function getAllowedParams( $flags = 0 ) {
467  $result = [
468  'prop' => [
469  ApiBase::PARAM_ISMULTI => true,
470  ApiBase::PARAM_TYPE => 'submodule',
471  ],
472  'list' => [
473  ApiBase::PARAM_ISMULTI => true,
474  ApiBase::PARAM_TYPE => 'submodule',
475  ],
476  'meta' => [
477  ApiBase::PARAM_ISMULTI => true,
478  ApiBase::PARAM_TYPE => 'submodule',
479  ],
480  'indexpageids' => false,
481  'export' => false,
482  'exportnowrap' => false,
483  'exportschema' => [
486  ],
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/Special:MyLanguage/API:Query',
544  'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Meta',
545  'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Properties',
546  'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Lists',
547  ];
548  }
549 }
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:94
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
getResult()
Get the result object.
Definition: ApiBase.php:640
execute()
Query execution happens in the following steps: #1 Create a PageSet object with any pages requested b...
Definition: ApiQuery.php:213
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
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
getMain()
Get the main module.
Definition: ApiBase.php:536
getDB()
Gets a default replica DB connection object.
Definition: ApiBase.php:668
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:284
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2009
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
getPageSet()
Gets the set of pages the user has requested (or generated)
Definition: ApiQuery.php:184
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:303
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
Definition: ApiBase.php:876
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=(\*-\*)") 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. '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:1970
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:1972
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:327
$modules
getNamedDB( $name, $db, $groups)
Get the query database connection with the given name.
Definition: ApiQuery.php:172
setContinuationManager(ApiContinuationManager $manager=null)
Set the continuation manager.
Definition: ApiBase.php:694
$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:767
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
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:531
This is the main query class.
Definition: ApiQuery.php:36
getModuleManager()
Overrides to return this instance&#39;s module manager.
Definition: ApiQuery.php:158
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:131
static array static array $QueryListModules
List of Api Query list modules.
Definition: ApiQuery.php:69
isReadMode()
Definition: ApiQuery.php:500
getAllowedParams( $flags=0)
Definition: ApiQuery.php:466
doExport( $pageSet, $result)
Definition: ApiQuery.php:429
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:2183
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:134
static schemaVersion()
Returns the default export schema version, as defined by $wgXmlDumpSchemaVersion. ...
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
getPermissionManager()
Obtain a PermissionManager instance that subclasses may use in their authorization checks...
Definition: ApiBase.php:710
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:2212
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:42
static string [] $supportedSchemas
the schema versions supported for output
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:191
static array static array static array $QueryMetaModules
List of Api Query meta modules.
Definition: ApiQuery.php:111
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200