Inherits ApiBase.
Public Member Functions | |
__construct ($main, $action) | |
execute () | |
Purges the cache of a page. | |
mustBePosted () | |
Indicates whether this module must be called with a POST request. | |
isWriteMode () | |
Indicates whether this module requires write mode. | |
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. | |
getParamDescription () | |
Returns an array of parameter descriptions. | |
getDescription () | |
Returns the description string for this module. | |
getVersion () | |
Returns a string that identifies the version of the extending class. | |
Protected Member Functions | |
getExamples () | |
Returns usage examples for this module. |
Definition at line 34 of file ApiPurge.php.
ApiPurge::__construct | ( | $ | main, | |
$ | action | |||
) |
ApiPurge::execute | ( | ) |
Purges the cache of a page.
Reimplemented from ApiBase.
Definition at line 43 of file ApiPurge.php.
References $result, $t, $title, $wgUser, ApiQueryBase::addTitleInfo(), ApiBase::dieUsageMsg(), ApiBase::extractRequestParams(), ApiBase::getModuleName(), ApiBase::getResult(), and Title::newFromText().
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.
Reimplemented from ApiBase.
Definition at line 86 of file ApiPurge.php.
References ApiBase::PARAM_ISMULTI.
ApiPurge::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 100 of file ApiPurge.php.
ApiPurge::getExamples | ( | ) | [protected] |
Returns usage examples for this module.
Return null if no examples are available.
Reimplemented from ApiBase.
Definition at line 106 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.
Reimplemented from ApiBase.
Definition at line 94 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
Reimplemented from ApiBase.
Definition at line 112 of file ApiPurge.php.
ApiPurge::isWriteMode | ( | ) |
Indicates whether this module requires write mode.
Reimplemented from ApiBase.
Definition at line 82 of file ApiPurge.php.
ApiPurge::mustBePosted | ( | ) |
Indicates whether this module must be called with a POST request.
Reimplemented from ApiBase.
Definition at line 77 of file ApiPurge.php.
References $wgUser.