ApiPurge Class Reference

API interface for page purging. More...

Inheritance diagram for ApiPurge:

Collaboration diagram for ApiPurge:

List of all members.

Public Member Functions
	__construct ($main, $action)
	execute ()
	Purges the cache of a page.
	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.
	getDescription ()
	Returns the description string for this module.
	getExamples ()
	Returns usage examples for this module.
	getHelpUrls ()
	getParamDescription ()
	Returns an array of parameter descriptions.
	getPossibleErrors ()
	Returns a list of all possible errors returned by the module.
	getResultProperties ()
	Returns possible properties in the result, grouped by the value of the prop parameter that shows them.
	getVersion ()
	Returns a string that identifies the version of the extending class.
	isWriteMode ()
	Indicates whether this module requires write mode.

---

Detailed Description

API interface for page purging.

Definition at line 32 of file ApiPurge.php.

---

Constructor & Destructor Documentation

ApiPurge::__construct	(	$	main,
		$	action
	)

Definition at line 34 of file ApiPurge.php.

---

Member Function Documentation

ApiPurge::execute

(

)

Purges the cache of a page.

Reimplemented from ApiBase.

Definition at line 41 of file ApiPurge.php.

References $page, $params, $result, $title, $user, $wgParser, ApiQueryBase\addTitleInfo(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), WikiPage\factory(), ApiBase\getMain(), ApiBase\getModuleName(), ContextSource\getRequest(), ApiBase\getResult(), ContextSource\getUser(), ApiBase\parseMsg(), DataUpdate\runUpdates(), ApiBase\setWarning(), and ParserCache\singleton().

ApiPurge::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|bool

Reimplemented from ApiBase.

Definition at line 123 of file ApiPurge.php.

ApiPurge::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 165 of file ApiPurge.php.

ApiPurge::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

bool|string|array

Reimplemented from ApiBase.

Definition at line 179 of file ApiPurge.php.

ApiPurge::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 185 of file ApiPurge.php.

ApiPurge::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|bool False on no parameter descriptions

Reimplemented from ApiBase.

Definition at line 130 of file ApiPurge.php.

ApiPurge::getPossibleErrors

(

)

Returns a list of all possible errors returned by the module.

Returns:

array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )

Reimplemented from ApiBase.

Definition at line 171 of file ApiPurge.php.

ApiPurge::getResultProperties

(

)

Returns possible properties in the result, grouped by the value of the prop parameter that shows them.

Properties that are shown always are in a group with empty string as a key. Properties that can be shown by several values of prop are included multiple times. If some properties are part of a list and some are on the root object (see ApiQueryQueryPage), those on the root object are under the key PROP_ROOT. The array can also contain a boolean under the key PROP_LIST, indicating whether the result is a list.

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

Returns:

array|bool False on no properties

Reimplemented from ApiBase.

Definition at line 137 of file ApiPurge.php.

References ApiBase\PROP_LIST, ApiBase\PROP_NULLABLE, and ApiBase\PROP_TYPE.

ApiPurge::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 189 of file ApiPurge.php.

ApiPurge::isWriteMode

(

)

Indicates whether this module requires write mode.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 119 of file ApiPurge.php.

---

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

• includes/api/ApiPurge.php