Public Member Functions | |
| __construct (\Exception $exception) | |
| getState () | |
| then (callable $onFulfilled=null, callable $onRejected=null) | |
| wait ($unwrap=true) | |
Additional Inherited Members | |
 Data Fields inherited from Http\Promise\Promise | |
| const | FULFILLED = 'fulfilled' |
| const | PENDING = 'pending' |
| const | REJECTED = 'rejected' |
Detailed Description
A rejected promise.
Definition at line 10 of file php-http/promise/src/RejectedPromise.php.
Constructor & Destructor Documentation
◆ __construct()
| Http\Promise\RejectedPromise::__construct | ( | \Exception | $exception | ) |
- Parameters
-
\Exception $exception
Definition at line 23 of file php-http/promise/src/RejectedPromise.php.
Member Function Documentation
◆ getState()
| Http\Promise\RejectedPromise::getState | ( | ) |
{Returns the state of the promise, one of PENDING, FULFILLED or REJECTED.
- Returns
- string
Implements Http\Promise\Promise.
Definition at line 47 of file php-http/promise/src/RejectedPromise.php.
References Http\Promise\Promise\REJECTED.
◆ then()
| Http\Promise\RejectedPromise::then | ( | callable | $onFulfilled = null, |
| callable | $onRejected = null |
||
| ) |
{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
-
callable $onFulfilled Called when a response will be available. callable $onRejected Called when an exception occurs.
- Returns
- Promise A new resolved promise with value of the executed callback (onFulfilled / onRejected).
Implements Http\Promise\Promise.
Definition at line 31 of file php-http/promise/src/RejectedPromise.php.
◆ wait()
| Http\Promise\RejectedPromise::wait | ( | $unwrap = true | ) |
{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
-
bool $unwrap Whether to return resolved value / throw reason or not
- Returns
- mixed Resolved value, null if $unwrap is set to false
- Exceptions
-
Implements Http\Promise\Promise.
Definition at line 55 of file php-http/promise/src/RejectedPromise.php.
The documentation for this class was generated from the following file:
