<?php namespace GuzzleHttp\Promise; /** * 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. * * @link https://promisesaplus.com/ */ interface PromiseInterface { const PENDING = 'pending'; const FULFILLED = 'fulfilled'; const REJECTED = 'rejected'; /** * Appends fulfillment and rejection handlers to the promise, and returns * a new promise resolving to the return value of the called handler. * * @param callable $onFulfilled Invoked when the promise fulfills. * @param callable $onRejected Invoked when the promise is rejected. * * @return PromiseInterface */ public function then( callable $onFulfilled = null, callable $onRejected = null ); /** * 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. * * @param callable $onRejected Invoked when the promise is rejected. * * @return PromiseInterface */ public function otherwise(callable $onRejected); /** * 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 string */ public function getState(); /** * Resolve the promise with the given value. * * @param mixed $value * * @throws \RuntimeException if the promise is already resolved. */ public function resolve($value); /** * Reject the promise with the given reason. * * @param mixed $reason * * @throws \RuntimeException if the promise is already resolved. */ public function reject($reason); /** * Cancels the promise if possible. * * @link https://github.com/promises-aplus/cancellation-spec/issues/7 */ public function cancel(); /** * 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. * * @param bool $unwrap * * @return mixed * * @throws \LogicException if the promise has no wait function or if the * promise does not settle after waiting. */ public function wait($unwrap = true); }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
AggregateException.php | File | 380 B | 0644 |
|
CancellationException.php | File | 183 B | 0644 |
|
Coroutine.php | File | 4.24 KB | 0644 |
|
Create.php | File | 2.06 KB | 0644 |
|
Each.php | File | 2.82 KB | 0644 |
|
EachPromise.php | File | 7.6 KB | 0644 |
|
FulfilledPromise.php | File | 1.94 KB | 0644 |
|
Is.php | File | 999 B | 0644 |
|
Promise.php | File | 8.73 KB | 0644 |
|
PromiseInterface.php | File | 2.79 KB | 0644 |
|
PromisorInterface.php | File | 244 B | 0644 |
|
RejectedPromise.php | File | 2.23 KB | 0644 |
|
RejectionException.php | File | 1.19 KB | 0644 |
|
TaskQueue.php | File | 1.89 KB | 0644 |
|
TaskQueueInterface.php | File | 433 B | 0644 |
|
Utils.php | File | 8.5 KB | 0644 |
|
functions.php | File | 9.89 KB | 0644 |
|
functions_include.php | File | 167 B | 0644 |
|