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.
	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, $result, $title, $user, $wgEnableParserCache, $wgParser, ApiQueryBase\addTitleInfo(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), WikiPage\factory(), ContextSource\getContext(), ApiBase\getMain(), ApiBase\getModuleName(), ContextSource\getRequest(), ApiBase\getResult(), ContextSource\getUser(), ParserOptions\newFromContext(), ApiBase\parseMsg(), ApiBase\setWarning(), and ParserCache\singleton().

Here is the call graph for this function:

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 or false

Reimplemented from ApiBase.

Definition at line 122 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 136 of file ApiPurge.php.

ApiPurge::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

false|string|array

Reimplemented from ApiBase.

Definition at line 151 of file ApiPurge.php.

ApiPurge::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 157 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 or false

Reimplemented from ApiBase.

Definition at line 129 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 142 of file ApiPurge.php.

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

ApiPurge::isWriteMode

(

)

Indicates whether this module requires write mode.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 118 of file ApiPurge.php.

---

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

• includes/api/ApiPurge.php