A query action to return meta information about the wiki site. More...

Inheritance diagram for ApiQuerySiteinfo:

Collaboration diagram for ApiQuerySiteinfo:

Public Member Functions
	__construct ($query, $moduleName)
	appendExtensionTags ($property)
	appendFunctionHooks ($property)
	appendLanguages ($property)
	appendSkins ($property)
	appendSubscribedHooks ($property)
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	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.
	getCacheMode ($params)
	Get the cache mode for the data generated by this module.
	getDescription ()
	Returns the description string for this module.
	getExamples ()
	Returns usage examples for this module.
	getHelpUrls ()
	getParamDescription ()
	Returns an array of parameter descriptions.
	getPossibleErrors ()
	getVersion ()
	Returns a string that identifies the version of the extending class.
Protected Member Functions
	appendDbReplLagInfo ($property, $includeAll)
	appendExtensions ($property)
	appendFileExtensions ($property)
	appendGeneralInfo ($property)
	appendInterwikiMap ($property, $filter)
	appendMagicWords ($property)
	appendNamespaceAliases ($property)
	appendNamespaces ($property)
	appendRightsInfo ($property)
	appendSpecialPageAliases ($property)
	appendStatistics ($property)
	appendUserGroups ($property, $numberInGroup)
Private Member Functions
	formatParserTags ($item)

Detailed Description

A query action to return meta information about the wiki site.

Definition at line 32 of file ApiQuerySiteinfo.php.

Constructor & Destructor Documentation

ApiQuerySiteinfo::__construct	(	$	query,
		$	moduleName
	)

Definition at line 34 of file ApiQuerySiteinfo.php.

Member Function Documentation

ApiQuerySiteinfo::appendDbReplLagInfo	(	$	property,
		$	includeAll
	)		`[protected]`

Definition at line 310 of file ApiQuerySiteinfo.php.

References $lb, $result, $wgShowHostnames, ApiBase\dieUsage(), ApiBase\getResult(), and wfGetLB().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendExtensions ( $ property ) [protected]

Definition at line 414 of file ApiQuerySiteinfo.php.

References $ext, $extensions, $wgExtensionCredits, and ApiBase\getResult().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendExtensionTags ( $ property )

Definition at line 509 of file ApiQuerySiteinfo.php.

References $wgParser, and ApiBase\getResult().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendFileExtensions ( $ property ) [protected]

Definition at line 403 of file ApiQuerySiteinfo.php.

References $ext, $wgFileExtensions, and ApiBase\getResult().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendFunctionHooks ( $ property )

Definition at line 517 of file ApiQuerySiteinfo.php.

References $wgParser, and ApiBase\getResult().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendGeneralInfo ( $ property ) [protected]

Definition at line 110 of file ApiQuerySiteinfo.php.

References $wgContLang, ApiQueryBase\getDB(), ApiBase\getResult(), SpecialVersion\getSvnRevision(), Title\newMainPage(), wfExpandUrl(), wfReadOnly(), wfReadOnlyReason(), wfRunHooks(), wfTimestamp(), and wfWikiID().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendInterwikiMap	(	$	property,
		$	filter
	)		`[protected]`

Definition at line 262 of file ApiQuerySiteinfo.php.

References ApiBase\dieDebug(), ApiBase\extractRequestParams(), Interwiki\getAllPrefixes(), Language\getLanguageNames(), ApiBase\getResult(), Language\getTranslatedLanguageNames(), and wfExpandUrl().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendLanguages ( $ property )

Definition at line 477 of file ApiQuerySiteinfo.php.

References ApiBase\extractRequestParams(), Language\getLanguageNames(), ApiBase\getResult(), Language\getTranslatedLanguageNames(), and ApiResult\setContent().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendMagicWords ( $ property ) [protected]

Definition at line 246 of file ApiQuerySiteinfo.php.

References $wgContLang, and ApiBase\getResult().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendNamespaceAliases ( $ property ) [protected]

