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)
	appendDefaultOptions ($property)
	appendExtensionTags ($property)
	appendFunctionHooks ($property)
	appendLanguages ($property)
	appendProtocols ($property)
	appendSkins ($property)
	appendSubscribedHooks ($property)
	appendVariables ($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 ()
Protected Member Functions
	appendDbReplLagInfo ($property, $includeAll)
	appendExtensions ($property)
	appendFileExtensions ($property)
	appendGeneralInfo ($property)
	appendInterwikiMap ($property, $filter)
	appendMagicWords ($property)
	appendNamespaceAliases ($property)
	appendNamespaces ($property)
	appendRestrictions ($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.

References $query.

Member Function Documentation

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

Definition at line 411 of file ApiQuerySiteinfo.php.

References $lb, $property, $result, array(), as, ApiBase\dieUsage(), ApiBase\getResult(), global, list, and wfGetLB().

Referenced by execute().

ApiQuerySiteinfo::appendDefaultOptions ( $ property )

Definition at line 714 of file ApiQuerySiteinfo.php.

References $property, User\getDefaultOptions(), and ApiBase\getResult().

Referenced by execute().

ApiQuerySiteinfo::appendExtensions ( $ property ) [protected]

Definition at line 524 of file ApiQuerySiteinfo.php.

References $ext, $extensions, $property, $ret, array(), as, SpecialVersion\getExtAuthorsFileName(), SpecialVersion\getExtLicenseFileName(), ApiBase\getResult(), SpecialVersion\getSvnInfo(), SpecialPage\getTitleFor(), global, and wfTimestamp().

Referenced by execute().

ApiQuerySiteinfo::appendExtensionTags ( $ property )

Definition at line 680 of file ApiQuerySiteinfo.php.

References $property, $wgParser, array(), ApiBase\getResult(), and global.

Referenced by execute().

ApiQuerySiteinfo::appendFileExtensions ( $ property ) [protected]

Definition at line 512 of file ApiQuerySiteinfo.php.

References $ext, $property, $wgFileExtensions, array(), as, ApiBase\getResult(), and global.

Referenced by execute().

ApiQuerySiteinfo::appendFunctionHooks ( $ property )

Definition at line 689 of file ApiQuerySiteinfo.php.

References $property, $wgParser, ApiBase\getResult(), and global.

Referenced by execute().

ApiQuerySiteinfo::appendGeneralInfo ( $ property ) [protected]

Definition at line 122 of file ApiQuerySiteinfo.php.

References $GLOBALS, $limit, $linkPrefixCharset, $property, $wgContLang, array(), as, empty, ApiQueryBase\getDB(), SpecialVersion\getGitHeadSha1(), UploadBase\getMaxUploadSize(), ApiBase\getResult(), SpecialVersion\getSvnRevision(), global, Title\newMainPage(), wfExpandUrl(), wfReadOnly(), wfReadOnlyReason(), wfRunHooks(), wfTimestamp(), and wfWikiID().

Referenced by execute().

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

Definition at line 365 of file ApiQuerySiteinfo.php.

References $params, $property, array(), as, ApiBase\dieDebug(), ApiBase\extractRequestParams(), Language\fetchLanguageNames(), Interwiki\getAllPrefixes(), ApiBase\getResult(), and wfExpandUrl().

Referenced by execute().

ApiQuerySiteinfo::appendLanguages ( $ property )

Definition at line 643 of file ApiQuerySiteinfo.php.

References $name, $params, $property, array(), as, ApiBase\extractRequestParams(), Language\fetchLanguageNames(), ApiBase\getResult(), and ApiResult\setContent().

Referenced by execute().

ApiQuerySiteinfo::appendMagicWords ( $ property ) [protected]

Definition at line 348 of file ApiQuerySiteinfo.php.

References $property, $wgContLang, array(), as, ApiBase\getResult(), and global.

Referenced by execute().

ApiQuerySiteinfo::appendNamespaceAliases ( $ property ) [protected]

Definition at line 308 of file ApiQuerySiteinfo.php.

References $namespaces, $property, $title, $wgContLang, $wgNamespaceAliases, array(), as, ApiBase\getResult(), global, and ApiResult\setContent().

Referenced by execute().

ApiQuerySiteinfo::appendNamespaces ( $ property ) [protected]

Definition at line 270 of file ApiQuerySiteinfo.php.

References $property, $title, $wgContLang, array(), as, MWNamespace\getCanonicalName(), MWNamespace\getNamespaceContentModel(), ApiBase\getResult(), global, MWNamespace\hasSubpages(), MWNamespace\isCapitalized(), MWNamespace\isContent(), MWNamespace\isNonincludable(), and ApiResult\setContent().

Referenced by execute().

ApiQuerySiteinfo::appendProtocols ( $ property )

Definition at line 705 of file ApiQuerySiteinfo.php.

References $property, ApiBase\getResult(), and global.

Referenced by execute().

ApiQuerySiteinfo::appendRestrictions ( $ property ) [protected]

Definition at line 624 of file ApiQuerySiteinfo.php.

References $property, array(), ApiBase\getResult(), and global.

Referenced by execute().

ApiQuerySiteinfo::appendRightsInfo ( $ property ) [protected]

Definition at line 607 of file ApiQuerySiteinfo.php.

References $property, $title, array(), ApiBase\getResult(), global, Title\newFromText(), and wfExpandUrl().

Referenced by execute().

ApiQuerySiteinfo::appendSkins ( $ property )

Definition at line 660 of file ApiQuerySiteinfo.php.

References $name, $property, $skin, array(), as, Skin\getAllowedSkins(), ApiBase\getResult(), Skin\getSkinNames(), Skin\normalizeKey(), and ApiResult\setContent().

Referenced by execute().

ApiQuerySiteinfo::appendSpecialPageAliases ( $ property ) [protected]

Definition at line 332 of file ApiQuerySiteinfo.php.

References $property, $wgContLang, array(), as, SpecialPageFactory\getList(), ApiBase\getResult(), and global.

Referenced by execute().

ApiQuerySiteinfo::appendStatistics ( $ property ) [protected]

Definition at line 446 of file ApiQuerySiteinfo.php.

References $property, SiteStats\activeUsers(), array(), SiteStats\articles(), SiteStats\edits(), ApiBase\getResult(), global, SiteStats\images(), SiteStats\jobs(), SiteStats\numberingroup(), SiteStats\pages(), SiteStats\users(), SiteStats\views(), and wfRunHooks().

Referenced by execute().

ApiQuerySiteinfo::appendSubscribedHooks ( $ property )

Definition at line 722 of file ApiQuerySiteinfo.php.

References $property, $wgHooks, array(), as, ApiBase\getResult(), and global.

Referenced by execute().

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

Definition at line 466 of file ApiQuerySiteinfo.php.

References $property, $result, array(), as, ApiBase\getResult(), global, and SiteStats\users().

Referenced by execute().

ApiQuerySiteinfo::appendVariables ( $ property )

Definition at line 698 of file ApiQuerySiteinfo.php.

References $property, ApiBase\getResult(), and MagicWord\getVariableIDs().

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

References $params, appendDbReplLagInfo(), appendDefaultOptions(), appendExtensions(), appendExtensionTags(), appendFileExtensions(), appendFunctionHooks(), appendGeneralInfo(), appendInterwikiMap(), appendLanguages(), appendMagicWords(), appendNamespaceAliases(), appendNamespaces(), appendProtocols(), appendRestrictions(), appendRightsInfo(), appendSkins(), appendSpecialPageAliases(), appendStatistics(), appendSubscribedHooks(), appendUserGroups(), appendVariables(), array(), as, ApiBase\dieDebug(), ApiBase\extractRequestParams(), and ApiQueryBase\setContinueEnumParameter().

ApiQuerySiteinfo::formatParserTags ( $ item ) [private]

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

Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.

Returns:: array|bool

Reimplemented from ApiBase.

Definition at line 747 of file ApiQuerySiteinfo.php.

References array(), 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 743 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 826 of file ApiQuerySiteinfo.php.

ApiQuerySiteinfo::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 837 of file ApiQuerySiteinfo.php.

References array().

ApiQuerySiteinfo::getHelpUrls ( )

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

Reimplemented from ApiBase.

Definition at line 845 of file ApiQuerySiteinfo.php.

ApiQuerySiteinfo::getParamDescription ( )

Returns an array of parameter descriptions.

Don't call this function directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.

Returns:: array|bool False on no parameter descriptions

Reimplemented from ApiBase.

Definition at line 788 of file ApiQuerySiteinfo.php.

References array(), and ApiBase\getModulePrefix().

ApiQuerySiteinfo::getPossibleErrors ( )

Returns:: array

Reimplemented from ApiQueryBase.

Definition at line 830 of file ApiQuerySiteinfo.php.

References array().

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