ApiPatrol Class Reference

Allows user to patrol pages. More...

Inheritance diagram for ApiPatrol:

Collaboration diagram for ApiPatrol:

List of all members.

Public Member Functions
	__construct ($main, $action)
	execute ()
	Patrols the article or provides the reason the patrol failed.
	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.
	mustBePosted ()
	Indicates whether this module must be called with a POST request.
	needsToken ()
	Returns whether this module requires a Token to execute.

---

Detailed Description

Allows user to patrol pages.

Definition at line 31 of file ApiPatrol.php.

---

Constructor & Destructor Documentation

ApiPatrol::__construct	(	$	main,
		$	action
	)

Definition at line 33 of file ApiPatrol.php.

---

Member Function Documentation

ApiPatrol::execute

(

)

Patrols the article or provides the reason the patrol failed.

Reimplemented from ApiBase.

Definition at line 40 of file ApiPatrol.php.

References $result, ApiQueryBase\addTitleInfo(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), and ContextSource\getUser().

Here is the call graph for this function:

ApiPatrol::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 66 of file ApiPatrol.php.

References ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.

ApiPatrol::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 83 of file ApiPatrol.php.

ApiPatrol::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

false|string|array

Reimplemented from ApiBase.

Definition at line 101 of file ApiPatrol.php.

ApiPatrol::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 107 of file ApiPatrol.php.

ApiPatrol::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 76 of file ApiPatrol.php.

ApiPatrol::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 87 of file ApiPatrol.php.

ApiPatrol::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 97 of file ApiPatrol.php.

ApiPatrol::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 111 of file ApiPatrol.php.

ApiPatrol::isWriteMode

(

)

Indicates whether this module requires write mode.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 62 of file ApiPatrol.php.

ApiPatrol::mustBePosted

(

)

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

Returns:

bool

Reimplemented from ApiBase.

Definition at line 58 of file ApiPatrol.php.

ApiPatrol::needsToken

(

)

Returns whether this module requires a Token to execute.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 93 of file ApiPatrol.php.

---

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

• includes/api/ApiPatrol.php