Query module to get information about a list of users. More...

Inheritance diagram for ApiQueryUsers:

Collaboration diagram for ApiQueryUsers:

Public Member Functions
	__construct ($query, $moduleName)
	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.
	getCacheMode ($params)
	Get the cache mode for the data generated by this module.
	getDescription ()
	Returns the description string for this module.
	getExamples ()
	Returns usage examples for this module.
	getHelpUrls ()
	getParamDescription ()
	Returns an array of parameter descriptions.
	getVersion ()
	Returns a string that identifies the version of the extending class.
Static Public Member Functions
static	getAutoGroups ($user)
	Gets all the groups that a user is automatically a member of (implicit groups)
static	getUserrightsToken ($user)
Public Attributes
	$prop
Protected Member Functions
	getTokenFunctions ()
	Get an array mapping token names to their handler functions.
Private Attributes
	$tokenFunctions

Detailed Description

Query module to get information about a list of users.

Definition at line 32 of file ApiQueryUsers.php.

Constructor & Destructor Documentation

ApiQueryUsers::__construct	(	$	query,
		$	moduleName
	)

Definition at line 36 of file ApiQueryUsers.php.

Member Function Documentation

ApiQueryUsers::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 75 of file ApiQueryUsers.php.

References $n, $res, $result, $t, $tokenFunctions, $user, ApiQueryBase\addFields(), ApiQueryBase\addJoinConds(), ApiQueryBase\addTables(), ApiQueryBase\addWhereFld(), ApiBase\extractRequestParams(), UserrightsPage\fetchUser(), getAutoGroups(), User\getCanonicalName(), User\getGroupPermissions(), ApiBase\getModuleName(), ApiBase\getResult(), getTokenFunctions(), User\newFromRow(), ApiQueryBase\select(), ApiQueryBase\setContinueEnumParameter(), ApiBase\setWarning(), ApiQueryBase\showHiddenUsersAddBlockInfo(), and wfTimestampOrNull().

Here is the call graph for this function:

ApiQueryUsers::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 272 of file ApiQueryUsers.php.

References getTokenFunctions(), ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, and ApiBase\PARAM_TYPE.

Here is the call graph for this function:

static ApiQueryUsers::getAutoGroups ( $ user ) [static]

Gets all the groups that a user is automatically a member of (implicit groups)

Parameters:

$user User

Returns:: array

Definition at line 253 of file ApiQueryUsers.php.

References $user, and Autopromote\getAutopromoteGroups().

Referenced by ApiQueryAllUsers\execute(), execute(), and ApiQueryUserInfo\getCurrentUserInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQueryUsers::getCacheMode ( $ params )

Get the cache mode for the data generated by this module.

Override this in the module subclass. For possible return values and other details about cache modes, see ApiMain::setCacheMode()

Public caching will only be allowed if *all* the modules that supply data for a given request return a cache mode of public.

Parameters:

$params

Returns:: string

Reimplemented from ApiQueryBase.

Definition at line 264 of file ApiQueryUsers.php.

ApiQueryUsers::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 316 of file ApiQueryUsers.php.

ApiQueryUsers::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: false|string|array

Reimplemented from ApiBase.

Definition at line 320 of file ApiQueryUsers.php.

ApiQueryUsers::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 324 of file ApiQueryUsers.php.

ApiQueryUsers::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 298 of file ApiQueryUsers.php.

ApiQueryUsers::getTokenFunctions ( ) [protected]

Get an array mapping token names to their handler functions.

The prototype for a token function is func($user) it should return a token or false (permission denied)

Returns:: Array tokenname => function

Definition at line 46 of file ApiQueryUsers.php.

References ApiBase\getMain(), ContextSource\getRequest(), and wfRunHooks().

Referenced by execute(), and getAllowedParams().

Here is the call graph for this function:

Here is the caller graph for this function:

static ApiQueryUsers::getUserrightsToken ( $ user ) [static]

Parameters:

$user User

Returns:: String

Definition at line 68 of file ApiQueryUsers.php.

References $user, and $wgUser.

ApiQueryUsers::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 328 of file ApiQueryUsers.php.

Member Data Documentation

ApiQueryUsers::$prop

Definition at line 34 of file ApiQueryUsers.php.

ApiQueryUsers::$tokenFunctions [private]

Definition at line 34 of file ApiQueryUsers.php.

Referenced by execute().

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

includes/api/ApiQueryUsers.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation