ApiUserrights Class Reference

Inheritance diagram for ApiUserrights:

Collaboration diagram for ApiUserrights:

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.
	mustBePosted ()
	Indicates whether this module must be called with a POST request.
	needsToken ()
	Returns the token type this module requires in order to execute.
Protected Member Functions
	getWebUITokenSalt (array $params)
	Fetch the salt used in the Web UI corresponding to this module.
Private Member Functions
	getUrUser (array $params)
Private Attributes
	$mUser = null

---

Detailed Description

Definition at line 31 of file ApiUserrights.php.

---

Member Function Documentation

ApiUserrights::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 35 of file ApiUserrights.php.

References $form, $params, $result, $user, array(), ApiBase\extractRequestParams(), ContextSource\getContext(), ApiBase\getModuleName(), ApiBase\getResult(), getUrUser(), and list.

ApiUserrights::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 88 of file ApiUserrights.php.

References array(), User\getAllGroups(), ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, and ApiBase\PARAM_TYPE.

ApiUserrights::getDescription

(

)

Returns the description string for this module.

Returns:

string|array

Reimplemented from ApiBase.

Definition at line 124 of file ApiUserrights.php.

ApiUserrights::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

bool|string|array

Reimplemented from ApiBase.

Definition at line 136 of file ApiUserrights.php.

References array().

ApiUserrights::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 143 of file ApiUserrights.php.

ApiUserrights::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 110 of file ApiUserrights.php.

References array().

ApiUserrights::getUrUser

(

array $

params

)

[private]

Parameters:

array

$params

Returns:

User

Definition at line 59 of file ApiUserrights.php.

References $form, $user, ApiBase\dieStatus(), ContextSource\getContext(), and ApiBase\requireOnlyOneParameter().

Referenced by execute(), and getWebUITokenSalt().

ApiUserrights::getWebUITokenSalt

(

array $

params

)

[protected]

Fetch the salt used in the Web UI corresponding to this module.

Only override this if the Web UI uses a token with a non-constant salt.

Since:

1.24

Parameters:

array

$params

All supplied parameters for the module

Returns:

string|array|null

Reimplemented from ApiBase.

Definition at line 132 of file ApiUserrights.php.

References getUrUser().

ApiUserrights::isWriteMode

(

)

Indicates whether this module requires write mode.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 84 of file ApiUserrights.php.

ApiUserrights::mustBePosted

(

)

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

Returns:

bool

Reimplemented from ApiBase.

Definition at line 80 of file ApiUserrights.php.

ApiUserrights::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 128 of file ApiUserrights.php.

---

Member Data Documentation

ApiUserrights::$mUser = null [private]

Definition at line 33 of file ApiUserrights.php.

---

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

• includes/api/ApiUserrights.php