ApiMove Class Reference

API Module to move pages. More...

Inheritance diagram for ApiMove:

Collaboration diagram for ApiMove:

List of all members.

Public Member Functions
	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.
	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 the token type this module requires in order to execute.

---

Detailed Description

API Module to move pages.

Definition at line 31 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 33 of file ApiMove.php.

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

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.

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

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

ApiMove::getDescription

(

)

Returns the description string for this module.

Returns:

string|array

Reimplemented from ApiBase.

Definition at line 242 of file ApiMove.php.

ApiMove::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

bool|string|array

Reimplemented from ApiBase.

Definition at line 250 of file ApiMove.php.

References array().

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

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

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

ApiMove::isWriteMode

(

)

Indicates whether this module requires write mode.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 184 of file ApiMove.php.

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

Parameters:

Title	$fromTitle
Title	$toTitle
string	$reason
bool	$noredirect

Returns:

array

Definition at line 157 of file ApiMove.php.

References $oldTitle, $retval, $success, array(), as, and ApiBase\parseMsg().

Referenced by execute().

ApiMove::mustBePosted

(

)

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

Returns:

bool

Reimplemented from ApiBase.

Definition at line 180 of file ApiMove.php.

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

---

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

• includes/api/ApiMove.php