\GuzzleHttp\PromiseFulfilledPromise

A promise that has been fulfilled.

Thenning off of this promise will invoke the onFulfilled callback immediately and ignore other callbacks.

Summary

Methods
Properties
Constants
__construct()
then()
otherwise()
wait()
getState()
resolve()
reject()
cancel()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$value
N/A

Properties

$value

$value : 

Type

Methods

__construct()

__construct(  $value) 

Parameters

$value

then()

then(callable  $onFulfilled = null, callable  $onRejected = null) : \GuzzleHttp\Promise\PromiseInterface

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

Invoked when the promise fulfills.

callable $onRejected

Invoked when the promise is rejected.

Returns

\GuzzleHttp\Promise\PromiseInterface

otherwise()

otherwise(callable  $onRejected) : \GuzzleHttp\Promise\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.

Parameters

callable $onRejected

Invoked when the promise is rejected.

Returns

\GuzzleHttp\Promise\PromiseInterface

wait()

wait(boolean  $unwrap = true,   $defaultDelivery = null) : mixed

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
$defaultDelivery

Returns

mixed

getState()

getState() : string

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()

resolve(mixed  $value) 

Resolve the promise with the given value.

Parameters

mixed $value

reject()

reject(mixed  $reason) 

Reject the promise with the given reason.

Parameters

mixed $reason

cancel()

cancel() 

Cancels the promise if possible.