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

Methods


					
	public

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

Appends fulfillment and rejection handlers to the promise, and returns a new promise resolving to the return value of…

Appends fulfillment and rejection handlers to the promise, and returns a new promise resolving to the return value of the called handler.

Parameters

`$onFulfilled`	Invoked when the promise fulfills.
`$onRejected`	Invoked when the promise is rejected.


					
	public

otherwise(callable $onRejected): PromiseInterface

Appends a rejection handler callback to the promise, and returns a new promise resolving to the return value of the…

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

$onRejected

Invoked when the promise is rejected.


					
	public

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.


					
	public

resolve(mixed $value): void

Resolve the promise with the given value.

Throws

RuntimeException

if the promise is already resolved.


					
	public

reject(mixed $reason): void

Reject the promise with the given reason.

Throws

RuntimeException

if the promise is already resolved.


					
	public

cancel(): void

Cancels the promise if possible.


					
	public

wait(bool $unwrap = true): 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.

Throws

LogicException

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

Constants
`public`	`PENDING = 'pending'`	#
`public`	`FULFILLED = 'fulfilled'`	#
`public`	`REJECTED = 'rejected'`	#

Namespaces

Interfaces

Interface GuzzleHttp\Promise\PromiseInterface

Parameters

Parameters

Throws

Throws

Throws