API module that facilitates deleting pages. More...

Inheritance diagram for ApiDelete:

Collaboration diagram for ApiDelete:

Public Member Functions
	__construct ($main, $action)
	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.
	getVersion ()
	Returns a string that identifies the version of the extending class.
	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.

Constructor & Destructor Documentation

ApiDelete::__construct	(	$	main,
		$	action
	)

Definition at line 35 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	WikiPage object to work on
$user	User doing the action
$token	String: delete token (same as edit token)
$reason	String: reason for the deletion. Autogenerated if NULL

Returns:: Status

Definition at line 107 of file ApiDelete.php.

References $page, $title, $user, and getPermissionsError().

Referenced by deleteFile(), and execute().

static ApiDelete::deleteFile	(	Page $	page,
		User $	user,
		$	token,
		$	oldimage,
		&$	reason = `null`,
		$	suppress = `false`
	)		`[static]`

Parameters:

$page	WikiPage object to work on
$user	User doing the action
$token
$oldimage
$reason
$suppress	bool

Returns:: Status

Definition at line 139 of file ApiDelete.php.

References $file, $title, delete(), FileDeleteForm\doDelete(), getPermissionsError(), FileDeleteForm\isValidOldSpec(), and RepoGroup\singleton().

Referenced by execute().

ApiDelete::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 46 of file ApiDelete.php.

References $params, $user, delete(), deleteFile(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), ApiBase\getTitleOrPageId(), ContextSource\getUser(), and ApiBase\setWatch().

ApiDelete::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|bool

Reimplemented from ApiBase.

Definition at line 175 of file ApiDelete.php.

References ApiBase\PARAM_DEPRECATED, ApiBase\PARAM_DFLT, ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.

ApiDelete::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 231 of file ApiDelete.php.

ApiDelete::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 257 of file ApiDelete.php.

ApiDelete::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 264 of file ApiDelete.php.

ApiDelete::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|bool False on no parameter descriptions

Reimplemented from ApiBase.

Definition at line 207 of file ApiDelete.php.

References ApiBase\getModulePrefix().

static ApiDelete::getPermissionsError	(	$	title,
		$	user,
		$	token
	)		`[static, private]`

Parameters:

$title	Title
$user	User doing the action
$token	String

Returns:: array

Definition at line 93 of file ApiDelete.php.

References $title, and $user.

Referenced by delete(), and deleteFile().

ApiDelete::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 235 of file ApiDelete.php.

References ApiBase\getTitleOrPageIdErrorMessage().

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

Returns:: array|bool False on no properties

Reimplemented from ApiBase.

Definition at line 221 of file ApiDelete.php.

ApiDelete::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.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 253 of file ApiDelete.php.

ApiDelete::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 268 of file ApiDelete.php.

ApiDelete::isWriteMode ( )

Indicates whether this module requires write mode.

Returns:: bool

Reimplemented from ApiBase.

Definition at line 171 of file ApiDelete.php.

ApiDelete::mustBePosted ( )

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

Returns:: bool

Reimplemented from ApiBase.

Definition at line 167 of file ApiDelete.php.

ApiDelete::needsToken ( )

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 249 of file ApiDelete.php.

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

includes/api/ApiDelete.php

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation