ApiQueryLinks Class Reference
[API]

A query module to list all wiki links on a given set of pages. 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.

Public Attributes

const LINKS = 'links'
const TEMPLATES = 'templates'

Protected Member Functions

 getExamples ()
 Returns usage examples for this module.

Private Member Functions

 run ($resultPageSet=null)

Private Attributes

 $table
 $prefix
 $description


Detailed Description

A query module to list all wiki links on a given set of pages.

Definition at line 36 of file ApiQueryLinks.php.


Constructor & Destructor Documentation

ApiQueryLinks::__construct ( query,
moduleName 
)

Definition at line 43 of file ApiQueryLinks.php.

References ApiBase::dieDebug(), and table.


Member Function Documentation

ApiQueryLinks::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 63 of file ApiQueryLinks.php.

References run().

ApiQueryLinks::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 67 of file ApiQueryLinks.php.

References run().

ApiQueryLinks::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 164 of file ApiQueryLinks.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.

ApiQueryLinks::getDescription (  ) 

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 191 of file ApiQueryLinks.php.

ApiQueryLinks::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 195 of file ApiQueryLinks.php.

ApiQueryLinks::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 182 of file ApiQueryLinks.php.

ApiQueryLinks::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 206 of file ApiQueryLinks.php.

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


Member Data Documentation

ApiQueryLinks::$description [private]

Definition at line 41 of file ApiQueryLinks.php.

ApiQueryLinks::$prefix [private]

Definition at line 41 of file ApiQueryLinks.php.

ApiQueryLinks::$table [private]

Definition at line 41 of file ApiQueryLinks.php.

const ApiQueryLinks::LINKS = 'links'

Definition at line 38 of file ApiQueryLinks.php.

const ApiQueryLinks::TEMPLATES = 'templates'

Definition at line 39 of file ApiQueryLinks.php.


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

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