GuzzleHttp\Promise\Utils Class Reference

Static Public Member Functions
static	all ($promises, bool $recursive=false)
	Given an array of promises, return a promise that is fulfilled when all the items in the array are fulfilled.
static	any ($promises)
	Like some(), with 1 as count.
static	inspect (PromiseInterface $promise)
	Synchronously waits on a promise to resolve and returns an inspection state array.
static	inspectAll ($promises)
	Waits on all of the provided promises, but does not unwrap rejected promises as thrown exception.
static	queue (TaskQueueInterface $assign=null)
static	settle ($promises)
	Returns a promise that is fulfilled when all of the provided promises have been fulfilled or rejected.
static	some (int $count, $promises)
	Initiate a competitive race between multiple promises or values (values will become immediately fulfilled promises).
static	task (callable $task)
	Adds a function to run in the task queue when it is next run() and returns a promise that is fulfilled or rejected with the result.
static	unwrap ($promises)
	Waits on all of the provided promises and returns the fulfilled values.

Member Function Documentation

all()

static GuzzleHttp\Promise\Utils::all ( $promises, bool $recursive = false )

static

Given an array of promises, return a promise that is fulfilled when all the items in the array are fulfilled.

The promise's fulfillment value is an array with fulfillment values at respective positions to the original array. If any promise in the array rejects, the returned promise is rejected with the rejection reason.

Parameters

mixed	$promises	Promises or values.
bool	$recursive	If true, resolves new promises that might have been added to the stack during its own resolution.

any()

static GuzzleHttp\Promise\Utils::any ( $promises )

static

Like some(), with 1 as count.

However, if the promise fulfills, the fulfillment value is not an array of 1 but the value directly.

Parameters

mixed

$promises

Promises or values.

inspect()

static GuzzleHttp\Promise\Utils::inspect ( PromiseInterface $promise )

static

Synchronously waits on a promise to resolve and returns an inspection state array.

Returns a state associative array containing a "state" key mapping to a valid promise state. If the state of the promise is "fulfilled", the array will contain a "value" key mapping to the fulfilled value of the promise. If the promise is rejected, the array will contain a "reason" key mapping to the rejection reason of the promise.

Parameters

PromiseInterface

$promise

Promise or value.

inspectAll()

static GuzzleHttp\Promise\Utils::inspectAll ( $promises )

static

Waits on all of the provided promises, but does not unwrap rejected promises as thrown exception.

Returns an array of inspection state arrays.

See also

inspect for the inspection state array format.

Parameters

PromiseInterface[]

$promises

Traversable of promises to wait upon.

settle()

static GuzzleHttp\Promise\Utils::settle ( $promises )

static

Returns a promise that is fulfilled when all of the provided promises have been fulfilled or rejected.

The returned promise is fulfilled with an array of inspection state arrays.

See also

inspect for the inspection state array format.

Parameters

mixed

$promises

Promises or values.

some()

static GuzzleHttp\Promise\Utils::some ( int $count, $promises )

static

Initiate a competitive race between multiple promises or values (values will become immediately fulfilled promises).

When count amount of promises have been fulfilled, the returned promise is fulfilled with an array that contains the fulfillment values of the winners in order of resolution.

This promise is rejected with a {

See also

AggregateException} if the number of fulfilled promises is less than the desired $count.

Parameters

int	$count	Total number of promises.
mixed	$promises	Promises or values.

task()

static GuzzleHttp\Promise\Utils::task ( callable $task )

static

Adds a function to run in the task queue when it is next run() and returns a promise that is fulfilled or rejected with the result.

Parameters

callable

$task

Task function to run.

unwrap()

static GuzzleHttp\Promise\Utils::unwrap ( $promises )

static

Waits on all of the provided promises and returns the fulfilled values.

Returns an array that contains the value of each promise (in the same order the promises were provided). An exception is thrown if any of the promises are rejected.

Parameters

iterable<PromiseInterface>

$promises Iterable of PromiseInterface objects to wait on.

Exceptions

Throwable

on error

---

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

• lib/guzzlehttp/promises/src/Utils.php