API module that facilitates deleting pages. More...
Public Member Functions | |
| execute () | |
| Extracts the title, token, and reason from the request parameters and invokes the local delete() function with these as arguments. | |
| 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. | |
| getTokenSalt () | |
| Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token You have also to override needsToken() Value is passed to User::getEditToken. | |
| isWriteMode () | |
| Indicates whether this module requires write mode. | |
| mustBePosted () | |
| Indicates whether this module must be called with a POST request. | |
| needsToken () | |
| Returns whether this module requires a token to execute It is used to show possible errors in action=paraminfo see bug 25248. | |
Static Public Member Functions | |
| static | delete (Page $page, User $user, $token, &$reason=null) |
| We have our own delete() function, since Article.php's implementation is split in two phases. | |
| static | deleteFile (Page $page, User $user, $token, $oldimage, &$reason=null, $suppress=false) |
Static Private Member Functions | |
| static | getPermissionsError ($title, $user, $token) |
Detailed Description
API module that facilitates deleting pages.
The API equivalent of action=delete. Requires API write mode to be enabled.
Definition at line 33 of file ApiDelete.php.
Member Function Documentation
| static ApiDelete::delete | ( | Page $ | page, |
| User $ | user, | ||
| $ | token, | ||
| &$ | reason = null |
||
| ) | [static] |
We have our own delete() function, since Article.php's implementation is split in two phases.
- Parameters:
-
$page Page|WikiPage object to work on $user User doing the action string $token delete token (same as edit token) string | null $reason reason for the deletion. Autogenerated if NULL
- Returns:
- Status|array
Definition at line 105 of file ApiDelete.php.
References $error, $title, $user, array(), and getPermissionsError().
Referenced by deleteFile(), and execute().
| static ApiDelete::deleteFile | ( | Page $ | page, |
| User $ | user, | ||
| $ | token, | ||
| $ | oldimage, | ||
| &$ | reason = null, |
||
| $ | suppress = false |
||
| ) | [static] |
- Parameters:
-
$page WikiPage|Page object to work on $user User doing the action $token $oldimage $reason $suppress bool
- Returns:
- Status|array
Definition at line 137 of file ApiDelete.php.
References $file, $title, array(), delete(), FileDeleteForm\doDelete(), getPermissionsError(), FileDeleteForm\isValidOldSpec(), and RepoGroup\singleton().
Referenced by execute().
Extracts the title, token, and reason from the request parameters and invokes the local delete() function with these as arguments.
It does not make use of the delete function specified by Article.php. If the deletion succeeds, the details of the article deleted and the reason for deletion are added to the result object.
Reimplemented from ApiBase.
Definition at line 42 of file ApiDelete.php.
References $params, $user, array(), delete(), deleteFile(), ApiBase\dieStatus(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), ApiBase\getTitleOrPageId(), ContextSource\getUser(), and ApiBase\setWatch().
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.
Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.
- Returns:
- array|bool
Reimplemented from ApiBase.
Definition at line 173 of file ApiDelete.php.
References array(), ApiBase\PARAM_DEPRECATED, ApiBase\PARAM_DFLT, ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.
Returns the description string for this module.
- Returns:
- mixed string or array of strings
Reimplemented from ApiBase.
Definition at line 229 of file ApiDelete.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 255 of file ApiDelete.php.
References array().
- 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 262 of file ApiDelete.php.
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 205 of file ApiDelete.php.
References array(), and ApiBase\getModulePrefix().
| static ApiDelete::getPermissionsError | ( | $ | title, |
| $ | user, | ||
| $ | token | ||
| ) | [static, private] |
- Returns:
- array
Definition at line 91 of file ApiDelete.php.
Referenced by delete(), and deleteFile().
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 233 of file ApiDelete.php.
References array(), and ApiBase\getTitleOrPageIdErrorMessage().
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 219 of file ApiDelete.php.
References array().
Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token You have also to override needsToken() Value is passed to User::getEditToken.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 251 of file ApiDelete.php.
Indicates whether this module requires write mode.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 169 of file ApiDelete.php.
Indicates whether this module must be called with a POST request.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 165 of file ApiDelete.php.
Returns whether this module requires a token to execute It is used to show possible errors in action=paraminfo see bug 25248.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 247 of file ApiDelete.php.
The documentation for this class was generated from the following file:
- includes/api/ApiDelete.php