Definition at line 213 of file ApiQuerySiteinfo.php.

References $title, $wgContLang, $wgNamespaceAliases, ApiBase\getResult(), and ApiResult\setContent().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendNamespaces ( $ property ) [protected]

Definition at line 185 of file ApiQuerySiteinfo.php.

References $title, $wgContLang, MWNamespace\getCanonicalName(), ApiBase\getResult(), MWNamespace\hasSubpages(), MWNamespace\isCapitalized(), MWNamespace\isContent(), and ApiResult\setContent().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendRightsInfo ( $ property ) [protected]

Definition at line 460 of file ApiQuerySiteinfo.php.

References $title, $url, $wgRightsPage, $wgRightsText, $wgRightsUrl, ApiBase\getResult(), Title\newFromText(), and wfExpandUrl().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendSkins ( $ property )

Definition at line 498 of file ApiQuerySiteinfo.php.

References ApiBase\getResult(), Skin\getSkinNames(), and ApiResult\setContent().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendSpecialPageAliases ( $ property ) [protected]

Definition at line 234 of file ApiQuerySiteinfo.php.

References $wgContLang, and ApiBase\getResult().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendStatistics ( $ property ) [protected]

Definition at line 341 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().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendSubscribedHooks ( $ property )

Definition at line 529 of file ApiQuerySiteinfo.php.

References $wgHooks, and ApiBase\getResult().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQuerySiteinfo::appendUserGroups	(	$	property,
		$	numberInGroup
	)		`[protected]`

Definition at line 358 of file ApiQuerySiteinfo.php.

References $result, $wgAddGroups, $wgAutopromote, $wgGroupPermissions, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf, $wgRemoveGroups, ApiBase\getResult(), and SiteStats\users().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

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 38 of file ApiQuerySiteinfo.php.

References appendDbReplLagInfo(), appendExtensions(), appendExtensionTags(), appendFileExtensions(), appendFunctionHooks(), appendGeneralInfo(), appendInterwikiMap(), appendLanguages(), appendMagicWords(), appendNamespaceAliases(), appendNamespaces(), appendRightsInfo(), appendSkins(), appendSpecialPageAliases(), appendStatistics(), appendSubscribedHooks(), appendUserGroups(), ApiBase\dieDebug(), ApiBase\extractRequestParams(), and ApiQueryBase\setContinueEnumParameter().

Here is the call graph for this function:

ApiQuerySiteinfo::formatParserTags ( $ item ) [private]

Definition at line 525 of file ApiQuerySiteinfo.php.

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.

Returns:: array or false

Reimplemented from ApiBase.

Definition at line 553 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. For possible return values and other details about cache modes, see ApiMain::setCacheMode()

Public caching will only be allowed if *all* the modules that supply data for a given request return a cache mode of public.

Parameters:

$params

Returns:: string

Reimplemented from ApiQueryBase.

Definition at line 549 of file ApiQuerySiteinfo.php.

ApiQuerySiteinfo::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 620 of file ApiQuerySiteinfo.php.

ApiQuerySiteinfo::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: false|string|array

Reimplemented from ApiBase.

Definition at line 630 of file ApiQuerySiteinfo.php.

ApiQuerySiteinfo::getHelpUrls ( )

Returns:: false|string|array Returns a false if the module has no help url, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 638 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.

Returns:: array or false

Reimplemented from ApiBase.

Definition at line 590 of file ApiQuerySiteinfo.php.

References ApiBase\getModulePrefix().

Here is the call graph for this function:

ApiQuerySiteinfo::getPossibleErrors ( )

Returns:: array

Reimplemented from ApiQueryBase.

Definition at line 624 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

Returns:: string

Reimplemented from ApiBase.

Definition at line 642 of file ApiQuerySiteinfo.php.

The documentation for this class was generated from the following file:

includes/api/ApiQuerySiteinfo.php

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation