Interface Http\Promise\Promise

Promise represents a value that may not be available yet, but will be resolved at some point in future. It acts like a proxy to the actual value.

This interface is an extension of the promises/a+ specification.

Methods


					
	public

then(callable|null $onFulfilled = null, callable|null $onRejected = null): Promise

Adds behavior for when the promise is resolved or rejected (response will be available, or error happens).

If you do not care about one of the cases, you can set the corresponding callable to null The callback will be called when the value arrived and never more than once.

Parameters

`$onFulfilled`	called when a response will be available
`$onRejected`	called when an exception occurs

Returns

a new resolved promise with value of the executed callback (onFulfilled / onRejected)


					
	public

getState(): string

Returns the state of the promise, one of PENDING, FULFILLED or REJECTED.


					
	public

wait(bool $unwrap = true): ($unwrap is true ? mixed : null)

Wait for the promise to be fulfilled or rejected.

When this method returns, the request has been resolved and if callables have been specified, the appropriate one has terminated.

When $unwrap is true (the default), the response is returned, or the exception thrown on failure. Otherwise, nothing is returned or thrown.

Parameters

$unwrap

Whether to return resolved value / throw reason or not

Returns

Resolved value, null if $unwrap is set to false

Throws

Throwable

the rejection reason if $unwrap is set to true and the request failed

Constants
`public`	`PENDING = 'pending'` Promise has not been fulfilled or rejected. Promise has not been fulfilled or rejected.	#
`public`	`FULFILLED = 'fulfilled'` Promise has been fulfilled. Promise has been fulfilled.	#
`public`	`REJECTED = 'rejected'` Promise has been rejected. Promise has been rejected.	#

Namespaces

Interfaces

Interface Http\Promise\Promise

Parameters

Returns

Parameters

Returns

Throws