API module that facilitates deleting pages. More...

Inheritance diagram for ApiDelete:

Collaboration diagram for ApiDelete:

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.
	isWriteMode ()
	Indicates whether this module requires write mode.
	mustBePosted ()
	Indicates whether this module must be called with a POST request.
	needsToken ()
	Returns the token type this module requires in order to execute.
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 \| WikiPage	$page	Page or WikiPage object to work on
User	$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 113 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	$page	Object to work on
User	$user	User doing the action
string	$token	Delete token (same as edit token)
string	$oldimage	Archive name
string	$reason	Reason for the deletion. Autogenerated if null.
bool	$suppress	Whether to mark all deleted versions as restricted

Returns:: Status|array

Definition at line 146 of file ApiDelete.php.

References $file, $title, array(), 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 41 of file ApiDelete.php.

References $params, $user, array(), delete(), deleteFile(), ApiBase\dieStatus(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), ApiBase\getTitleOrPageId(), ContextSource\getUser(), ApiBase\logFeatureUsage(), 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.

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

References array(), ApiBase\PARAM_DEPRECATED, ApiBase\PARAM_DFLT, and ApiBase\PARAM_TYPE.

ApiDelete::getDescription ( )

Returns the description string for this module.

Returns:: string|array

Reimplemented from ApiBase.

Definition at line 229 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 237 of file ApiDelete.php.

References array().

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

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

References array(), and ApiBase\getModulePrefix().

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

Parameters:

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

Returns:: array

Definition at line 99 of file ApiDelete.php.

References $title, and $user.

Referenced by delete(), and deleteFile().

ApiDelete::isWriteMode ( )

Indicates whether this module requires write mode.

Returns:: bool

Reimplemented from ApiBase.

Definition at line 181 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 177 of file ApiDelete.php.

ApiDelete::needsToken ( )

Returns the token type this module requires in order to execute.

Modules are strongly encouraged to use the core 'csrf' type unless they have specialized security needs. If the token type is not one of the core types, you must use the ApiQueryTokensRegisterTypes hook to register it.

Returning a non-falsey value here will cause self::getFinalParams() to return a required string 'token' parameter and self::getFinalParamDescription() to ensure there is standardized documentation for it. Also, self::mustBePosted() must return true when tokens are used.

In previous versions of MediaWiki, true was a valid return value. Returning true will generate errors indicating that the API module needs updating.

Returns:: string|false

Reimplemented from ApiBase.

Definition at line 233 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

Member Function Documentation