MediaWiki  REL1_19
Public Member Functions | Protected Member Functions | Protected Attributes
ApiQueryBlocks Class Reference
API

Query module to enumerate all user blocks. More...

Inheritance diagram for ApiQueryBlocks:
Inheritance graph
[legend]
Collaboration diagram for ApiQueryBlocks:
Collaboration graph
[legend]

List of all members.

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.
 getDescription ()
 Returns the description string for this module.
 getExamples ()
 Returns usage examples for this module.
 getHelpUrls ()
 getParamDescription ()
 Returns an array of parameter descriptions.
 getPossibleErrors ()
 getVersion ()
 Returns a string that identifies the version of the extending class.

Protected Member Functions

 prepareUsername ($user)

Protected Attributes

 $usernames

Detailed Description

Query module to enumerate all user blocks.

Definition at line 32 of file ApiQueryBlocks.php.

Constructor & Destructor Documentation

ApiQueryBlocks::__construct ( $  query,
$  moduleName 
)

Definition at line 39 of file ApiQueryBlocks.php.

Member Function Documentation

ApiQueryBlocks::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 43 of file ApiQueryBlocks.php.

References $count, $res, $result, $wgContLang, ApiQueryBase\addFields(), ApiQueryBase\addFieldsIf(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addTimestampWhereRange(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), ApiQueryBase\addWhereIf(), ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ApiQueryBase\getDB(), ApiBase\getModuleName(), ApiBase\getResult(), ContextSource\getUser(), IP\hexToQuad(), IP\parseCIDR(), prepareUsername(), Block\purgeExpired(), ApiBase\requireMaxOneParameter(), ApiQueryBase\select(), ApiQueryBase\setContinueEnumParameter(), IP\toHex(), wfBaseConvert(), and wfTimestamp().

Here is the call graph for this function:

ApiQueryBlocks::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 227 of file ApiQueryBlocks.php.

References 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.

ApiQueryBlocks::getDescription ( )

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 320 of file ApiQueryBlocks.php.

ApiQueryBlocks::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:
false|string|array

Reimplemented from ApiBase.

Definition at line 334 of file ApiQueryBlocks.php.

ApiQueryBlocks::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 341 of file ApiQueryBlocks.php.

ApiQueryBlocks::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 289 of file ApiQueryBlocks.php.

References ApiQueryBase\getDirectionDescription(), and ApiBase\getModulePrefix().

Here is the call graph for this function:

ApiQueryBlocks::getPossibleErrors ( )
Returns:
array

Reimplemented from ApiQueryBase.

Definition at line 324 of file ApiQueryBlocks.php.

References ApiBase\getRequireOnlyOneParameterErrorMessages().

Here is the call graph for this function:

ApiQueryBlocks::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 345 of file ApiQueryBlocks.php.

ApiQueryBlocks::prepareUsername ( $  user) [protected]

Definition at line 214 of file ApiQueryBlocks.php.

References $user, ApiBase\dieUsage(), User\getCanonicalName(), and User\isIP().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

ApiQueryBlocks::$usernames [protected]

Definition at line 37 of file ApiQueryBlocks.php.

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