GuzzleHttp\Promise Namespace Reference

Data Structures
class	AggregateException
class	CancellationException
class	Coroutine
class	EachPromise
class	FulfilledPromise
class	Promise
interface	PromiseInterface
interface	PromisorInterface
class	RejectedPromise
class	RejectionException
class	TaskQueue
interface	TaskQueueInterface

Functions
	all ($promises)
	any ($promises)
	coroutine (callable $generatorFn)
	each ( $iterable, callable $onFulfilled=null, callable $onRejected=null)
	each_limit ( $iterable, $concurrency, callable $onFulfilled=null, callable $onRejected=null)
	each_limit_all ( $iterable, $concurrency, callable $onFulfilled=null)
	exception_for ($reason)
	inspect (PromiseInterface $promise)
	inspect_all ($promises)
	is_fulfilled (PromiseInterface $promise)
	is_rejected (PromiseInterface $promise)
	is_settled (PromiseInterface $promise)
	iter_for ($value)
	promise_for ($value)
	queue (TaskQueueInterface $assign=null)
	rejection_for ($reason)
	settle ($promises)
	some ($count, $promises)
	task (callable $task)
	unwrap ($promises)

Function Documentation

all()

GuzzleHttp\Promise\all

(

$promises

)

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.

Returns

PromiseInterface

Definition at line 219 of file guzzlehttp/promises/src/functions.php.

References GuzzleHttp\Promise\each(), and GuzzleHttp\Promise\Promise\then().

any()

GuzzleHttp\Promise\any

(

$promises

)

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.

Returns

PromiseInterface

Definition at line 293 of file guzzlehttp/promises/src/functions.php.

References GuzzleHttp\Promise\some().

Referenced by GuzzleHttp\default_ca_bundle().

coroutine()

GuzzleHttp\Promise\coroutine

(

callable

$generatorFn

)

See also

Coroutine

Parameters

callable

$generatorFn

Returns

PromiseInterface

Definition at line 454 of file guzzlehttp/promises/src/functions.php.

each()

GuzzleHttp\Promise\each	(		$iterable,
		callable	$onFulfilled = null,
		callable	$onRejected = null
	)

Given an iterator that yields promises or values, returns a promise that is fulfilled with a null value when the iterator has been consumed or the aggregate promise has been fulfilled or rejected.

$onFulfilled is a function that accepts the fulfilled value, iterator index, and the aggregate promise. The callback can invoke any necessary side effects and choose to resolve or reject the aggregate promise if needed.

$onRejected is a function that accepts the rejection reason, iterator index, and the aggregate promise. The callback can invoke any necessary side effects and choose to resolve or reject the aggregate promise if needed.

Parameters

mixed	$iterable	Iterator or array to iterate over.
callable	$onFulfilled
callable	$onRejected

Returns

PromiseInterface

Definition at line 346 of file guzzlehttp/promises/src/functions.php.

Referenced by GuzzleHttp\Pool\__construct(), GuzzleHttp\Promise\all(), GuzzleHttp\Pool\promise(), GuzzleHttp\Promise\settle(), and GuzzleHttp\Promise\some().

each_limit()

GuzzleHttp\Promise\each_limit	(		$iterable,
			$concurrency,
		callable	$onFulfilled = null,
		callable	$onRejected = null
	)

Like each, but only allows a certain number of outstanding promises at any given time.

$concurrency may be an integer or a function that accepts the number of pending promises and returns a numeric concurrency limit value to allow for dynamic a concurrency size.

Parameters

mixed	$iterable
int | callable	$concurrency
callable	$onFulfilled
callable	$onRejected

Returns

PromiseInterface

Definition at line 372 of file guzzlehttp/promises/src/functions.php.

Referenced by GuzzleHttp\Promise\each_limit_all().

each_limit_all()

GuzzleHttp\Promise\each_limit_all	(		$iterable,
			$concurrency,
		callable	$onFulfilled = null
	)

Like each_limit, but ensures that no promise in the given $iterable argument is rejected. If any promise is rejected, then the aggregate promise is rejected with the encountered rejection.

Parameters

mixed	$iterable
int | callable	$concurrency
callable	$onFulfilled

Returns

PromiseInterface

Definition at line 396 of file guzzlehttp/promises/src/functions.php.

References GuzzleHttp\Promise\each_limit(), and GuzzleHttp\Promise\PromiseInterface\reject().

exception_for()

GuzzleHttp\Promise\exception_for

(

$reason

)

Create an exception for a rejected promise value.

Parameters

mixed

$reason

Returns

\Exception|\Throwable

Definition at line 108 of file guzzlehttp/promises/src/functions.php.

Referenced by GuzzleHttp\Promise\Coroutine\_handleFailure(), GuzzleHttp\Promise\RejectedPromise\wait(), and GuzzleHttp\Promise\Promise\wait().

inspect()

GuzzleHttp\Promise\inspect

(

PromiseInterface

$promise

)

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.

Returns

array

Definition at line 147 of file guzzlehttp/promises/src/functions.php.

References GuzzleHttp\Promise\PromiseInterface\FULFILLED, GuzzleHttp\Promise\RejectionException\getReason(), GuzzleHttp\Promise\PromiseInterface\REJECTED, and GuzzleHttp\Promise\PromiseInterface\wait().

Referenced by GuzzleHttp\Promise\inspect_all().

inspect_all()

GuzzleHttp\Promise\inspect_all

(

$promises

)

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

