Interface PromiseInterface
A promise represents the eventual result of an asynchronous operation.
The primary way of interacting with a promise is through its then method, which registers callbacks to receive either a promise’s eventual value or the reason why the promise cannot be fulfilled.
Direct known implementers
GuzzleHttp\Promise\Coroutine
,
GuzzleHttp\Promise\FulfilledPromise
,
GuzzleHttp\Promise\Promise
,
GuzzleHttp\Promise\RejectedPromise
Methods Summary
-
then ( callable $onFulfilled = null, callable $onRejected = null )
Appends fulfillment and rejection handlers to the promise, and returns a new promise resolving to the return value of the called handler.
-
otherwise ( callable $onRejected )
Appends a rejection handler callback to the promise, and returns a new promise resolving to the return value of the callback if it is called, or to its original fulfillment value if the promise is instead fulfilled.
-
getState ( )
Get the state of the promise ("pending", "rejected", or "fulfilled").
-
resolve ( mixed $value )
Resolve the promise with the given value.
-
reject ( mixed $reason )
Reject the promise with the given reason.
-
cancel ( )
Cancels the promise if possible.
-
wait ( bool $unwrap = true )
Waits until the promise completes if possible.
Methods Details
GuzzleHttp\Promise\PromiseInterface
then (
callable
$onFulfilled = null,
callable
$onRejected = null
)
Appends fulfillment and rejection handlers to the promise, and returns a new promise resolving to the return value of the called handler.
Parameters
callable | $onFulfilled = null | Invoked when the promise fulfills. |
callable | $onRejected = null | Invoked when the promise is rejected. |
Returns
GuzzleHttp\Promise\PromiseInterface |
GuzzleHttp\Promise\PromiseInterface
otherwise (
callable
$onRejected
)
Appends a rejection handler callback to the promise, and returns a new promise resolving to the return value of the callback if it is called, or to its original fulfillment value if the promise is instead fulfilled.
Parameters
callable | $onRejected | Invoked when the promise is rejected. |
Returns
GuzzleHttp\Promise\PromiseInterface |
string getState ( )
Get the state of the promise ("pending", "rejected", or "fulfilled").
The three states can be checked against the constants defined on PromiseInterface: PENDING, FULFILLED, and REJECTED.
Returns
string |
resolve ( mixed $value )
Resolve the promise with the given value.
Parameters
mixed | $value |
Exceptions
RuntimeException if the promise is already resolved. |
reject ( mixed $reason )
Reject the promise with the given reason.
Parameters
mixed | $reason |
Exceptions
RuntimeException if the promise is already resolved. |
cancel ( )
mixed wait ( boolean $unwrap = true )
Waits until the promise completes if possible.
Pass $unwrap as true to unwrap the result of the promise, either returning the resolved value or throwing the rejected exception.
If the promise cannot be waited on, then the promise will be rejected.
Parameters
boolean | $unwrap = true |
Returns
mixed |
Exceptions
LogicException if the promise has no wait function or if the promise does not settle after waiting. |
Constants summary
string |
PENDING
|
#
'pending'
|
string |
FULFILLED
|
#
'fulfilled'
|
string |
REJECTED
|
#
'rejected'
|