ApiQueryGeneratorBase Class Reference
[API]

Inherits ApiQueryBase.

Inherited by ApiQueryAllCategories, ApiQueryAllimages, ApiQueryAllLinks, ApiQueryAllpages, ApiQueryBacklinks, ApiQueryCategories, ApiQueryCategoryMembers, ApiQueryDuplicateFiles, ApiQueryExtLinksUsage, ApiQueryImages, ApiQueryLinks, ApiQueryProtectedTitles, ApiQueryRandom, ApiQuerySearch, ApiQueryWatchlist, and ApiQueryWatchlistRaw.

List of all members.

Public Member Functions

 __construct ($query, $moduleName, $paramPrefix= '')
 Constructor.
 setGeneratorMode ()
 Switch this module to generator mode.
 encodeParamName ($paramName)
 Overrides base class to prepend 'g' to every generator parameter.
 executeGenerator ($resultPageSet)
 Execute this module as a generator.

Private Attributes

 $mIsGenerator


Detailed Description

Definition at line 424 of file ApiQueryBase.php.


Constructor & Destructor Documentation

ApiQueryGeneratorBase::__construct ( mainModule,
moduleName,
modulePrefix = '' 
)

Constructor.

Parameters:
$mainModule ApiMain object
$moduleName string Name of this module
$modulePrefix string Prefix to use for parameter names

Reimplemented from ApiQueryBase.

Definition at line 428 of file ApiQueryBase.php.


Member Function Documentation

ApiQueryGeneratorBase::encodeParamName ( paramName  ) 

Overrides base class to prepend 'g' to every generator parameter.

Parameters:
$paramNames string Parameter name
Returns:
string Prefixed parameter name

Reimplemented from ApiBase.

Definition at line 446 of file ApiQueryBase.php.

ApiQueryGeneratorBase::executeGenerator ( resultPageSet  )  [abstract]

ApiQueryGeneratorBase::setGeneratorMode (  ) 

Switch this module to generator mode.

By default, generator mode is switched off and the module acts like a normal query module.

Definition at line 437 of file ApiQueryBase.php.


Member Data Documentation

ApiQueryGeneratorBase::$mIsGenerator [private]

Definition at line 426 of file ApiQueryBase.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