Blame | Last modification | View Log | RSS feed
Promise=======A lightweight implementation of[CommonJS Promises/A](http://wiki.commonjs.org/wiki/Promises/A) for PHP.[](http://travis-ci.org/reactphp/promise)[](https://coveralls.io/github/reactphp/promise?branch=master)Table of Contents-----------------1. [Introduction](#introduction)2. [Concepts](#concepts)* [Deferred](#deferred)* [Promise](#promise-1)3. [API](#api)* [Deferred](#deferred-1)* [Deferred::promise()](#deferredpromise)* [Deferred::resolve()](#deferredresolve)* [Deferred::reject()](#deferredreject)* [Deferred::notify()](#deferrednotify)* [PromiseInterface](#promiseinterface)* [PromiseInterface::then()](#promiseinterfacethen)* [ExtendedPromiseInterface](#extendedpromiseinterface)* [ExtendedPromiseInterface::done()](#extendedpromiseinterfacedone)* [ExtendedPromiseInterface::otherwise()](#extendedpromiseinterfaceotherwise)* [ExtendedPromiseInterface::always()](#extendedpromiseinterfacealways)* [ExtendedPromiseInterface::progress()](#extendedpromiseinterfaceprogress)* [CancellablePromiseInterface](#cancellablepromiseinterface)* [CancellablePromiseInterface::cancel()](#cancellablepromiseinterfacecancel)* [Promise](#promise-2)* [FulfilledPromise](#fulfilledpromise)* [RejectedPromise](#rejectedpromise)* [LazyPromise](#lazypromise)* [Functions](#functions)* [resolve()](#resolve)* [reject()](#reject)* [all()](#all)* [race()](#race)* [any()](#any)* [some()](#some)* [map()](#map)* [reduce()](#reduce)* [PromisorInterface](#promisorinterface)4. [Examples](#examples)* [How to use Deferred](#how-to-use-deferred)* [How promise forwarding works](#how-promise-forwarding-works)* [Resolution forwarding](#resolution-forwarding)* [Rejection forwarding](#rejection-forwarding)* [Mixed resolution and rejection forwarding](#mixed-resolution-and-rejection-forwarding)* [Progress event forwarding](#progress-event-forwarding)* [done() vs. then()](#done-vs-then)5. [Install](#install)6. [Credits](#credits)7. [License](#license)Introduction------------Promise is a library implementing[CommonJS Promises/A](http://wiki.commonjs.org/wiki/Promises/A) for PHP.It also provides several other useful promise-related concepts, such as joiningmultiple promises and mapping and reducing collections of promises.If you've never heard about promises before,[read this first](https://gist.github.com/3889970).Concepts--------### DeferredA **Deferred** represents a computation or unit of work that may not havecompleted yet. Typically (but not always), that computation will be somethingthat executes asynchronously and completes at some point in the future.### PromiseWhile a deferred represents the computation itself, a **Promise** representsthe result of that computation. Thus, each deferred has a promise that acts asa placeholder for its actual result.API---### DeferredA deferred represents an operation whose resolution is pending. It has separatepromise and resolver parts.```php$deferred = new React\Promise\Deferred();$promise = $deferred->promise();$deferred->resolve(mixed $value = null);$deferred->reject(mixed $reason = null);$deferred->notify(mixed $update = null);```The `promise` method returns the promise of the deferred.The `resolve` and `reject` methods control the state of the deferred.The deprecated `notify` method is for progress notification.The constructor of the `Deferred` accepts an optional `$canceller` argument.See [Promise](#promise-2) for more information.#### Deferred::promise()```php$promise = $deferred->promise();```Returns the promise of the deferred, which you can hand out to others whilekeeping the authority to modify its state to yourself.#### Deferred::resolve()```php$deferred->resolve(mixed $value = null);```Resolves the promise returned by `promise()`. All consumers are notified byhaving `$onFulfilled` (which they registered via `$promise->then()`) called with`$value`.If `$value` itself is a promise, the promise will transition to the state ofthis promise once it is resolved.#### Deferred::reject()```php$deferred->reject(mixed $reason = null);```Rejects the promise returned by `promise()`, signalling that the deferred'scomputation failed.All consumers are notified by having `$onRejected` (which they registered via`$promise->then()`) called with `$reason`.If `$reason` itself is a promise, the promise will be rejected with the outcomeof this promise regardless whether it fulfills or rejects.#### Deferred::notify()> Deprecated in v2.6.0: Progress support is deprecated and should not be used anymore.```php$deferred->notify(mixed $update = null);```Triggers progress notifications, to indicate to consumers that the computationis making progress toward its result.All consumers are notified by having `$onProgress` (which they registered via`$promise->then()`) called with `$update`.### PromiseInterfaceThe promise interface provides the common interface for all promiseimplementations.A promise represents an eventual outcome, which is either fulfillment (success)and an associated value, or rejection (failure) and an associated reason.Once in the fulfilled or rejected state, a promise becomes immutable.Neither its state nor its result (or error) can be modified.#### Implementations* [Promise](#promise-2)* [FulfilledPromise](#fulfilledpromise) (deprecated)* [RejectedPromise](#rejectedpromise) (deprecated)* [LazyPromise](#lazypromise) (deprecated)#### PromiseInterface::then()```php$transformedPromise = $promise->then(callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null);```Transforms a promise's value by applying a function to the promise's fulfillmentor rejection value. Returns a new promise for the transformed result.The `then()` method registers new fulfilled, rejection and progress handlerswith a promise (all parameters are optional):* `$onFulfilled` will be invoked once the promise is fulfilled and passedthe result as the first argument.* `$onRejected` will be invoked once the promise is rejected and passed thereason as the first argument.* `$onProgress` (deprecated) will be invoked whenever the producer of the promisetriggers progress notifications and passed a single argument (whatever itwants) to indicate progress.It returns a new promise that will fulfill with the return value of either`$onFulfilled` or `$onRejected`, whichever is called, or will reject withthe thrown exception if either throws.A promise makes the following guarantees about handlers registered inthe same call to `then()`:1. Only one of `$onFulfilled` or `$onRejected` will be called,never both.2. `$onFulfilled` and `$onRejected` will never be called morethan once.3. `$onProgress` (deprecated) may be called multiple times.#### See also* [resolve()](#resolve) - Creating a resolved promise* [reject()](#reject) - Creating a rejected promise* [ExtendedPromiseInterface::done()](#extendedpromiseinterfacedone)* [done() vs. then()](#done-vs-then)### ExtendedPromiseInterfaceThe ExtendedPromiseInterface extends the PromiseInterface with useful shortcutand utility methods which are not part of the Promises/A specification.#### Implementations* [Promise](#promise-1)* [FulfilledPromise](#fulfilledpromise) (deprecated)* [RejectedPromise](#rejectedpromise) (deprecated)* [LazyPromise](#lazypromise) (deprecated)#### ExtendedPromiseInterface::done()```php$promise->done(callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null);```Consumes the promise's ultimate value if the promise fulfills, or handles theultimate error.It will cause a fatal error if either `$onFulfilled` or `$onRejected` throw orreturn a rejected promise.Since the purpose of `done()` is consumption rather than transformation,`done()` always returns `null`.#### See also* [PromiseInterface::then()](#promiseinterfacethen)* [done() vs. then()](#done-vs-then)#### ExtendedPromiseInterface::otherwise()```php$promise->otherwise(callable $onRejected);```Registers a rejection handler for promise. It is a shortcut for:```php$promise->then(null, $onRejected);```Additionally, you can type hint the `$reason` argument of `$onRejected` to catchonly specific errors.```php$promise->otherwise(function (\RuntimeException $reason) {// Only catch \RuntimeException instances// All other types of errors will propagate automatically})->otherwise(function ($reason) {// Catch other errors)};```#### ExtendedPromiseInterface::always()```php$newPromise = $promise->always(callable $onFulfilledOrRejected);```Allows you to execute "cleanup" type tasks in a promise chain.It arranges for `$onFulfilledOrRejected` to be called, with no arguments,when the promise is either fulfilled or rejected.* If `$promise` fulfills, and `$onFulfilledOrRejected` returns successfully,`$newPromise` will fulfill with the same value as `$promise`.* If `$promise` fulfills, and `$onFulfilledOrRejected` throws or returns arejected promise, `$newPromise` will reject with the thrown exception orrejected promise's reason.* If `$promise` rejects, and `$onFulfilledOrRejected` returns successfully,`$newPromise` will reject with the same reason as `$promise`.* If `$promise` rejects, and `$onFulfilledOrRejected` throws or returns arejected promise, `$newPromise` will reject with the thrown exception orrejected promise's reason.`always()` behaves similarly to the synchronous finally statement. When combinedwith `otherwise()`, `always()` allows you to write code that is similar to the familiarsynchronous catch/finally pair.Consider the following synchronous code:```phptry {return doSomething();} catch(\Exception $e) {return handleError($e);} finally {cleanup();}```Similar asynchronous code (with `doSomething()` that returns a promise) can bewritten:```phpreturn doSomething()->otherwise('handleError')->always('cleanup');```#### ExtendedPromiseInterface::progress()> Deprecated in v2.6.0: Progress support is deprecated and should not be used anymore.```php$promise->progress(callable $onProgress);```Registers a handler for progress updates from promise. It is a shortcut for:```php$promise->then(null, null, $onProgress);```### CancellablePromiseInterfaceA cancellable promise provides a mechanism for consumers to notify the creatorof the promise that they are not longer interested in the result of anoperation.#### CancellablePromiseInterface::cancel()``` php$promise->cancel();```The `cancel()` method notifies the creator of the promise that there is nofurther interest in the results of the operation.Once a promise is settled (either fulfilled or rejected), calling `cancel()` ona promise has no effect.#### Implementations* [Promise](#promise-1)* [FulfilledPromise](#fulfilledpromise) (deprecated)* [RejectedPromise](#rejectedpromise) (deprecated)* [LazyPromise](#lazypromise) (deprecated)### PromiseCreates a promise whose state is controlled by the functions passed to`$resolver`.```php$resolver = function (callable $resolve, callable $reject, callable $notify) {// Do some work, possibly asynchronously, and then// resolve or reject. You can notify of progress events (deprecated)// along the way if you want/need.$resolve($awesomeResult);// or throw new Exception('Promise rejected');// or $resolve($anotherPromise);// or $reject($nastyError);// or $notify($progressNotification);};$canceller = function () {// Cancel/abort any running operations like network connections, streams etc.// Reject promise by throwing an exceptionthrow new Exception('Promise cancelled');};$promise = new React\Promise\Promise($resolver, $canceller);```The promise constructor receives a resolver function and an optional cancellerfunction which both will be called with 3 arguments:* `$resolve($value)` - Primary function that seals the fate of thereturned promise. Accepts either a non-promise value, or another promise.When called with a non-promise value, fulfills promise with that value.When called with another promise, e.g. `$resolve($otherPromise)`, promise'sfate will be equivalent to that of `$otherPromise`.* `$reject($reason)` - Function that rejects the promise. It is recommended tojust throw an exception instead of using `$reject()`.* `$notify($update)` - Deprecated function that issues progress events for the promise.If the resolver or canceller throw an exception, the promise will be rejectedwith that thrown exception as the rejection reason.The resolver function will be called immediately, the canceller function onlyonce all consumers called the `cancel()` method of the promise.### FulfilledPromise> Deprecated in v2.8.0: External usage of `FulfilledPromise` is deprecated, use `resolve()` instead.Creates a already fulfilled promise.```php$promise = React\Promise\FulfilledPromise($value);```Note, that `$value` **cannot** be a promise. It's recommended to use[resolve()](#resolve) for creating resolved promises.### RejectedPromise> Deprecated in v2.8.0: External usage of `RejectedPromise` is deprecated, use `reject()` instead.Creates a already rejected promise.```php$promise = React\Promise\RejectedPromise($reason);```Note, that `$reason` **cannot** be a promise. It's recommended to use[reject()](#reject) for creating rejected promises.### LazyPromise> Deprecated in v2.8.0: LazyPromise is deprecated and should not be used anymore.Creates a promise which will be lazily initialized by `$factory` once a consumercalls the `then()` method.```php$factory = function () {$deferred = new React\Promise\Deferred();// Do some heavy stuff here and resolve the deferred once completedreturn $deferred->promise();};$promise = new React\Promise\LazyPromise($factory);// $factory will only be executed once we call then()$promise->then(function ($value) {});```### FunctionsUseful functions for creating, joining, mapping and reducing collections ofpromises.All functions working on promise collections (like `all()`, `race()`, `some()`etc.) support cancellation. This means, if you call `cancel()` on the returnedpromise, all promises in the collection are cancelled. If the collection itselfis a promise which resolves to an array, this promise is also cancelled.#### resolve()```php$promise = React\Promise\resolve(mixed $promiseOrValue);```Creates a promise for the supplied `$promiseOrValue`.If `$promiseOrValue` is a value, it will be the resolution value of thereturned promise.If `$promiseOrValue` is a thenable (any object that provides a `then()` method),a trusted promise that follows the state of the thenable is returned.If `$promiseOrValue` is a promise, it will be returned as is.Note: The promise returned is always a promise implementing[ExtendedPromiseInterface](#extendedpromiseinterface). If you pass in a custompromise which only implements [PromiseInterface](#promiseinterface), thispromise will be assimilated to a extended promise following `$promiseOrValue`.#### reject()```php$promise = React\Promise\reject(mixed $promiseOrValue);```Creates a rejected promise for the supplied `$promiseOrValue`.If `$promiseOrValue` is a value, it will be the rejection value of thereturned promise.If `$promiseOrValue` is a promise, its completion value will be the rejectedvalue of the returned promise.This can be useful in situations where you need to reject a promise withoutthrowing an exception. For example, it allows you to propagate a rejection withthe value of another promise.#### all()```php$promise = React\Promise\all(array|React\Promise\PromiseInterface $promisesOrValues);```Returns a promise that will resolve only once all the items in`$promisesOrValues` have resolved. The resolution value of the returned promisewill be an array containing the resolution values of each of the items in`$promisesOrValues`.#### race()```php$promise = React\Promise\race(array|React\Promise\PromiseInterface $promisesOrValues);```Initiates a competitive race that allows one winner. Returns a promise which isresolved in the same way the first settled promise resolves.#### any()```php$promise = React\Promise\any(array|React\Promise\PromiseInterface $promisesOrValues);```Returns a promise that will resolve when any one of the items in`$promisesOrValues` resolves. The resolution value of the returned promisewill be the resolution value of the triggering item.The returned promise will only reject if *all* items in `$promisesOrValues` arerejected. The rejection value will be an array of all rejection reasons.The returned promise will also reject with a `React\Promise\Exception\LengthException`if `$promisesOrValues` contains 0 items.#### some()```php$promise = React\Promise\some(array|React\Promise\PromiseInterface $promisesOrValues, integer $howMany);```Returns a promise that will resolve when `$howMany` of the supplied items in`$promisesOrValues` resolve. The resolution value of the returned promisewill be an array of length `$howMany` containing the resolution values of thetriggering items.The returned promise will reject if it becomes impossible for `$howMany` itemsto resolve (that is, when `(count($promisesOrValues) - $howMany) + 1` itemsreject). The rejection value will be an array of`(count($promisesOrValues) - $howMany) + 1` rejection reasons.The returned promise will also reject with a `React\Promise\Exception\LengthException`if `$promisesOrValues` contains less items than `$howMany`.#### map()```php$promise = React\Promise\map(array|React\Promise\PromiseInterface $promisesOrValues, callable $mapFunc);```Traditional map function, similar to `array_map()`, but allows input to containpromises and/or values, and `$mapFunc` may return either a value or a promise.The map function receives each item as argument, where item is a fully resolvedvalue of a promise or value in `$promisesOrValues`.#### reduce()```php$promise = React\Promise\reduce(array|React\Promise\PromiseInterface $promisesOrValues, callable $reduceFunc , $initialValue = null);```Traditional reduce function, similar to `array_reduce()`, but input may containpromises and/or values, and `$reduceFunc` may return either a value or apromise, *and* `$initialValue` may be a promise or a value for the startingvalue.### PromisorInterfaceThe `React\Promise\PromisorInterface` provides a common interface for objectsthat provide a promise. `React\Promise\Deferred` implements it, but since itis part of the public API anyone can implement it.Examples--------### How to use Deferred```phpfunction getAwesomeResultPromise(){$deferred = new React\Promise\Deferred();// Execute a Node.js-style function using the callback patterncomputeAwesomeResultAsynchronously(function ($error, $result) use ($deferred) {if ($error) {$deferred->reject($error);} else {$deferred->resolve($result);}});// Return the promisereturn $deferred->promise();}getAwesomeResultPromise()->then(function ($value) {// Deferred resolved, do something with $value},function ($reason) {// Deferred rejected, do something with $reason},function ($update) {// Progress notification triggered, do something with $update});```### How promise forwarding worksA few simple examples to show how the mechanics of Promises/A forwarding works.These examples are contrived, of course, and in real usage, promise chains willtypically be spread across several function calls, or even several levels ofyour application architecture.#### Resolution forwardingResolved promises forward resolution values to the next promise.The first promise, `$deferred->promise()`, will resolve with the value passedto `$deferred->resolve()` below.Each call to `then()` returns a new promise that will resolve with the returnvalue of the previous handler. This creates a promise "pipeline".```php$deferred = new React\Promise\Deferred();$deferred->promise()->then(function ($x) {// $x will be the value passed to $deferred->resolve() below// and returns a *new promise* for $x + 1return $x + 1;})->then(function ($x) {// $x === 2// This handler receives the return value of the// previous handler.return $x + 1;})->then(function ($x) {// $x === 3// This handler receives the return value of the// previous handler.return $x + 1;})->then(function ($x) {// $x === 4// This handler receives the return value of the// previous handler.echo 'Resolve ' . $x;});$deferred->resolve(1); // Prints "Resolve 4"```#### Rejection forwardingRejected promises behave similarly, and also work similarly to try/catch:When you catch an exception, you must rethrow for it to propagate.Similarly, when you handle a rejected promise, to propagate the rejection,"rethrow" it by either returning a rejected promise, or actually throwing(since promise translates thrown exceptions into rejections)```php$deferred = new React\Promise\Deferred();$deferred->promise()->then(function ($x) {throw new \Exception($x + 1);})->otherwise(function (\Exception $x) {// Propagate the rejectionthrow $x;})->otherwise(function (\Exception $x) {// Can also propagate by returning another rejectionreturn React\Promise\reject(new \Exception($x->getMessage() + 1));})->otherwise(function ($x) {echo 'Reject ' . $x->getMessage(); // 3});$deferred->resolve(1); // Prints "Reject 3"```#### Mixed resolution and rejection forwardingJust like try/catch, you can choose to propagate or not. Mixing resolutions andrejections will still forward handler results in a predictable way.```php$deferred = new React\Promise\Deferred();$deferred->promise()->then(function ($x) {return $x + 1;})->then(function ($x) {throw new \Exception($x + 1);})->otherwise(function (\Exception $x) {// Handle the rejection, and don't propagate.// This is like catch without a rethrowreturn $x->getMessage() + 1;})->then(function ($x) {echo 'Mixed ' . $x; // 4});$deferred->resolve(1); // Prints "Mixed 4"```#### Progress event forwarding> Deprecated in v2.6.0: Progress support is deprecated and should not be used anymore.In the same way as resolution and rejection handlers, your progress handler**MUST** return a progress event to be propagated to the next link in the chain.If you return nothing, `null` will be propagated.Also in the same way as resolutions and rejections, if you don't register aprogress handler, the update will be propagated through.If your progress handler throws an exception, the exception will be propagatedto the next link in the chain. The best thing to do is to ensure your progresshandlers do not throw exceptions.This gives you the opportunity to transform progress events at each step in thechain so that they are meaningful to the next step. It also allows you to choosenot to transform them, and simply let them propagate untransformed, by notregistering a progress handler.```php$deferred = new React\Promise\Deferred();$deferred->promise()->progress(function ($update) {return $update + 1;})->progress(function ($update) {echo 'Progress ' . $update; // 2});$deferred->notify(1); // Prints "Progress 2"```### done() vs. then()The golden rule is:Either return your promise, or call done() on it.At a first glance, `then()` and `done()` seem very similar. However, there areimportant distinctions.The intent of `then()` is to transform a promise's value and to pass or returna new promise for the transformed value along to other parts of your code.The intent of `done()` is to consume a promise's value, transferringresponsibility for the value to your code.In addition to transforming a value, `then()` allows you to recover from, orpropagate intermediate errors. Any errors that are not handled will be caughtby the promise machinery and used to reject the promise returned by `then()`.Calling `done()` transfers all responsibility for errors to your code. If anerror (either a thrown exception or returned rejection) escapes the`$onFulfilled` or `$onRejected` callbacks you provide to done, it will berethrown in an uncatchable way causing a fatal error.```phpfunction getJsonResult(){return queryApi()->then(// Transform API results to an objectfunction ($jsonResultString) {return json_decode($jsonResultString);},// Transform API errors to an exceptionfunction ($jsonErrorString) {$object = json_decode($jsonErrorString);throw new ApiErrorException($object->errorMessage);});}// Here we provide no rejection handler. If the promise returned has been// rejected, the ApiErrorException will be throwngetJsonResult()->done(// Consume transformed objectfunction ($jsonResultObject) {// Do something with $jsonResultObject});// Here we provide a rejection handler which will either throw while debugging// or log the exceptiongetJsonResult()->done(function ($jsonResultObject) {// Do something with $jsonResultObject},function (ApiErrorException $exception) {if (isDebug()) {throw $exception;} else {logException($exception);}});```Note that if a rejection value is not an instance of `\Exception`, it will bewrapped in an exception of the type `React\Promise\UnhandledRejectionException`.You can get the original rejection reason by calling `$exception->getReason()`.Install-------The recommended way to install this library is [through Composer](https://getcomposer.org).[New to Composer?](https://getcomposer.org/doc/00-intro.md)This project follows [SemVer](https://semver.org/).This will install the latest supported version:```bash$ composer require react/promise:^2.8```See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.This project aims to run on any platform and thus does not require any PHPextensions and supports running on legacy PHP 5.4 through current PHP 7+ and HHVM.It's *highly recommended to use PHP 7+* for this project due to its vastperformance improvements.Credits-------Promise is a port of [when.js](https://github.com/cujojs/when)by [Brian Cavalier](https://github.com/briancavalier).Also, large parts of the documentation have been ported from the when.js[Wiki](https://github.com/cujojs/when/wiki) and the[API docs](https://github.com/cujojs/when/blob/master/docs/api.md).License-------Released under the [MIT](LICENSE) license.