MediaWiki  REL1_24
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.
 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 $content, $error, $params, $result, $title, ApiQueryBase\addTitleInfo(), array(), as, ApiBase\extractRequestParams(), WikiPage\factory(), ContextSource\getConfig(), ApiBase\getModuleName(), getPageSet(), ApiBase\getResult(), ContextSource\getUser(), ApiBase\parseMsg(), Revision\RAW, DataUpdate\runUpdates(), ApiBase\setWarning(), and ParserCache\singleton().

ApiPurge::getAllowedParams ( $  flags = 0)

Definition at line 132 of file ApiPurge.php.

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

ApiPurge::getDescription ( )

Returns the description string for this module.

Returns:
string|array

Reimplemented from ApiBase.

Definition at line 155 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 161 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 167 of file ApiPurge.php.

ApiPurge::getPageSet ( ) [private]

Get a cached instance of an ApiPageSet object.

Returns:
ApiPageSet

Definition at line 115 of file ApiPurge.php.

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

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

References array(), and getPageSet().

ApiPurge::isWriteMode ( )

Indicates whether this module requires write mode.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 123 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 127 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: