ApiContinuationManager Class Reference

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.

Detailed Description

This manages continuation state.

Since

1.25 this is no longer a subclass of ApiBase

Definition at line 26 of file ApiContinuationManager.php.

Constructor & Destructor Documentation

__construct()

ApiContinuationManager::__construct	(	ApiBase	$module,
		array	$allModules = [],
		array	$generatedModules = [] )

Parameters

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

Exceptions

ApiUsageException

Definition at line 53 of file ApiContinuationManager.php.

References ApiBase\extractRequestParams(), ApiBase\getMain(), ApiBase\getModuleName(), and ContextSource\getRequest().

Member Function Documentation

addContinueParam()

ApiContinuationManager::addContinueParam	(	ApiBase	$module,
			$paramName,
			$paramValue )

Set the continuation parameter for a module.

Parameters

ApiBase	$module
string	$paramName
string | array	$paramValue

Exceptions

UnexpectedValueException

Definition at line 127 of file ApiContinuationManager.php.

References ApiBase\encodeParamName(), and ApiBase\getModuleName().

addGeneratorContinueParam()

ApiContinuationManager::addGeneratorContinueParam	(	ApiBase	$module,
			$paramName,
			$paramValue )

Set the continuation parameter for the generator module.

Parameters

ApiBase	$module
string	$paramName
int | string | array	$paramValue

Definition at line 174 of file ApiContinuationManager.php.

References ApiBase\encodeParamName(), and ApiBase\getModuleName().

addGeneratorNonContinueParam()

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.

Since

1.28

Parameters

ApiBase	$module
string	$paramName
string | array	$paramValue

Definition at line 159 of file ApiContinuationManager.php.

References ApiBase\encodeParamName(), and ApiBase\getModuleName().

getContinuation()

ApiContinuationManager::getContinuation

(

)

Fetch continuation result data.

Returns

array [ (array)$data, (bool)$batchcomplete ]

Definition at line 204 of file ApiContinuationManager.php.

Referenced by setContinuationIntoResult().

getRawContinuation()

ApiContinuationManager::getRawContinuation

(

)

Fetch raw continuation data.

Returns

array[]

Definition at line 187 of file ApiContinuationManager.php.

getRawNonContinuation()

ApiContinuationManager::getRawNonContinuation

(

)

Fetch raw non-continuation data.

Since

1.28

Returns

array[]

Definition at line 196 of file ApiContinuationManager.php.

getRunModules()

ApiContinuationManager::getRunModules

(

)

Get the list of modules that should actually be run.

Returns

ApiBase[]

Definition at line 116 of file ApiContinuationManager.php.

getSource()

ApiContinuationManager::getSource

(

)

Get the class that created this manager.

Returns

string

Definition at line 101 of file ApiContinuationManager.php.

isGeneratorDone()

ApiContinuationManager::isGeneratorDone

(

)

Returns

bool

Definition at line 108 of file ApiContinuationManager.php.

setContinuationIntoResult()

ApiContinuationManager::setContinuationIntoResult

(

ApiResult

$result

)

Store the continuation data into the result.

Parameters

ApiResult

$result

Definition at line 266 of file ApiContinuationManager.php.

References ApiResult\addValue(), and getContinuation().

---

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

• includes/api/ApiContinuationManager.php