ApiQueryBlocks Class Reference
[API]

Query module to enumerate all available pages. More...

Inherits ApiQueryBase.

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.
 getParamDescription ()
 Returns an array of parameter descriptions.
 getDescription ()
 Returns the description string for this module.
 getPossibleErrors ()
 Returns a list of all possible errors returned by the module.
 getVersion ()
 Returns a string that identifies the version of the extending class.

Public Attributes

 $users

Protected Member Functions

 prepareUsername ($user)
 getExamples ()
 Returns usage examples for this module.


Detailed Description

Query module to enumerate all available pages.

Definition at line 36 of file ApiQueryBlocks.php.


Constructor & Destructor Documentation

ApiQueryBlocks::__construct ( query,
moduleName 
)

Definition at line 40 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 44 of file ApiQueryBlocks.php.

References $res, $result, $wgUser, ApiQueryBase::addFields(), ApiQueryBase::addOption(), ApiQueryBase::addTables(), ApiQueryBase::addWhere(), ApiQueryBase::addWhereFld(), ApiQueryBase::addWhereRange(), Block::decodeExpiry(), ApiBase::dieUsage(), ApiBase::extractRequestParams(), ApiQueryBase::getDB(), ApiBase::getModuleName(), ApiQueryBase::getPageSet(), ApiBase::getResult(), IP::hexToQuad(), IP::parseCIDR(), prepareUsername(), Block::purgeExpired(), ApiQueryBase::select(), ApiQueryBase::setContinueEnumParameter(), IP::toHex(), wfBaseConvert(), and wfTimestamp().

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

Reimplemented from ApiBase.

Definition at line 200 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 261 of file ApiQueryBlocks.php.

ApiQueryBlocks::getExamples (  )  [protected]

Returns usage examples for this module.

Return null if no examples are available.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

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

Reimplemented from ApiBase.

Definition at line 247 of file ApiQueryBlocks.php.

ApiQueryBlocks::getPossibleErrors (  ) 

Returns a list of all possible errors returned by the module.

Returns:
array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )

Reimplemented from ApiQueryBase.

Definition at line 265 of file ApiQueryBlocks.php.

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

ApiQueryBlocks::prepareUsername ( user  )  [protected]

Definition at line 188 of file ApiQueryBlocks.php.

References $name, ApiBase::dieUsage(), User::getCanonicalName(), and User::isIP().

Referenced by execute().


Member Data Documentation

ApiQueryBlocks::$users

Definition at line 38 of file ApiQueryBlocks.php.


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

Generated on Sat Apr 30 22:57:31 2011 for MediaWiki by  doxygen 1.5.9