Interface 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.

Direct known implementers

GuzzleHttp\Promise\Coroutine, GuzzleHttp\Promise\FulfilledPromise, GuzzleHttp\Promise\Promise, GuzzleHttp\Promise\RejectedPromise, GuzzleHttp\Promise\Tests\NotPromiseInstance

Namespace: GuzzleHttp\Promise
Link: https://promisesaplus.com/
Located at src/PromiseInterface.php

Methods summary
`public 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. 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. Returns `GuzzleHttp\Promise\PromiseInterface`
`public 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. 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. Returns `GuzzleHttp\Promise\PromiseInterface`
`public string`	# `getState( )` Get the state of the promise ("pending", "rejected", or "fulfilled"). 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
`public`	# `resolve( mixed $value )` Resolve the promise with the given value. Resolve the promise with the given value. Parameters `$value` Throws RuntimeException if the promise is already resolved.
`public`	# `reject( mixed $reason )` Reject the promise with the given reason. Reject the promise with the given reason. Parameters `$reason` Throws RuntimeException if the promise is already resolved.
`public`	# `cancel( )` Cancels the promise if possible. Cancels the promise if possible. Link https://github.com/promises-aplus/cancellation-spec/issues/7
`public mixed`	# `wait( boolean $unwrap = true )` Waits until the promise completes if possible. 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 `$unwrap` Returns mixed Throws LogicException if the promise has no wait function or if the promise does not settle after waiting.

Constants summary
`string`	`PENDING`	# `'pending'`
`string`	`FULFILLED`	# `'fulfilled'`
`string`	`REJECTED`	# `'rejected'`

Namespaces

Classes

Interfaces

Exceptions

Functions

Interface PromiseInterface

Direct known implementers

Parameters

Returns

Parameters

Returns

Returns

Parameters

Throws

Parameters

Throws

Link

Parameters

Returns

Throws