Documentation

Promise

Interfaces, Classes and Traits

PromiseInterface
A promise represents the eventual result of an asynchronous operation.
PromisorInterface
Interface used with classes that return a promise.
TaskQueueInterface
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

Table of Contents

queue()  : TaskQueueInterface
Get the global task queue used for promise resolution.
task()  : 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.
promise_for()  : PromiseInterface
Creates a promise for a value if the value is not a promise.
rejection_for()  : 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.
exception_for()  : Exception|Throwable
Create an exception for a rejected promise value.
iter_for()  : Iterator
Returns an iterator for the given value.
inspect()  : array<string|int, mixed>
Synchronously waits on a promise to resolve and returns an inspection state array.
inspect_all()  : array<string|int, mixed>
Waits on all of the provided promises, but does not unwrap rejected promises as thrown exception.
unwrap()  : array<string|int, mixed>
Waits on all of the provided promises and returns the fulfilled values.
all()  : PromiseInterface
Given an array of promises, return a promise that is fulfilled when all the items in the array are fulfilled.
some()  : PromiseInterface
Initiate a competitive race between multiple promises or values (values will become immediately fulfilled promises).
any()  : 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.
settle()  : PromiseInterface
Returns a promise that is fulfilled when all of the provided promises have been fulfilled or rejected.
each()  : 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.
each_limit()  : PromiseInterface
Like each, but only allows a certain number of outstanding promises at any given time.
each_limit_all()  : 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.
is_fulfilled()  : bool
Returns true if a promise is fulfilled.
is_rejected()  : bool
Returns true if a promise is rejected.
is_settled()  : bool
Returns true if a promise is fulfilled or rejected.
coroutine()  : PromiseInterface
Create a new coroutine.

Functions

queue()

Get the global task queue used for promise resolution.

queue([TaskQueueInterface $assign = null ]) : TaskQueueInterface

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
$assign : TaskQueueInterface = null

Optionally specify a new queue instance.

Tags
deprecated

queue will be removed in guzzlehttp/promises:2.0. Use Utils::queue instead.

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.

task(callable $task) : PromiseInterface
Parameters
$task : callable

Task function to run.

Tags
deprecated

task will be removed in guzzlehttp/promises:2.0. Use Utils::task instead.

promise_for()

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

promise_for(mixed $value) : PromiseInterface
Parameters
$value : mixed

Promise or value.

Tags
deprecated

promise_for will be removed in guzzlehttp/promises:2.0. Use Create::promiseFor instead.

rejection_for()

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.

rejection_for(mixed $reason) : PromiseInterface
Parameters
$reason : mixed

Promise or reason.

Tags
deprecated

rejection_for will be removed in guzzlehttp/promises:2.0. Use Create::rejectionFor instead.

exception_for()

Create an exception for a rejected promise value.

exception_for(mixed $reason) : Exception|Throwable
Parameters
$reason : mixed
Tags
deprecated

exception_for will be removed in guzzlehttp/promises:2.0. Use Create::exceptionFor instead.

iter_for()

Returns an iterator for the given value.

iter_for(mixed $value) : Iterator
Parameters
$value : mixed
Tags
deprecated

iter_for will be removed in guzzlehttp/promises:2.0. Use Create::iterFor instead.

inspect()

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

inspect(PromiseInterface $promise) : array<string|int, mixed>

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
$promise : PromiseInterface

Promise or value.

Tags
deprecated

inspect will be removed in guzzlehttp/promises:2.0. Use Utils::inspect instead.

inspect_all()

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

inspect_all(array<string|int, PromiseInterface$promises) : array<string|int, mixed>

Returns an array of inspection state arrays.

Parameters
$promises : array<string|int, PromiseInterface>

Traversable of promises to wait upon.

Tags
see
inspect

for the inspection state array format.

deprecated

inspect will be removed in guzzlehttp/promises:2.0. Use Utils::inspectAll instead.

