MediaWiki REL1_39
|
This manages continuation state. More...
Public Member Functions | |
__construct (ApiBase $module, array $allModules=[], array $generatedModules=[]) | |
addContinueParam (ApiBase $module, $paramName, $paramValue) | |
Set the continuation parameter for a module. | |
addGeneratorContinueParam (ApiBase $module, $paramName, $paramValue) | |
Set the continuation parameter for the generator module. | |
addGeneratorNonContinueParam (ApiBase $module, $paramName, $paramValue) | |
Set the non-continuation parameter for the generator module. | |
getContinuation () | |
Fetch continuation result data. | |
getRawContinuation () | |
Fetch raw continuation data. | |
getRawNonContinuation () | |
Fetch raw non-continuation data. | |
getRunModules () | |
Get the list of modules that should actually be run. | |
getSource () | |
Get the class that created this manager. | |
isGeneratorDone () | |
setContinuationIntoResult (ApiResult $result) | |
Store the continuation data into the result. | |
This manages continuation state.
Definition at line 26 of file ApiContinuationManager.php.
ApiContinuationManager::__construct | ( | ApiBase | $module, |
array | $allModules = [], | ||
array | $generatedModules = [] ) |
ApiBase | $module | Module starting the continuation |
ApiBase[] | $allModules | Contains ApiBase instances that will be executed |
string[] | $generatedModules | Names of modules that depend on the generator |
ApiUsageException |
Definition at line 53 of file ApiContinuationManager.php.
References ApiBase\extractRequestParams(), ApiBase\getMain(), ApiBase\getModuleName(), and ContextSource\getRequest().
ApiContinuationManager::addContinueParam | ( | ApiBase | $module, |
$paramName, | |||
$paramValue ) |
Set the continuation parameter for a module.
ApiBase | $module | |
string | $paramName | |
string | array | $paramValue |
UnexpectedValueException |
Definition at line 127 of file ApiContinuationManager.php.
References ApiBase\encodeParamName(), and ApiBase\getModuleName().
ApiContinuationManager::addGeneratorContinueParam | ( | ApiBase | $module, |
$paramName, | |||
$paramValue ) |
Set the continuation parameter for the generator module.
ApiBase | $module | |
string | $paramName | |
int | string | array | $paramValue |
Definition at line 174 of file ApiContinuationManager.php.
References ApiBase\encodeParamName(), and ApiBase\getModuleName().
ApiContinuationManager::addGeneratorNonContinueParam | ( | ApiBase | $module, |
$paramName, | |||
$paramValue ) |
Set the non-continuation parameter for the generator module.
In case the generator isn't going to be continued, this sets the fields to return.
ApiBase | $module | |
string | $paramName | |
string | array | $paramValue |
Definition at line 159 of file ApiContinuationManager.php.
References ApiBase\encodeParamName(), and ApiBase\getModuleName().
ApiContinuationManager::getContinuation | ( | ) |
Fetch continuation result data.
Definition at line 204 of file ApiContinuationManager.php.
Referenced by setContinuationIntoResult().
ApiContinuationManager::getRawContinuation | ( | ) |
Fetch raw continuation data.
Definition at line 187 of file ApiContinuationManager.php.
ApiContinuationManager::getRawNonContinuation | ( | ) |
Fetch raw non-continuation data.
Definition at line 196 of file ApiContinuationManager.php.
ApiContinuationManager::getRunModules | ( | ) |
Get the list of modules that should actually be run.
Definition at line 116 of file ApiContinuationManager.php.
ApiContinuationManager::getSource | ( | ) |
Get the class that created this manager.
Definition at line 101 of file ApiContinuationManager.php.
ApiContinuationManager::isGeneratorDone | ( | ) |
Definition at line 108 of file ApiContinuationManager.php.
ApiContinuationManager::setContinuationIntoResult | ( | ApiResult | $result | ) |
Store the continuation data into the result.
ApiResult | $result |
Definition at line 266 of file ApiContinuationManager.php.
References ApiResult\addValue(), and getContinuation().