MediaWiki  REL1_19
Public Member Functions | Private Attributes
ApiQueryGeneratorBase Class Reference
API
Inheritance diagram for ApiQueryGeneratorBase:
Inheritance graph
[legend]
Collaboration diagram for ApiQueryGeneratorBase:
Collaboration graph
[legend]

List of all members.

Public Member Functions

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

Private Attributes

 $mIsGenerator

Detailed Description

Definition at line 570 of file ApiQueryBase.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters:
$mainModuleApiMain object
$moduleNamestring Name of this module
$modulePrefixstring Prefix to use for parameter names

Reimplemented from ApiBase.

Definition at line 574 of file ApiQueryBase.php.

Member Function Documentation

ApiQueryGeneratorBase::encodeParamName ( $  paramName)

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

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

Reimplemented from ApiBase.

Definition at line 592 of file ApiQueryBase.php.

ApiQueryGeneratorBase::executeGenerator ( $  resultPageSet) [abstract]

Execute this module as a generator.

Parameters:
$resultPageSetApiPageSet: All output should be appended to this object

Reimplemented in ApiQueryRecentChanges, ApiQueryBacklinks, ApiQueryLinks, ApiQueryAllimages, ApiQueryQueryPage, ApiQueryAllpages, ApiQueryAllCategories, ApiQueryAllLinks, ApiQueryCategories, ApiQueryCategoryMembers, ApiQueryDuplicateFiles, ApiQueryExtLinksUsage, ApiQueryRandom, ApiQueryWatchlist, ApiQueryWatchlistRaw, ApiQueryImages, ApiQueryIWBacklinks, ApiQueryLangBacklinks, ApiQueryProtectedTitles, and ApiQuerySearch.

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 583 of file ApiQueryBase.php.

Member Data Documentation

ApiQueryGeneratorBase::$mIsGenerator [private]

Definition at line 572 of file ApiQueryBase.php.

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