unwrap()

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

unwrap(iteratable<string|int, PromiseInterface$promises) : array<string|int, mixed>

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
$promises : iteratable<string|int, PromiseInterface>

Iterable of PromiseInterface objects to wait on.

Tags
throws
Exception

on error

throws
Throwable

on error in PHP >=7

deprecated

unwrap will be removed in guzzlehttp/promises:2.0. Use Utils::unwrap instead.

all()

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

all(mixed $promises[, bool $recursive = false ]) : PromiseInterface

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
$promises : mixed

Promises or values.

$recursive : bool = false

If true, resolves new promises that might have been added to the stack during its own resolution.

Tags
deprecated

all will be removed in guzzlehttp/promises:2.0. Use Utils::all instead.

some()

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

some(int $count, mixed $promises) : PromiseInterface

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 AggregateException if the number of fulfilled promises is less than the desired $count.

Parameters
$count : int

Total number of promises.

$promises : mixed

Promises or values.

Tags
deprecated

some will be removed in guzzlehttp/promises:2.0. Use Utils::some instead.

any()

Like some(), with 1 as count. However, if the promise fulfills, the fulfillment value is not an array of 1 but the value directly.

any(mixed $promises) : PromiseInterface
Parameters
$promises : mixed

Promises or values.

Tags
deprecated

any will be removed in guzzlehttp/promises:2.0. Use Utils::any instead.

settle()

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

settle(mixed $promises) : PromiseInterface

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

Parameters
$promises : mixed

Promises or values.

Tags
see
inspect

for the inspection state array format.

deprecated

settle will be removed in guzzlehttp/promises:2.0. Use Utils::settle instead.

each()

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.

each(mixed $iterable[, callable $onFulfilled = null ][, callable $onRejected = null ]) : PromiseInterface

$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
$iterable : mixed

Iterator or array to iterate over.

$onFulfilled : callable = null
$onRejected : callable = null
Tags
deprecated

each will be removed in guzzlehttp/promises:2.0. Use Each::of instead.

each_limit()

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

each_limit(mixed $iterable, int|callable $concurrency[, callable $onFulfilled = null ][, callable $onRejected = null ]) : PromiseInterface

$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
$iterable : mixed
$concurrency : int|callable
$onFulfilled : callable = null
$onRejected : callable = null
Tags
deprecated

each_limit will be removed in guzzlehttp/promises:2.0. Use Each::ofLimit instead.

each_limit_all()

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.

each_limit_all(mixed $iterable, int|callable $concurrency[, callable $onFulfilled = null ]) : PromiseInterface
Parameters
$iterable : mixed
$concurrency : int|callable
$onFulfilled : callable = null
Tags
deprecated

each_limit_all will be removed in guzzlehttp/promises:2.0. Use Each::ofLimitAll instead.

is_fulfilled()

Returns true if a promise is fulfilled.

is_fulfilled(PromiseInterface $promise) : bool
Parameters
$promise : PromiseInterface
Tags
deprecated

is_fulfilled will be removed in guzzlehttp/promises:2.0. Use Is::fulfilled instead.

is_rejected()

Returns true if a promise is rejected.

is_rejected(PromiseInterface $promise) : bool
Parameters
$promise : PromiseInterface
Tags
deprecated

is_rejected will be removed in guzzlehttp/promises:2.0. Use Is::rejected instead.

is_settled()

Returns true if a promise is fulfilled or rejected.

is_settled(PromiseInterface $promise) : bool
Parameters
$promise : PromiseInterface
Tags
deprecated

is_settled will be removed in guzzlehttp/promises:2.0. Use Is::settled instead.

coroutine()

Create a new coroutine.

coroutine(callable $generatorFn) : PromiseInterface
Parameters
$generatorFn : callable
Tags
see
Coroutine
deprecated

coroutine will be removed in guzzlehttp/promises:2.0. Use Coroutine::of instead.

Search results