Documentation

PromiseInterface
in

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.

Tags
link
https://promisesaplus.com/

Table of Contents

FULFILLED  = 'fulfilled'
PENDING  = 'pending'
REJECTED  = 'rejected'
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.

Constants

Methods

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
Tags
throws
RuntimeException

if the promise is already resolved.

Return values
mixed

resolve()

Resolve the promise with the given value.

public resolve(mixed $value) : mixed
Parameters
$value : mixed
Tags
throws
RuntimeException

if the promise is already resolved.

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([bool $unwrap = true ]) : 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 : bool = true
Tags
throws
LogicException

if the promise has no wait function or if the promise does not settle after waiting.

Return values
mixed

Search results