Inheritance diagram for ApiFileRevert:

Collaboration diagram for ApiFileRevert:

Public Member Functions
	__construct ($main, $action)
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	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.
	getParamDescription ()
	Returns an array of parameter descriptions.
	getPossibleErrors ()
	Returns a list of all possible errors returned by the module.
	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.
	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.
Protected Member Functions
	checkPermissions ($user)
	Checks that the user has permissions to perform this revert.
	validateParameters ()
	Validate the user parameters and set $this->archiveName and $this->file.
Protected Attributes
	$archiveName
	$file
	$params

Detailed Description

Definition at line 30 of file ApiFileRevert.php.

Constructor & Destructor Documentation

ApiFileRevert::__construct	(	$	main,
		$	action
	)

Definition at line 40 of file ApiFileRevert.php.

Member Function Documentation

ApiFileRevert::checkPermissions ( $ user ) [protected]

Checks that the user has permissions to perform this revert.

Dies with usage message on inadequate permissions.

Parameters:

$user User The user to check.

Definition at line 73 of file ApiFileRevert.php.

References $user, and ApiBase\dieUsageMsg().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiFileRevert::execute ( )

Evaluates the parameters, performs the requested query, and sets up the result.

Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.

The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.

The result data should be stored in the ApiResult object available through getResult().

Reimplemented from ApiBase.

Definition at line 44 of file ApiFileRevert.php.

References $result, checkPermissions(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), ContextSource\getUser(), and validateParameters().

Here is the call graph for this function:

ApiFileRevert::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 or false

Reimplemented from ApiBase.

Definition at line 116 of file ApiFileRevert.php.

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

ApiFileRevert::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 146 of file ApiFileRevert.php.

ApiFileRevert::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: false|string|array

Reimplemented from ApiBase.

Definition at line 172 of file ApiFileRevert.php.

ApiFileRevert::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 or false

Reimplemented from ApiBase.

Definition at line 134 of file ApiFileRevert.php.

References $params.

ApiFileRevert::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 152 of file ApiFileRevert.php.

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

Returns:: bool|string

Reimplemented from ApiBase.

Definition at line 168 of file ApiFileRevert.php.

ApiFileRevert::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 179 of file ApiFileRevert.php.

ApiFileRevert::isWriteMode ( )

Indicates whether this module requires write mode.

Returns:: bool

Reimplemented from ApiBase.

Definition at line 112 of file ApiFileRevert.php.

ApiFileRevert::mustBePosted ( )

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

Returns:: bool

Reimplemented from ApiBase.

Definition at line 108 of file ApiFileRevert.php.

ApiFileRevert::needsToken ( )

Returns whether this module requires a Token to execute.

Returns:: bool

Reimplemented from ApiBase.

Definition at line 164 of file ApiFileRevert.php.

ApiFileRevert::validateParameters ( ) [protected]

Validate the user parameters and set $this->archiveName and $this->file.

Throws an error if validation fails

Definition at line 88 of file ApiFileRevert.php.

References $title, ApiBase\dieUsageMsg(), Title\makeTitleSafe(), RepoGroup\singleton(), and wfLocalFile().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

ApiFileRevert::$archiveName [protected]

Definition at line 36 of file ApiFileRevert.php.

ApiFileRevert::$file [protected]

Definition at line 35 of file ApiFileRevert.php.

ApiFileRevert::$params [protected]

Definition at line 38 of file ApiFileRevert.php.

Referenced by getParamDescription().

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

includes/api/ApiFileRevert.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation