Inheritance diagram for ApiUserrights:

Collaboration diagram for ApiUserrights:

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.
	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.
Private Member Functions
	getUrUser ()
Private Attributes
	$mUser = null

Detailed Description

Definition at line 31 of file ApiUserrights.php.

Constructor & Destructor Documentation

ApiUserrights::__construct	(	$	main,
		$	action
	)

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

References $result, $user, ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), and getUrUser().

Here is the call graph for this function:

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.

Returns:: array or false

Reimplemented from ApiBase.

Definition at line 88 of file ApiUserrights.php.

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

Here is the call graph for this function:

ApiUserrights::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 119 of file ApiUserrights.php.

ApiUserrights::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: false|string|array

Reimplemented from ApiBase.

Definition at line 131 of file ApiUserrights.php.

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

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

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

References getUrUser().

Here is the call graph for this function:

ApiUserrights::getUrUser ( ) [private]

Returns:: User

Definition at line 60 of file ApiUserrights.php.

References $user, ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), and UserrightsPage\fetchUser().

Referenced by execute(), and getTokenSalt().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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 whether this module requires a Token to execute.

Returns:: bool

Reimplemented from ApiBase.

Definition at line 123 of file ApiUserrights.php.

Member Data Documentation

ApiUserrights::$mUser = null [private]

Definition at line 37 of file ApiUserrights.php.

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

includes/api/ApiUserrights.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation