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

Inheritance diagram for ApiQueryUsers:

Collaboration diagram for ApiQueryUsers:

Public Member Functions
	__construct (ApiQuery $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.
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.
Static Protected Attributes
static	$publicProps
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	(	ApiQuery $	query,
		$	moduleName
	)

Definition at line 53 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 96 of file ApiQueryUsers.php.

References ContextSource\$context, $n, $name, $params, $res, $result, $t, $tokenFunctions, $user, ApiQueryBase\addFields(), ApiQueryBase\addJoinConds(), ApiQueryBase\addTables(), ApiQueryBase\addWhereFld(), array(), as, ApiBase\extractRequestParams(), User\getCanonicalName(), ContextSource\getContext(), ApiBase\getModuleName(), ApiBase\getResult(), getTokenFunctions(), User\newFromRow(), ApiQueryBase\resetQueryParams(), ApiQueryBase\select(), User\selectFields(), SpecialPage\setContext(), ApiQueryBase\setContinueEnumParameter(), ApiBase\setWarning(), ApiQueryBase\showHiddenUsersAddBlockInfo(), wfTimestamp(), and wfTimestampOrNull().

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.

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

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

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

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

Deprecated:: since 1.20; call User::getAutomaticGroups() directly.

Parameters:

User $user

Returns:: array

Definition at line 287 of file ApiQueryUsers.php.

References $user, and wfDeprecated().

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:

array $params

Returns:: string

Reimplemented from ApiQueryBase.

Definition at line 293 of file ApiQueryUsers.php.

References $params, and array().

ApiQueryUsers::getDescription ( )

Returns the description string for this module.

Returns:: string|array

Reimplemented from ApiBase.

Definition at line 349 of file ApiQueryUsers.php.

ApiQueryUsers::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 353 of file ApiQueryUsers.php.

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

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

References array().

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)

Deprecated:: since 1.24

Returns:: array Array of tokenname => function

Definition at line 64 of file ApiQueryUsers.php.

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

Referenced by execute(), and getAllowedParams().

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

Deprecated:: since 1.24

Parameters:

User $user

Returns:: string

Definition at line 88 of file ApiQueryUsers.php.

References $user, $wgUser, and global.

Member Data Documentation

ApiQueryUsers::$prop

Definition at line 34 of file ApiQueryUsers.php.

ApiQueryUsers::$publicProps [static, protected]

Initial value:

 array(
        
        
        'groups',
        'implicitgroups',
        'rights',
        'editcount',
        'registration',
        'emailable',
        'gender',
    )

Definition at line 41 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

Static Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation