This package makes it easy to run PHP concurrently. Behind the scenes, concurrency is achieved by forking the main PHP process to one or more child processes.
In this example, where we are going to call an imaginary slow API, all three closures will run at the same time.
use Spatie\Fork\Fork;
$results = Fork::new()
->run(
fn () => (new Api)->fetchData($userId = 1),
fn () => (new Api)->fetchData($userId = 2),
fn () => (new Api)->fetchData($userId = 3),
);
$results[0]; // fetch data of user 1
$results[1]; // fetch data of user 2
$results[2]; // fetch data of user 3
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
You can install the package via composer:
composer require spatie/fork
You can pass as many closures as you want to run
. They will be run concurrently. The run
function will return an array with the return values of the executed closures.
use Spatie\Fork\Fork;
$results = Fork::new()
->run(
function () {
sleep(1);
return 'result from process 1';
},
function () {
sleep(1);
return 'result from process 2';
},
function () {
sleep(1);
return 'result from process 3';
},
);
// this code will be reached this point after 1 second
$results[0]; // contains 'result from process 1'
$results[1]; // contains 'result from process 2'
$results[2]; // contains 'result from process 3'
The closures to run shouldn't return objects, only primitives and arrays are allowed.
If you need to execute code some before each callable passed to run
, you can pass a callable to before
. This callable passed to before
will be executed in the child process right before the callable passed to run
will execute.
Here's an example where we are going to get a value from the database using a Laravel Eloquent model. In order to let the child process use the DB, it is necessary to reconnect to the DB. The closuse passed to before
will run in both child processes that are created for the closures passed to run
.
use App\Models\User;
use Illuminate\Support\Facades\DB;
use Spatie\Fork\Fork;
Fork::new()
->before(fn () => DB::connection('mysql')->reconnect())
->run(
fn () => User::find(1)->someLongRunningFunction(),
fn () => User::find(2)->someLongRunningFunction()
);
If you need to perform some cleanup in the child process after the callable has run, you can use the after
method on a Spatie\Fork\Fork
instance.
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.