Returns an array of inspection state arrays.

Parameters

PromiseInterface[]

$promises

Traversable of promises to wait upon.

Returns

array

See also

GuzzleHttp\Promise\inspect for the inspection state array format.

Definition at line 174 of file guzzlehttp/promises/src/functions.php.

References GuzzleHttp\Promise\inspect().

is_fulfilled()

GuzzleHttp\Promise\is_fulfilled

(

PromiseInterface

$promise

)

Returns true if a promise is fulfilled.

Parameters

PromiseInterface

$promise

Returns

bool

Definition at line 418 of file guzzlehttp/promises/src/functions.php.

References GuzzleHttp\Promise\PromiseInterface\FULFILLED, and GuzzleHttp\Promise\PromiseInterface\getState().

is_rejected()

GuzzleHttp\Promise\is_rejected

(

PromiseInterface

$promise

)

Returns true if a promise is rejected.

Parameters

PromiseInterface

$promise

Returns

bool

Definition at line 430 of file guzzlehttp/promises/src/functions.php.

References GuzzleHttp\Promise\PromiseInterface\getState(), and GuzzleHttp\Promise\PromiseInterface\REJECTED.

is_settled()

GuzzleHttp\Promise\is_settled

(

PromiseInterface

$promise

)

Returns true if a promise is fulfilled or rejected.

Parameters

PromiseInterface

$promise

Returns

bool

Definition at line 442 of file guzzlehttp/promises/src/functions.php.

References GuzzleHttp\Promise\PromiseInterface\getState(), and GuzzleHttp\Promise\PromiseInterface\PENDING.

iter_for()

GuzzleHttp\Promise\iter_for

(

$value

)

Returns an iterator for the given value.

Parameters

mixed

$value

Returns

\Iterator

Definition at line 122 of file guzzlehttp/promises/src/functions.php.

Referenced by GuzzleHttp\Promise\EachPromise\__construct().

promise_for()

GuzzleHttp\Promise\promise_for

(

$value

)

Creates a promise for a value if the value is not a promise.

Parameters

mixed

$value

Promise or value.

Returns

PromiseInterface

Definition at line 66 of file guzzlehttp/promises/src/functions.php.

Referenced by GuzzleHttp\Promise\Promise\then().

queue()

GuzzleHttp\Promise\queue

(

TaskQueueInterface

$assign = null

)

Get the global task queue used for promise resolution.

This task queue MUST be run in an event loop in order for promises to be settled asynchronously. It will be automatically run when synchronously waiting on a promise.

while ($eventLoop->isRunning()) { GuzzleHttp\Promise\queue()->run(); }

Parameters

TaskQueueInterface

$assign

Optionally specify a new queue instance.

Returns

TaskQueueInterface

Definition at line 21 of file guzzlehttp/promises/src/functions.php.

Referenced by GuzzleHttp\Handler\MockHandler\__invoke(), GuzzleHttp\Promise\TaskQueue\add(), GuzzleHttp\Handler\MockHandler\append(), GuzzleHttp\Handler\MockHandler\count(), GuzzleHttp\Handler\MockHandler\reset(), GuzzleHttp\Promise\TaskQueue\run(), GuzzleHttp\Promise\task(), GuzzleHttp\Promise\RejectedPromise\then(), and GuzzleHttp\Promise\FulfilledPromise\then().

rejection_for()

GuzzleHttp\Promise\rejection_for

(

$reason

)

Creates a rejected promise for a reason if the reason is not a promise. If the provided reason is a promise, then it is returned as-is.

Parameters

mixed

$reason

Promise or reason.

Returns

PromiseInterface

Definition at line 92 of file guzzlehttp/promises/src/functions.php.

Referenced by GuzzleHttp\Promise\Promise\then().

settle()

GuzzleHttp\Promise\settle

(

$promises

)

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.

Parameters

mixed

$promises

Promises or values.

Returns

PromiseInterface

See also

GuzzleHttp\Promise\inspect for the inspection state array format.

Definition at line 309 of file guzzlehttp/promises/src/functions.php.

References GuzzleHttp\Promise\each(), GuzzleHttp\Promise\PromiseInterface\FULFILLED, GuzzleHttp\Promise\PromiseInterface\REJECTED, GuzzleHttp\Promise\settle(), and GuzzleHttp\Promise\Promise\then().

Referenced by GuzzleHttp\Promise\settle().

some()

GuzzleHttp\Promise\some	(		$count,
			$promises
	)

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 prommise is rejected with a {

See also

GuzzleHttp\Promise\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.

Returns

PromiseInterface

Definition at line 252 of file guzzlehttp/promises/src/functions.php.

References GuzzleHttp\Promise\each(), GuzzleHttp\Promise\PromiseInterface\getState(), GuzzleHttp\Promise\PromiseInterface\PENDING, GuzzleHttp\Promise\PromiseInterface\resolve(), and GuzzleHttp\Promise\Promise\then().

Referenced by GuzzleHttp\Promise\any().

task()

GuzzleHttp\Promise\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.

Parameters

callable

$task

Task function to run.

Returns

PromiseInterface

Definition at line 42 of file guzzlehttp/promises/src/functions.php.

References GuzzleHttp\Promise\queue().

unwrap()

GuzzleHttp\Promise\unwrap

(

$promises

)

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

mixed

$promises

Iterable of PromiseInterface objects to wait on.

Returns

array

Exceptions

Definition at line 197 of file guzzlehttp/promises/src/functions.php.