MediaWiki\Extension\Translate\WebService\QueryAggregator Class Reference

Web service utility class. More...

Public Member Functions
	addQuery (TranslationQuery $query)
	Register a query to be run.
	getResponse ( $id)
	Returns a response for a query.
	run ()
	Runs all the queries.

Protected Member Functions
	getMultiHttpQueries (array $queries)
	Formats queries for format used by MultiHttpClient class.

Protected Attributes
array	$queries = []
array	$responses = []
float	$timeout = 0
bool	$hasRun = false

Detailed Description

Web service utility class.

Runs multiple web service queries asynchronously to save time.

Author

Niklas Laxström @license GPL-2.0-or-later

Since

2015.02

Definition at line 17 of file QueryAggregator.php.

Member Function Documentation

addQuery()

MediaWiki\Extension\Translate\WebService\QueryAggregator::addQuery

(

TranslationQuery

$query

)

Register a query to be run.

Returns

mixed Query id that can be used to fetch results.

Definition at line 27 of file QueryAggregator.php.

getMultiHttpQueries()

MediaWiki\Extension\Translate\WebService\QueryAggregator::getMultiHttpQueries ( array $queries )

protected

Formats queries for format used by MultiHttpClient class.

Parameters

TranslationQuery[]

$queries

Returns

array[]

Definition at line 74 of file QueryAggregator.php.

getResponse()

MediaWiki\Extension\Translate\WebService\QueryAggregator::getResponse

(

$id

)

Returns a response for a query.

Parameters

mixed

$id

Query id.

Exceptions

RuntimeException

if called before run() has been called.

Definition at line 39 of file QueryAggregator.php.

run()

MediaWiki\Extension\Translate\WebService\QueryAggregator::run

(

)

Runs all the queries.

Definition at line 48 of file QueryAggregator.php.

Member Data Documentation

$hasRun

bool MediaWiki\Extension\Translate\WebService\QueryAggregator::$hasRun = false

protected

Definition at line 21 of file QueryAggregator.php.

$queries

array MediaWiki\Extension\Translate\WebService\QueryAggregator::$queries = []

protected

Definition at line 18 of file QueryAggregator.php.

$responses

array MediaWiki\Extension\Translate\WebService\QueryAggregator::$responses = []

protected

Definition at line 19 of file QueryAggregator.php.

$timeout

float MediaWiki\Extension\Translate\WebService\QueryAggregator::$timeout = 0

protected

Definition at line 20 of file QueryAggregator.php.

---

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

• src/WebService/QueryAggregator.php