Public Member Functions | |
| encodeParamName ($paramName) | |
| Overrides ApiBase 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) | |
| Overridden to set the generator param if in generator mode. | |
Private Attributes | |
| $mGeneratorPageSet = null | |
Detailed Description
Definition at line 657 of file ApiQueryBase.php.
Member Function Documentation
| ApiQueryGeneratorBase::encodeParamName | ( | $ | paramName | ) |
Overrides ApiBase to prepend 'g' to every generator parameter.
- Parameters:
-
string $paramName Parameter name
- Returns:
- string Prefixed parameter name
Reimplemented from ApiBase.
Definition at line 693 of file ApiQueryBase.php.
| ApiQueryGeneratorBase::executeGenerator | ( | $ | resultPageSet | ) | [abstract] |
Execute this module as a generator.
- Parameters:
-
ApiPageSet $resultPageSet All output should be appended to this object
Reimplemented in ApiQueryRecentChanges, ApiQueryAllLinks, ApiQueryBacklinks, ApiQueryBacklinksprop, ApiQueryLinks, ApiQueryAllImages, ApiQueryQueryPage, ApiQueryAllPages, ApiQuerySearch, ApiQueryAllCategories, ApiQueryPagesWithProp, ApiQueryCategories, ApiQueryCategoryMembers, ApiQueryDuplicateFiles, ApiQueryExtLinksUsage, ApiQueryRandom, ApiQueryImages, ApiQueryWatchlist, ApiQueryWatchlistRaw, ApiQueryIWBacklinks, ApiQueryLangBacklinks, ApiQueryProtectedTitles, and ApiQueryPrefixSearch.
| 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 680 of file ApiQueryBase.php.
Referenced by ApiQueryImages\run(), ApiQueryCategories\run(), ApiQueryDuplicateFiles\run(), ApiQueryLinks\run(), and ApiQueryBacklinksprop\run().
| ApiQueryGeneratorBase::setContinueEnumParameter | ( | $ | paramName, |
| $ | paramValue | ||
| ) | [protected] |
Overridden to set the generator param if in generator mode.
- Parameters:
-
string $paramName Parameter name string | array $paramValue Parameter value
Reimplemented from ApiQueryBase.
Definition at line 706 of file ApiQueryBase.php.
References ApiBase\getResult().
Referenced by ApiQueryImages\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryProtectedTitles\run(), ApiQueryWatchlistRaw\run(), ApiQueryExtLinksUsage\run(), ApiQueryDuplicateFiles\run(), ApiQueryCategories\run(), ApiQueryAllCategories\run(), ApiQueryCategoryMembers\run(), ApiQueryPagesWithProp\run(), ApiQueryWatchlist\run(), ApiQueryQueryPage\run(), ApiQuerySearch\run(), ApiQueryAllPages\run(), ApiQueryAllImages\run(), ApiQueryLinks\run(), ApiQueryAllLinks\run(), ApiQueryRecentChanges\run(), and ApiQueryBacklinksprop\setContinue().
| 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:
-
ApiPageSet $generatorPageSet ApiPageSet object that the module will get by calling getPageSet() when in generator mode.
Definition at line 668 of file ApiQueryBase.php.
References ApiBase\dieDebug().
Member Data Documentation
ApiQueryGeneratorBase::$mGeneratorPageSet = null [private] |
Definition at line 659 of file ApiQueryBase.php.
The documentation for this class was generated from the following file:
- includes/api/ApiQueryBase.php
