GuzzleHttp\Promise\PromiseInterface Interface Reference

Inheritance diagram for GuzzleHttp\Promise\PromiseInterface:

Public Member Functions
	cancel ()
	Cancels the promise if possible.
	getState ()
	Get the state of the promise ("pending", "rejected", or "fulfilled").
	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.
	reject ($reason)
	Reject the promise with the given reason.
	resolve ($value)
	Resolve the promise with the given value.
	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.
	wait ($unwrap=true)
	Waits until the promise completes if possible.

Public Attributes
const	FULFILLED = 'fulfilled'
const	PENDING = 'pending'
const	REJECTED = 'rejected'

Member Function Documentation

cancel()

GuzzleHttp\Promise\PromiseInterface::cancel

(

)

Cancels the promise if possible.

@externalurl https://github.com/promises-aplus/cancellation-spec/issues/7

Implemented in GuzzleHttp\Promise\Coroutine, GuzzleHttp\Promise\FulfilledPromise, GuzzleHttp\Promise\Promise, and GuzzleHttp\Promise\RejectedPromise.

getState()

GuzzleHttp\Promise\PromiseInterface::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.

Return values

string

Implemented in GuzzleHttp\Promise\Coroutine, GuzzleHttp\Promise\FulfilledPromise, GuzzleHttp\Promise\Promise, and GuzzleHttp\Promise\RejectedPromise.

otherwise()

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.

Return values

PromiseInterface

Implemented in GuzzleHttp\Promise\Coroutine, GuzzleHttp\Promise\FulfilledPromise, GuzzleHttp\Promise\Promise, and GuzzleHttp\Promise\RejectedPromise.

reject()

GuzzleHttp\Promise\PromiseInterface::reject

(

$reason

)

Reject the promise with the given reason.

Parameters

mixed

$reason

Exceptions

RuntimeException

if the promise is already resolved.

Implemented in GuzzleHttp\Promise\Coroutine, GuzzleHttp\Promise\FulfilledPromise, GuzzleHttp\Promise\Promise, and GuzzleHttp\Promise\RejectedPromise.

resolve()

GuzzleHttp\Promise\PromiseInterface::resolve

(

$value

)

Resolve the promise with the given value.

Parameters

mixed

$value

Exceptions

RuntimeException

if the promise is already resolved.

Implemented in GuzzleHttp\Promise\Coroutine, GuzzleHttp\Promise\FulfilledPromise, GuzzleHttp\Promise\Promise, and GuzzleHttp\Promise\RejectedPromise.

then()

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	Invoked when the promise fulfills.
callable	$onRejected	Invoked when the promise is rejected.

Return values

PromiseInterface

Implemented in GuzzleHttp\Promise\Coroutine, GuzzleHttp\Promise\FulfilledPromise, GuzzleHttp\Promise\Promise, and GuzzleHttp\Promise\RejectedPromise.

wait()

GuzzleHttp\Promise\PromiseInterface::wait

(

$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

bool

$unwrap

Return values

mixed

Exceptions

LogicException

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

Implemented in GuzzleHttp\Promise\Coroutine, and GuzzleHttp\Promise\Promise.

---

The documentation for this interface was generated from the following file:

• lib/guzzlehttp/promises/src/PromiseInterface.php