FulfilledPromise
in package
implements
PromiseInterface
A promise that has been fulfilled.
Thenning off of this promise will invoke the onFulfilled callback immediately and ignore other callbacks.
Interfaces, Classes and Traits
- PromiseInterface
- A promise represents the eventual result of an asynchronous operation.
Table of Contents
- $value : mixed
- __construct() : mixed
- cancel() : mixed
- Cancels the promise if possible.
- getState() : string
- Get the state of the promise ("pending", "rejected", or "fulfilled").
- otherwise() : PromiseInterface
- 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.
- reject() : mixed
- Reject the promise with the given reason.
- resolve() : mixed
- Resolve the promise with the given value.
- then() : PromiseInterface
- Appends fulfillment and rejection handlers to the promise, and returns a new promise resolving to the return value of the called handler.
- wait() : mixed
- Waits until the promise completes if possible.
Properties
$value
private
mixed
$value
Methods
__construct()
public
__construct(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —cancel()
Cancels the promise if possible.
public
cancel() : mixed
Return values
mixed —getState()
Get the state of the promise ("pending", "rejected", or "fulfilled").
public
getState() : string
The three states can be checked against the constants defined on PromiseInterface: PENDING, FULFILLED, and REJECTED.
Return values
string —otherwise()
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.
public
otherwise(callable $onRejected) : PromiseInterface
Parameters
- $onRejected : callable
-
Invoked when the promise is rejected.
Return values
PromiseInterface —reject()
Reject the promise with the given reason.
public
reject(mixed $reason) : mixed
Parameters
- $reason : mixed
Return values
mixed —resolve()
Resolve the promise with the given value.
public
resolve(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —then()
Appends fulfillment and rejection handlers to the promise, and returns a new promise resolving to the return value of the called handler.
public
then([callable $onFulfilled = null ][, callable $onRejected = null ]) : PromiseInterface
Parameters
- $onFulfilled : callable = null
-
Invoked when the promise fulfills.
- $onRejected : callable = null
-
Invoked when the promise is rejected.
Return values
PromiseInterface —wait()
Waits until the promise completes if possible.
public
wait([mixed $unwrap = true ][, mixed $defaultDelivery = null ]) : mixed
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
- $unwrap : mixed = true
- $defaultDelivery : mixed = null