NOTE: This package is no longer maintained. Use react/promise instead!
Async utilities for ReactPHP.
It is heavily influenced by async.js.
This library allows you to manage async control flow. It provides a number of combinators for continuation-passing style (aka callbacks). Instead of nesting those callbacks, you can declare them as a list, which is resolved sequentially in an async manner.
React/Async will not automagically change blocking code to be async. You need
to have an actual event loop and non-blocking libraries interacting with that
event loop for it to work. You can use react/event-loop for this, but you
don't have to. As long as you have a callback-based API that runs in an event
loop, it can be used with this library.
You must be running inside an event l C8EB oop for react/async to make any sense whatsoever!
Table of Contents
This lightweight library consists only of a few simple functions.
All functions reside under the React\Async namespace.
The below examples refer to all functions with their fully-qualified names like this:
React\Async\parallel(…);As of PHP 5.6+ you can also import each required function into your code like this:
use function React\Async\parallel;
parallel(…);Alternatively, you can also use an import statement similar to this:
use React\Async;
Async\parallel(…);The parallel(array<callable> $tasks, ?callable $callback = null, ?callable $errback = null): void function can be used
like this:
<?php
use React\EventLoop\Loop;
React\Async\parallel(
array(
function ($callback, $errback) {
Loop::addTimer(1, function () use ($callback) {
$callback('Slept for a whole second');
});
},
function ($callback, $errback) {
Loop::addTimer(1, function () use ($callback) {
$callback('Slept for another whole second');
});
},
function ($callback, $errback) {
Loop::addTimer(1, function () use ($callback) {
$callback('Slept for yet another whole second');
});
},
),
function (array $results) {
foreach ($results as $result) {
var_dump($result);
}
},
function (Exception $e) {
throw $e;
}
);The series(array<callable> $tasks, ?callable $callback = null, ?callable $errback = null): void function can be used
like this:
<?php
use React\EventLoop\Loop;
React\Async\series(
array(
function ($callback, $errback) {
Loop::addTimer(1, function () use ($callback) {
$callback('Slept for a whole second');
});
},
function ($callback, $errback) {
Loop::addTimer(1, function () use ($callback) {
$callback('Slept for another whole second');
});
},
function ($callback, $errback) {
Loop::addTimer(1, function () use ($callback) {
$callback('Slept for yet another whole second');
});
},
),
function (array $results) {
foreach ($results as $result) {
var_dump($result);
}
},
function (Exception $e) {
throw $e;
}
);The waterfall(array<callable> $tasks, ?callable $callback = null, ?callable $errback = null): void function can be used
like this:
<?php
use React\EventLoop\Loop;
$addOne = function ($prev, $callback = null) {
if (!$callback) {
$callback = $prev;
$prev = 0;
}
Loop::addTimer(1, function () use ($prev, $callback) {
$callback($prev + 1);
});
};
React\Async\waterfall(array(
$addOne,
$addOne,
$addOne,
function ($prev, $callback) use ($loop) {
echo "Final result is $prev\n";
$callback();
},
));- Implement queue()
The recommended way to install this library is through Composer. New to Composer?
Once released, this project will follow SemVer. At the moment, this will install the latest development version:
$ composer require react/async:dev-mainSee also the CHANGELOG for details about version upgrades.
This project aims to run on any platform and thus does not require any PHP extensions and supports running on legacy PHP 5.3 through current PHP 8+. It's highly recommended to use the latest supported PHP version for this project.
To run the test suite, you first need to clone this repo and then install all dependencies through Composer:
$ composer installTo run the test suite, go to the project root and run:
$ php vendor/bin/phpunitMIT, see LICENSE file.
