\GuzzleHttpPromise

Interfaces

PromiseInterface	A promise represents the eventual result of an asynchronous operation.
PromisorInterface	Interface used with classes that return a promise.
TaskQueueInterface

Classes

AggregateException	Exception thrown when too many errors occur in the some() or any() methods.
CancellationException	Exception that is set as the reason for a promise that has been cancelled.
Coroutine	Creates a promise that is resolved using a generator that yields values or promises (somewhat similar to C#'s async keyword).
Create
Each
EachPromise	Represents a promise that iterates over many promises and invokes side-effect functions in the process.
FulfilledPromise	A promise that has been fulfilled.
Is
Promise	Promises/A+ implementation that avoids recursion when possible.
RejectedPromise	A promise that has been rejected.
RejectionException	A special exception that is thrown when waiting on a rejected promise.
TaskQueue	A task queue that executes tasks in a FIFO order.
Utils

Namespace hierarchy: GuzzleHttp

\GuzzleHttp\Promise

Functions

all()

all(mixed  $promises, bool  $recursive = false) : \GuzzleHttp\Promise\PromiseInterface

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.

Returns

\GuzzleHttp\Promise\PromiseInterface —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

any()

any(mixed  $promises) : \GuzzleHttp\Promise\PromiseInterface

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

\GuzzleHttp\Promise\PromiseInterface —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

coroutine()

coroutine(callable  $generatorFn) : \GuzzleHttp\Promise\PromiseInterface

Create a new coroutine.

Parameters

callable

$generatorFn

Returns

\GuzzleHttp\Promise\PromiseInterface —

File: serve/vendor/guzzlehttp/promises/src/functions.php
See also
Uses

Tags

package	Application

each()

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

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 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 if needed.

Parameters

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

Returns

\GuzzleHttp\Promise\PromiseInterface —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

each_limit()

each_limit(mixed  $iterable, int|callable  $concurrency, callable  $onFulfilled = null, callable  $onRejected = null) : \GuzzleHttp\Promise\PromiseInterface

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

\GuzzleHttp\Promise\PromiseInterface —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

each_limit_all()

each_limit_all(mixed  $iterable, int|callable  $concurrency, callable  $onFulfilled = null) : \GuzzleHttp\Promise\PromiseInterface

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

\GuzzleHttp\Promise\PromiseInterface —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

exception_for()

exception_for(mixed  $reason) : \Exception|\Throwable

Create an exception for a rejected promise value.

Parameters

mixed

$reason

Returns

\Exception|\Throwable —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

inspect()

inspect(\GuzzleHttp\Promise\PromiseInterface  $promise) : array

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

\GuzzleHttp\Promise\PromiseInterface

$promise

Promise or value.

Returns

array —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

inspect_all()

inspect_all(\GuzzleHttp\Promise\PromiseInterface[]  $promises) : array

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

Returns an array of inspection state arrays.

Parameters

\GuzzleHttp\Promise\PromiseInterface[]

$promises

Traversable of promises to wait upon.

Returns

array —

File: serve/vendor/guzzlehttp/promises/src/functions.php
See also: for the inspection state array format.
Uses

Tags

package	Application

is_fulfilled()

is_fulfilled(\GuzzleHttp\Promise\PromiseInterface  $promise) : bool

Returns true if a promise is fulfilled.

Parameters

\GuzzleHttp\Promise\PromiseInterface

$promise

Returns

bool —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

is_rejected()

is_rejected(\GuzzleHttp\Promise\PromiseInterface  $promise) : bool

Returns true if a promise is rejected.

Parameters

\GuzzleHttp\Promise\PromiseInterface

$promise

Returns

bool —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

is_settled()

is_settled(\GuzzleHttp\Promise\PromiseInterface  $promise) : bool

Returns true if a promise is fulfilled or rejected.

Parameters

\GuzzleHttp\Promise\PromiseInterface

$promise

Returns

bool —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

iter_for()

iter_for(mixed  $value) : \Iterator

Returns an iterator for the given value.

Parameters

mixed

$value

Returns

\Iterator —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

promise_for()

promise_for(mixed  $value) : \GuzzleHttp\Promise\PromiseInterface

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

Parameters

mixed

$value

Promise or value.

Returns

\GuzzleHttp\Promise\PromiseInterface —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

queue()

queue(\GuzzleHttp\Promise\TaskQueueInterface  $assign = null) : \GuzzleHttp\Promise\TaskQueueInterface

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

\GuzzleHttp\Promise\TaskQueueInterface

$assign

Optionally specify a new queue instance.

Returns

\GuzzleHttp\Promise\TaskQueueInterface —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

rejection_for()

rejection_for(mixed  $reason) : \GuzzleHttp\Promise\PromiseInterface

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

\GuzzleHttp\Promise\PromiseInterface —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

settle()

settle(mixed  $promises) : \GuzzleHttp\Promise\PromiseInterface

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

\GuzzleHttp\Promise\PromiseInterface —

File: serve/vendor/guzzlehttp/promises/src/functions.php
See also: for the inspection state array format.
Uses

Tags

package	Application

some()

some(int  $count, mixed  $promises) : \GuzzleHttp\Promise\PromiseInterface

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 \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

\GuzzleHttp\Promise\PromiseInterface —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

task()

task(callable  $task) : \GuzzleHttp\Promise\PromiseInterface

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

\GuzzleHttp\Promise\PromiseInterface —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application

unwrap()

unwrap(iterable<\GuzzleHttp\Promise\PromiseInterface>  $promises) : array

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

$promises

Iterable of PromiseInterface objects to wait on.

Throws

\Exception: on error
\Throwable: on error in PHP >=7

Returns

array —

File: serve/vendor/guzzlehttp/promises/src/functions.php
Uses

Tags

package	Application