MediaWiki  REL1_23
Public Member Functions | Private Member Functions | Private Attributes
ApiPurge Class Reference
API

API interface for page purging. More...

Inheritance diagram for ApiPurge:
Inheritance graph
[legend]
Collaboration diagram for ApiPurge:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 execute ()
 Purges the cache of a page.
 getAllowedParams ($flags=0)
 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.
 isWriteMode ()
 Indicates whether this module requires write mode.
 mustBePosted ()
 Indicates whether this module must be called with a POST request.

Private Member Functions

 getPageSet ()
 Get a cached instance of an ApiPageSet object.

Private Attributes

 $mPageSet

Detailed Description

API interface for page purging.

Definition at line 32 of file ApiPurge.php.

Member Function Documentation

ApiPurge::execute ( )

Purges the cache of a page.

Reimplemented from ApiBase.

Definition at line 38 of file ApiPurge.php.

References $error, $params, $result, $title, ApiQueryBase\addTitleInfo(), array(), as, ApiBase\extractRequestParams(), WikiPage\factory(), ApiBase\getModuleName(), getPageSet(), ApiBase\getResult(), ContextSource\getUser(), global, ApiBase\parseMsg(), Revision\RAW, DataUpdate\runUpdates(), ApiBase\setWarning(), and ParserCache\singleton().

ApiPurge::getAllowedParams ( $  flags = 0)

Definition at line 129 of file ApiPurge.php.

References $flags, $result, array(), and getPageSet().

ApiPurge::getDescription ( )

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 183 of file ApiPurge.php.

References array().

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

References array().

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

ApiPurge::getPageSet ( ) [private]

Get a cached instance of an ApiPageSet object.

Returns:
ApiPageSet

Definition at line 112 of file ApiPurge.php.

Referenced by execute(), getAllowedParams(), getParamDescription(), and getPossibleErrors().

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

References array(), and getPageSet().

ApiPurge::getPossibleErrors ( )

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

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

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

Reimplemented from ApiBase.

Definition at line 189 of file ApiPurge.php.

References ApiBase\getFinalPossibleErrors(), and getPageSet().

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 function directly: use getFinalResultProperties() to allow hooks to modify descriptions as needed.

Returns:
array|bool False on no properties

Reimplemented from ApiBase.

Definition at line 150 of file ApiPurge.php.

References array(), ApiBase\PROP_LIST, ApiBase\PROP_NULLABLE, and ApiBase\PROP_TYPE.

ApiPurge::isWriteMode ( )

Indicates whether this module requires write mode.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 120 of file ApiPurge.php.

ApiPurge::mustBePosted ( )

Indicates whether this module must be called with a POST request.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 124 of file ApiPurge.php.

References ContextSource\getUser().

Member Data Documentation

ApiPurge::$mPageSet [private]

Definition at line 33 of file ApiPurge.php.

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