Inherited by ApiQueryAllCategories, ApiQueryAllimages, ApiQueryAllLinks, ApiQueryAllpages, ApiQueryBacklinks, ApiQueryCategories, ApiQueryCategoryMembers, ApiQueryDuplicateFiles, ApiQueryExtLinksUsage, ApiQueryImages, ApiQueryLinks, ApiQueryProtectedTitles, ApiQueryRandom, ApiQuerySearch, ApiQueryWatchlist, and ApiQueryWatchlistRaw.
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 | |
Definition at line 424 of file ApiQueryBase.php.
| ApiQueryGeneratorBase::__construct | ( | $ | mainModule, | |
| $ | moduleName, | |||
| $ | modulePrefix = '' | |||
| ) |
Constructor.
| $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.
| ApiQueryGeneratorBase::encodeParamName | ( | $ | paramName | ) |
Overrides base class to prepend 'g' to every generator parameter.
| $paramNames | string Parameter name |
Reimplemented from ApiBase.
Definition at line 446 of file ApiQueryBase.php.
| ApiQueryGeneratorBase::executeGenerator | ( | $ | resultPageSet | ) | [abstract] |
Execute this module as a generator.
| $resultPageSet | ApiPageSet: All output should be appended to this object |
Reimplemented in ApiQueryAllCategories, ApiQueryAllimages, ApiQueryAllLinks, ApiQueryAllpages, ApiQueryBacklinks, ApiQueryCategories, ApiQueryCategoryMembers, ApiQueryDuplicateFiles, ApiQueryExtLinksUsage, ApiQueryImages, ApiQueryLinks, ApiQueryProtectedTitles, ApiQueryRandom, ApiQuerySearch, ApiQueryWatchlist, and ApiQueryWatchlistRaw.
| 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.
ApiQueryGeneratorBase::$mIsGenerator [private] |
Definition at line 426 of file ApiQueryBase.php.
1.5.9