API Module to move pages. More...

Inheritance diagram for ApiMove:

Collaboration diagram for ApiMove:

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.
	getHelpUrls ()
	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.
	moveSubpages ($fromTitle, $toTitle, $reason, $noredirect)
	mustBePosted ()
	Indicates whether this module must be called with a POST request.
	needsToken ()
	Returns whether this module requires a Token to execute.

Detailed Description

API Module to move pages.

Definition at line 31 of file ApiMove.php.

Constructor & Destructor Documentation

ApiMove::__construct	(	$	main,
		$	action
	)

Definition at line 33 of file ApiMove.php.

Member Function Documentation

ApiMove::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 37 of file ApiMove.php.

References $result, $user, ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), ContextSource\getUser(), moveSubpages(), Title\newFromID(), Title\newFromText(), ApiBase\parseMsg(), ApiBase\requireOnlyOneParameter(), ApiBase\setWatch(), RepoGroup\singleton(), and wfFindFile().

Here is the call graph for this function:

ApiMove::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 173 of file ApiMove.php.

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

ApiMove::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 227 of file ApiMove.php.

ApiMove::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: false|string|array

Reimplemented from ApiBase.

Definition at line 252 of file ApiMove.php.

ApiMove::getHelpUrls ( )

Returns:: false|string|array Returns a false if the module has no help url, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 258 of file ApiMove.php.

ApiMove::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 209 of file ApiMove.php.

References ApiBase\getModulePrefix().

Here is the call graph for this function:

ApiMove::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 231 of file ApiMove.php.

References ApiBase\getRequireOnlyOneParameterErrorMessages().

Here is the call graph for this function:

ApiMove::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 248 of file ApiMove.php.

ApiMove::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 262 of file ApiMove.php.

ApiMove::isWriteMode ( )

Indicates whether this module requires write mode.

Returns:: bool

Reimplemented from ApiBase.

Definition at line 169 of file ApiMove.php.

ApiMove::moveSubpages	(	$	fromTitle,
		$	toTitle,
		$	reason,
		$	noredirect
	)

Parameters:

Title	$fromTitle
Title	$toTitle
	$reason
	$noredirect

Returns:: array

Definition at line 143 of file ApiMove.php.

References $success, and ApiBase\parseMsg().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiMove::mustBePosted ( )

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

Returns:: bool

Reimplemented from ApiBase.

Definition at line 165 of file ApiMove.php.

ApiMove::needsToken ( )

Returns whether this module requires a Token to execute.

Returns:: bool

Reimplemented from ApiBase.

Definition at line 244 of file ApiMove.php.

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

includes/api/ApiMove.php

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation