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',
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',
116 'allmessages' =>
'ApiQueryAllMessages',
117 'authmanagerinfo' =>
'ApiQueryAuthManagerInfo',
118 'siteinfo' =>
'ApiQuerySiteinfo',
119 'userinfo' =>
'ApiQueryUserInfo',
120 'filerepoinfo' =>
'ApiQueryFileRepoInfo',
121 'tokens' =>
'ApiQueryTokens',
138 parent::__construct( $main, $action );
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' );
151 Hooks::run(
'ApiQuery::moduleManager', [ $this->mModuleMgr ] );
176 if ( !array_key_exists(
$name, $this->mNamedDB ) ) {
180 return $this->mNamedDB[
$name];
200 $this->
getMain()->createPrinterByName(
'xml' ) );
222 $propModules = array_keys( $allModules );
229 $modules = $continuationManager->getRunModules();
231 if ( !$continuationManager->isGeneratorDone() ) {
235 $module->requestExtraData( $this->mPageSet );
238 $this->mPageSet->execute();
242 $this->mPageSet->executeDryRun();
245 $cacheMode = $this->mPageSet->getCacheMode();
250 $params = $module->extractRequestParams();
252 $cacheMode, $module->getCacheMode(
$params ) );
254 Hooks::run(
'APIQueryAfterExecute', [ &$module ] );
258 $this->
getMain()->setCacheMode( $cacheMode );
262 if ( $this->mParams[
'rawcontinue'] ) {
263 $data = $continuationManager->getRawNonContinuation();
265 $this->
getResult()->addValue(
null,
'query-noncontinue', $data,
268 $data = $continuationManager->getRawContinuation();
270 $this->
getResult()->addValue(
null,
'query-continue', $data,
274 $continuationManager->setContinuationIntoResult( $this->
getResult() );
288 if ( $modCacheMode ===
'anon-public-user-private' ) {
289 if ( $cacheMode !==
'private' ) {
290 $cacheMode =
'anon-public-user-private';
292 } elseif ( $modCacheMode ===
'public' ) {
295 $cacheMode =
'private';
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 ) {
314 if ( !$wasPosted && $instance->mustBePosted() ) {
318 if ( !array_key_exists( $moduleName,
$modules ) ) {
338 $values = $pageSet->getNormalizedTitlesAsResult(
$result );
340 $fit = $fit &&
$result->addValue(
'query',
'normalized', $values );
342 $values = $pageSet->getConvertedTitlesAsResult(
$result );
344 $fit = $fit &&
$result->addValue(
'query',
'converted', $values );
346 $values = $pageSet->getInterwikiTitlesAsResult(
$result, $this->mParams[
'iwurl'] );
348 $fit = $fit &&
$result->addValue(
'query',
'interwiki', $values );
350 $values = $pageSet->getRedirectTitlesAsResult(
$result );
352 $fit = $fit &&
$result->addValue(
'query',
'redirects', $values );
354 $values = $pageSet->getMissingRevisionIDsAsResult(
$result );
356 $fit = $fit &&
$result->addValue(
'query',
'badrevids', $values );
363 foreach ( $pageSet->getMissingTitles()
as $fakeId =>
$title ) {
366 $vals[
'missing'] =
true;
367 if (
$title->isKnown() ) {
368 $vals[
'known'] =
true;
370 $pages[$fakeId] = $vals;
373 foreach ( $pageSet->getInvalidTitlesAndReasons()
as $fakeId => $data ) {
374 $pages[$fakeId] = $data + [
'invalid' =>
true ];
377 foreach ( $pageSet->getMissingPageIDs()
as $pageid ) {
385 foreach ( $pageSet->getSpecialTitles()
as $fakeId =>
$title ) {
388 $vals[
'special'] =
true;
389 if ( !
$title->isKnown() ) {
390 $vals[
'missing'] =
true;
392 $pages[$fakeId] = $vals;
396 foreach ( $pageSet->getGoodTitles()
as $pageid =>
$title ) {
398 $vals[
'pageid'] = $pageid;
400 $pages[$pageid] = $vals;
403 if ( count( $pages ) ) {
404 $pageSet->populateGeneratorData( $pages );
407 if ( $this->mParams[
'indexpageids'] ) {
410 $pageIDs = array_map(
'strval', $pageIDs );
412 $fit = $fit &&
$result->addValue(
'query',
'pageids', $pageIDs );
416 $fit = $fit &&
$result->addValue(
'query',
'pages', $pages );
420 $this->
dieWithError(
'apierror-badconfig-resulttoosmall',
'badconfig' );
423 if ( $this->mParams[
'export'] ) {
434 $titles = $pageSet->getGoodTitles();
447 $exporter->setOutputSink( $sink );
448 $exporter->openStream();
449 foreach ( $exportTitles
as $title ) {
450 $exporter->pageByTitle(
$title );
452 $exporter->closeStream();
457 if ( $this->mParams[
'exportnowrap'] ) {
483 'indexpageids' =>
false,
485 'exportnowrap' =>
false,
490 'rawcontinue' =>
false,
510 [
'rawcontinue' => 1,
'indexpageids' => 1 ]
513 if ( array_keys(
$params ) !== [
'meta' ] ) {
522 if ( $module->isReadMode() ) {
532 'action=query&prop=revisions&meta=siteinfo&' .
533 'titles=Main%20Page&rvprop=user|comment&continue='
534 =>
'apihelp-query-example-revisions',
535 'action=query&generator=allpages&gapprefix=API/&prop=revisions&continue='
536 =>
'apihelp-query-example-allpages',
542 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Query',
543 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Meta',
544 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Properties',
545 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Lists',
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
This abstract class implements many basic API functions, and is the base of all API classes.
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
getDB()
Gets a default replica DB connection object.
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
dieWithErrorOrDebug( $msg, $code=null, $data=null, $httpCode=null)
Will only set a warning instead of failing if the global $wgDebugAPI is set to true.
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
getMain()
Get the main module.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
setContinuationManager( $manager)
Set the continuation manager.
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
getResult()
Get the result object.
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
This manages continuation state.
This is the main API class, used for both external and internal processing.
This class holds a list of modules and handles instantiation.
This class contains a list of pages that the client has requested.
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
This is the main query class.
static array $QueryListModules
List of Api Query list modules.
isReadMode()
Indicates whether this module requires read rights.
instantiateModules(&$modules, $param)
Create instances of all modules requested by the client.
static array $QueryPropModules
List of Api Query prop modules.
mergeCacheMode( $cacheMode, $modCacheMode)
Update a cache mode string, applying the cache mode of a new module to it.
getAllowedParams( $flags=0)
getModuleManager()
Overrides to return this instance's module manager.
__construct(ApiMain $main, $action)
outputGeneralPageInfo()
Appends an element for each page in the current pageSet with the most general information (id,...
getExamplesMessages()
Returns usage examples for this module.
doExport( $pageSet, $result)
getHelpUrls()
Return links to more detailed help pages about the module.
getPageSet()
Gets the set of pages the user has requested (or generated)
execute()
Query execution happens in the following steps: #1 Create a PageSet object with any pages requested b...
static array $QueryMetaModules
List of Api Query meta modules.
getNamedDB( $name, $db, $groups)
Get the query database connection with the given name.
static stripMetadataNonRecursive( $data, &$metadata=null)
Remove metadata keys from a data array or object, non-recursive.
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
const NO_SIZE_CHECK
For addValue() and similar functions, do not check size while adding a value Don't use this unless yo...
const ADD_ON_TOP
For addValue(), setValue() and similar functions, if the value does not exist, add it as the first el...
const META_BC_SUBELEMENTS
Key for the 'BC subelements' metadata item.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
getUser()
Get the User object.
getRequest()
Get the WebRequest object.
getConfig()
Get the Config object.
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
the array() calling protocol came about after MediaWiki 1.4rc1.
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
namespace and then decline to actually register it file or subcat img or subcat $title
it s the revision text itself In either if gzip is the revision text is gzipped $flags
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
Allows to change the fields on the form that will be generated $name
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
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
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