Query module to enumerate all registered users. More...
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. | |
| getPossibleErrors () | |
| getResultProperties () | |
| Returns possible properties in the result, grouped by the value of the prop parameter that shows them. | |
Private Member Functions | |
| getCanonicalUserName ($name) | |
| This function converts the user name to a canonical form which is stored in the database. | |
Detailed Description
Query module to enumerate all registered users.
Definition at line 32 of file ApiQueryAllUsers.php.
Constructor & Destructor Documentation
| ApiQueryAllUsers::__construct | ( | $ | query, |
| $ | moduleName | ||
| ) |
Definition at line 33 of file ApiQueryAllUsers.php.
References $query.
Member Function Documentation
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 47 of file ApiQueryAllUsers.php.
References $count, $dir, $exclude, $limit, $params, $res, $result, $timestamp, ApiQueryBase\addFields(), ApiQueryBase\addFieldsIf(), ApiQueryBase\addJoinConds(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereRange(), array(), as, ApiBase\dieDebug(), ApiBase\dieUsage(), ApiBase\extractRequestParams(), User\getAllGroups(), getCanonicalUserName(), ApiQueryBase\getDB(), User\getGroupPermissions(), User\getGroupsWithPermission(), ApiBase\getModuleName(), ApiBase\getResult(), global, User\newFromId(), ApiQueryBase\select(), ApiQueryBase\setContinueEnumParameter(), ApiQueryBase\showHiddenUsersAddBlockInfo(), and wfTimestamp().
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 313 of file ApiQueryAllUsers.php.
References array(), User\getAllGroups(), User\getAllRights(), ApiBase\LIMIT_BIG1, ApiBase\LIMIT_BIG2, ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_MAX, ApiBase\PARAM_MAX2, ApiBase\PARAM_MIN, and ApiBase\PARAM_TYPE.
| ApiQueryAllUsers::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 309 of file ApiQueryAllUsers.php.
| ApiQueryAllUsers::getCanonicalUserName | ( | $ | name | ) | [private] |
This function converts the user name to a canonical form which is stored in the database.
- Parameters:
-
string $name
- Returns:
- String
Definition at line 43 of file ApiQueryAllUsers.php.
References $name.
Referenced by execute().
Returns the description string for this module.
- Returns:
- mixed string or array of strings
Reimplemented from ApiBase.
Definition at line 428 of file ApiQueryAllUsers.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 438 of file ApiQueryAllUsers.php.
References array().
- 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 444 of file ApiQueryAllUsers.php.
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 361 of file ApiQueryAllUsers.php.
- Returns:
- array
Reimplemented from ApiQueryBase.
Definition at line 432 of file ApiQueryAllUsers.php.
References array().
Returns possible properties in the result, grouped by the value of the prop parameter that shows them.
Properties that are shown always are in a group with empty string as a key. Properties that can be shown by several values of prop are included multiple times. If some properties are part of a list and some are on the root object (see ApiQueryQueryPage), those on the root object are under the key PROP_ROOT. The array can also contain a boolean under the key PROP_LIST, indicating whether the result is a list.
Don't call this function directly: use getFinalResultProperties() to allow hooks to modify descriptions as needed.
- Returns:
- array|bool False on no properties
Reimplemented from ApiBase.
Definition at line 386 of file ApiQueryAllUsers.php.
References array(), ApiBase\PROP_NULLABLE, and ApiBase\PROP_TYPE.
The documentation for this class was generated from the following file:
- includes/api/ApiQueryAllUsers.php
