Inherits ApiQueryBase.
Public Member Functions | |
__construct ($query, $moduleName) | |
execute () | |
Evaluates the parameters, performs the requested query, and sets up the result. | |
appendLanguages ($property) | |
getCacheMode ($params) | |
Get the cache mode for the data generated by this module. | |
getAllowedParams () | |
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed. | |
getParamDescription () | |
Returns an array of parameter descriptions. | |
getDescription () | |
Returns the description string for this module. | |
getPossibleErrors () | |
Returns a list of all possible errors returned by the module. | |
getVersion () | |
Returns a string that identifies the version of the extending class. | |
Protected Member Functions | |
appendGeneralInfo ($property) | |
appendNamespaces ($property) | |
appendNamespaceAliases ($property) | |
appendSpecialPageAliases ($property) | |
appendMagicWords ($property) | |
appendInterwikiMap ($property, $filter) | |
appendDbReplLagInfo ($property, $includeAll) | |
appendStatistics ($property) | |
appendUserGroups ($property, $numberInGroup) | |
appendFileExtensions ($property) | |
appendExtensions ($property) | |
appendRightsInfo ($property) | |
getExamples () | |
Returns usage examples for this module. |
Definition at line 36 of file ApiQuerySiteinfo.php.
ApiQuerySiteinfo::__construct | ( | $ | query, | |
$ | moduleName | |||
) |
Definition at line 38 of file ApiQuerySiteinfo.php.
ApiQuerySiteinfo::appendDbReplLagInfo | ( | $ | property, | |
$ | includeAll | |||
) | [protected] |
Definition at line 276 of file ApiQuerySiteinfo.php.
References $i, $result, $wgShowHostnames, ApiBase::dieUsage(), ApiBase::getResult(), and wfGetLB().
Referenced by execute().
ApiQuerySiteinfo::appendExtensions | ( | $ | property | ) | [protected] |
Definition at line 351 of file ApiQuerySiteinfo.php.
References $ext, $wgExtensionCredits, and ApiBase::getResult().
Referenced by execute().
ApiQuerySiteinfo::appendFileExtensions | ( | $ | property | ) | [protected] |
Definition at line 340 of file ApiQuerySiteinfo.php.
References $ext, $wgFileExtensions, and ApiBase::getResult().
Referenced by execute().
ApiQuerySiteinfo::appendGeneralInfo | ( | $ | property | ) | [protected] |
Definition at line 104 of file ApiQuerySiteinfo.php.
References $wgContLang, $wgLang, ApiQueryBase::getDB(), ApiBase::getResult(), getSvnRevision(), Title::newFromText(), wfMsgForContent(), wfReadOnly(), wfReadOnlyReason(), wfTimestamp(), and wfWikiID().
Referenced by execute().
ApiQuerySiteinfo::appendInterwikiMap | ( | $ | property, | |
$ | filter | |||
) | [protected] |
Definition at line 238 of file ApiQuerySiteinfo.php.
References $res, ApiQueryBase::addFields(), ApiQueryBase::addOption(), ApiQueryBase::addTables(), ApiQueryBase::addWhere(), ApiBase::dieDebug(), ApiQueryBase::getDB(), Language::getLanguageNames(), ApiBase::getResult(), ApiQueryBase::resetQueryParams(), and ApiQueryBase::select().
Referenced by execute().
ApiQuerySiteinfo::appendLanguages | ( | $ | property | ) |
Definition at line 413 of file ApiQuerySiteinfo.php.
References $code, $name, Language::getLanguageNames(), ApiBase::getResult(), and ApiResult::setContent().
Referenced by execute().
ApiQuerySiteinfo::appendMagicWords | ( | $ | property | ) | [protected] |
Definition at line 222 of file ApiQuerySiteinfo.php.
References $wgContLang, and ApiBase::getResult().
Referenced by execute().
ApiQuerySiteinfo::appendNamespaceAliases | ( | $ | property | ) | [protected] |
Definition at line 188 of file ApiQuerySiteinfo.php.
References $title, $wgContLang, $wgNamespaceAliases, ApiBase::getResult(), and ApiResult::setContent().
Referenced by execute().
ApiQuerySiteinfo::appendNamespaces | ( | $ | property | ) | [protected] |
Definition at line 162 of file ApiQuerySiteinfo.php.
References $title, $wgContLang, MWNamespace::getCanonicalName(), ApiBase::getResult(), MWNamespace::hasSubpages(), MWNamespace::isCapitalized(), MWNamespace::isContent(), and ApiResult::setContent().
Referenced by execute().
ApiQuerySiteinfo::appendRightsInfo | ( | $ | property | ) | [protected] |
Definition at line 396 of file ApiQuerySiteinfo.php.
References $title, $url, $wgRightsPage, $wgRightsText, $wgRightsUrl, ApiBase::getResult(), and Title::newFromText().
Referenced by execute().
ApiQuerySiteinfo::appendSpecialPageAliases | ( | $ | property | ) | [protected] |
Definition at line 209 of file ApiQuerySiteinfo.php.
References $wgLang, and ApiBase::getResult().
Referenced by execute().
ApiQuerySiteinfo::appendStatistics | ( | $ | property | ) | [protected] |
Definition at line 304 of file ApiQuerySiteinfo.php.
References $wgDisableCounters, SiteStats::activeUsers(), SiteStats::articles(), SiteStats::edits(), ApiBase::getResult(), SiteStats::images(), SiteStats::jobs(), SiteStats::numberingroup(), SiteStats::pages(), SiteStats::users(), and SiteStats::views().
Referenced by execute().
ApiQuerySiteinfo::appendUserGroups | ( | $ | property, | |
$ | numberInGroup | |||
) | [protected] |
Definition at line 321 of file ApiQuerySiteinfo.php.
References $wgGroupPermissions, and ApiBase::getResult().
Referenced by execute().
ApiQuerySiteinfo::execute | ( | ) |
Evaluates the parameters, performs the requested query, and sets up the result.
Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.
The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.
The result data should be stored in the ApiResult object available through getResult().
Reimplemented from ApiBase.
Definition at line 42 of file ApiQuerySiteinfo.php.
References appendDbReplLagInfo(), appendExtensions(), appendFileExtensions(), appendGeneralInfo(), appendInterwikiMap(), appendLanguages(), appendMagicWords(), appendNamespaceAliases(), appendNamespaces(), appendRightsInfo(), appendSpecialPageAliases(), appendStatistics(), appendUserGroups(), ApiBase::dieDebug(), ApiBase::extractRequestParams(), and ApiQueryBase::setContinueEnumParameter().
ApiQuerySiteinfo::getAllowedParams | ( | ) |
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.
Reimplemented from ApiBase.
Definition at line 428 of file ApiQuerySiteinfo.php.
References ApiBase::PARAM_DFLT, ApiBase::PARAM_ISMULTI, and ApiBase::PARAM_TYPE.
ApiQuerySiteinfo::getCacheMode | ( | $ | params | ) |
Get the cache mode for the data generated by this module.
Override this in the module subclass.
Public caching will only be allowed if *all* the modules that supply data for a given request return a cache mode of public.
Reimplemented from ApiQueryBase.
Definition at line 424 of file ApiQuerySiteinfo.php.
ApiQuerySiteinfo::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 484 of file ApiQuerySiteinfo.php.
ApiQuerySiteinfo::getExamples | ( | ) | [protected] |
Returns usage examples for this module.
Return null if no examples are available.
Reimplemented from ApiBase.
Definition at line 494 of file ApiQuerySiteinfo.php.
ApiQuerySiteinfo::getParamDescription | ( | ) |
Returns an array of parameter descriptions.
Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.
Reimplemented from ApiBase.
Definition at line 460 of file ApiQuerySiteinfo.php.
ApiQuerySiteinfo::getPossibleErrors | ( | ) |
Returns a list of all possible errors returned by the module.
Reimplemented from ApiQueryBase.
Definition at line 488 of file ApiQuerySiteinfo.php.
ApiQuerySiteinfo::getVersion | ( | ) |
Returns a string that identifies the version of the extending class.
Typically includes the class name, the svn revision, timestamp, and last author. Usually done with SVN's Id keyword
Reimplemented from ApiBase.
Definition at line 502 of file ApiQuerySiteinfo.php.