Public Member Functions | |
| encodeParamName ($paramName) | |
| Overrides base class to prepend 'g' to every generator parameter. | |
| executeGenerator ($resultPageSet) | |
| Execute this module as a generator. | |
| setGeneratorMode (ApiPageSet $generatorPageSet) | |
| Switch this module to generator mode. | |
Protected Member Functions | |
| getPageSet () | |
| Get the PageSet object to work on. | |
| setContinueEnumParameter ($paramName, $paramValue) | |
| Overrides base in case of generator & smart continue to notify ApiQueryMain instead of adding them to the result right away. | |
Private Attributes | |
| $mGeneratorPageSet = null | |
Detailed Description
Definition at line 563 of file ApiQueryBase.php.
Member Function Documentation
| ApiQueryGeneratorBase::encodeParamName | ( | $ | paramName | ) |
Overrides base class to prepend 'g' to every generator parameter.
- Parameters:
-
string $paramName Parameter name
- Returns:
- string Prefixed parameter name
Reimplemented from ApiBase.
Definition at line 598 of file ApiQueryBase.php.
| ApiQueryGeneratorBase::executeGenerator | ( | $ | resultPageSet | ) | [abstract] |
Execute this module as a generator.
- Parameters:
-
$resultPageSet ApiPageSet: All output should be appended to this object
Reimplemented in ApiQueryRecentChanges, ApiQueryBacklinks, ApiQueryAllLinks, ApiQueryLinks, ApiQueryAllImages, ApiQueryQueryPage, ApiQueryAllPages, ApiQuerySearch, ApiQueryAllCategories, ApiQueryPagesWithProp, ApiQueryCategories, ApiQueryCategoryMembers, ApiQueryDuplicateFiles, ApiQueryRandom, ApiQueryExtLinksUsage, ApiQueryImages, ApiQueryWatchlist, ApiQueryWatchlistRaw, ApiQueryIWBacklinks, ApiQueryLangBacklinks, and ApiQueryProtectedTitles.
| ApiQueryGeneratorBase::getPageSet | ( | ) | [protected] |
Get the PageSet object to work on.
If this module is generator, the pageSet object is different from other module's
- Returns:
- ApiPageSet
Reimplemented from ApiQueryBase.
Definition at line 586 of file ApiQueryBase.php.
Referenced by ApiQueryImages\run(), ApiQueryDuplicateFiles\run(), ApiQueryCategories\run(), and ApiQueryLinks\run().
| ApiQueryGeneratorBase::setContinueEnumParameter | ( | $ | paramName, |
| $ | paramValue | ||
| ) | [protected] |
Overrides base in case of generator & smart continue to notify ApiQueryMain instead of adding them to the result right away.
- Parameters:
-
string $paramName Parameter name string $paramValue Parameter value
Reimplemented from ApiQueryBase.
Definition at line 612 of file ApiQueryBase.php.
References ApiQueryBase\getQuery().
Referenced by ApiQueryImages\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryProtectedTitles\run(), ApiQueryWatchlistRaw\run(), ApiQueryExtLinksUsage\run(), ApiQueryCategories\run(), ApiQueryDuplicateFiles\run(), ApiQueryAllCategories\run(), ApiQueryCategoryMembers\run(), ApiQueryWatchlist\run(), ApiQueryPagesWithProp\run(), ApiQuerySearch\run(), ApiQueryAllPages\run(), ApiQueryQueryPage\run(), ApiQueryAllImages\run(), ApiQueryLinks\run(), ApiQueryAllLinks\run(), and ApiQueryRecentChanges\run().
| ApiQueryGeneratorBase::setGeneratorMode | ( | ApiPageSet $ | generatorPageSet | ) |
Switch this module to generator mode.
By default, generator mode is switched off and the module acts like a normal query module.
- Since:
- 1.21 requires pageset parameter
- Parameters:
-
$generatorPageSet ApiPageSet object that the module will get by calling getPageSet() when in generator mode.
Definition at line 574 of file ApiQueryBase.php.
References ApiBase\dieDebug().
Member Data Documentation
ApiQueryGeneratorBase::$mGeneratorPageSet = null [private] |
Definition at line 565 of file ApiQueryBase.php.
The documentation for this class was generated from the following file:
- includes/api/ApiQueryBase.php
