Class Utils
Methods Summary
-
static
queue ( GuzzleHttp\Promise\TaskQueueInterface $assign = null )
Get the global task queue used for promise resolution.
-
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
inspect ( GuzzleHttp\Promise\PromiseInterface $promise )
Synchronously waits on a promise to resolve and returns an inspection state array.
-
static
inspectAll ( PromiseInterface[] $promises )
Waits on all of the provided promises, but does not unwrap rejected promises as thrown exception.
-
static
unwrap ( iterable<PromiseInterface> $promises )
Waits on all of the provided promises and returns the fulfilled values.
-
static
all ( mixed $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
some ( int $count, mixed $promises )
Initiate a competitive race between multiple promises or values (values will become immediately fulfilled promises).
-
static
any ( mixed $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.
-
static
settle ( mixed $promises )
Returns a promise that is fulfilled when all of the provided promises have been fulfilled or rejected.
Methods Details
static
GuzzleHttp\Promise\TaskQueueInterface
queue (
GuzzleHttp\Promise\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\Utils::queue()->run(); }
Parameters
GuzzleHttp\Promise\TaskQueueInterface |
$assign = null | Optionally specify a new queue instance. |
Returns
GuzzleHttp\Promise\TaskQueueInterface |
static
GuzzleHttp\Promise\PromiseInterface
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
GuzzleHttp\Promise\PromiseInterface |
static
array
inspect (
GuzzleHttp\Promise\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
GuzzleHttp\Promise\PromiseInterface |
$promise | Promise or value. |
Returns
| array |
static
array
inspectAll (
GuzzleHttp\Promise\PromiseInterface[]
$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
GuzzleHttp\Promise\PromiseInterface[] |
$promises | Traversable of promises to wait upon. |
Returns
| array |
See
static array unwrap ( iterable<PromiseInterface> $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
| iterable<PromiseInterface> | $promises | Iterable of PromiseInterface objects to wait on. |
Returns
| array |
Exceptions
| Exception on error |
| Throwable on error in PHP >=7 |
static
GuzzleHttp\Promise\PromiseInterface
all (
mixed
$promises,
boolean
$recursive = false
)
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. |
| boolean | $recursive = false | If true, resolves new promises that might have been added to the stack during its own resolution. |
Returns
GuzzleHttp\Promise\PromiseInterface |
static
GuzzleHttp\Promise\PromiseInterface
some (
integer
$count,
mixed
$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 promise is rejected with a GuzzleHttp\Promise\AggregateException if the number
of fulfilled promises is less than the desired $count.
Parameters
| integer | $count | Total number of promises. |
| mixed | $promises | Promises or values. |
Returns
GuzzleHttp\Promise\PromiseInterface |
static
GuzzleHttp\Promise\PromiseInterface
any (
mixed
$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
GuzzleHttp\Promise\PromiseInterface |
static
GuzzleHttp\Promise\PromiseInterface
settle (
mixed
$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
GuzzleHttp\Promise\PromiseInterface |