ApiQueryCategories Class Reference
[API]

A query module to enumerate categories the set of pages belong to. More...

Inherits ApiQueryGeneratorBase.

List of all members.

Public Member Functions

 __construct ($query, $moduleName)
 execute ()
 Evaluates the parameters, performs the requested query, and sets up the result.
 executeGenerator ($resultPageSet)
 Execute this module as a generator.
 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.
 getVersion ()
 Returns a string that identifies the version of the extending class.

Protected Member Functions

 getExamples ()
 Returns usage examples for this module.

Private Member Functions

 run ($resultPageSet=null)


Detailed Description

A query module to enumerate categories the set of pages belong to.

Definition at line 36 of file ApiQueryCategories.php.


Constructor & Destructor Documentation

ApiQueryCategories::__construct ( query,
moduleName 
)

Definition at line 38 of file ApiQueryCategories.php.


Member Function Documentation

ApiQueryCategories::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 42 of file ApiQueryCategories.php.

References run().

ApiQueryCategories::executeGenerator ( resultPageSet  ) 

Execute this module as a generator.

Parameters:
$resultPageSet ApiPageSet: All output should be appended to this object

Reimplemented from ApiQueryGeneratorBase.

Definition at line 46 of file ApiQueryCategories.php.

References run().

ApiQueryCategories::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 186 of file ApiQueryCategories.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.

ApiQueryCategories::getDescription (  ) 

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 226 of file ApiQueryCategories.php.

ApiQueryCategories::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 230 of file ApiQueryCategories.php.

ApiQueryCategories::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 216 of file ApiQueryCategories.php.

ApiQueryCategories::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 239 of file ApiQueryCategories.php.

ApiQueryCategories::run ( resultPageSet = null  )  [private]


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

Generated on Sat Sep 5 02:08:31 2009 for MediaWiki by  doxygen 1.5.9