A lightweight solution for running PHP code concurrently
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
Support us
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.
Installation
You can install the package via composer:
composer require spatie/fork
Usage
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.
Running code before and after each closure
If you need to execute code some before or after each callable passed to run, you can pass a callable to before or after. This callable passed will be executed in the child process right before or fater the callable passed to run` will execute.
Using before and after in the child process
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.
Using before and after in the parent process.
If you need to let the callable passed to before or after run in the parent process, then you need to pass the callable to the parent argument.
use App\Models\User;
use Illuminate\Support\Facades\DB;
use Spatie\Fork\Fork;
Fork::new()
->before(parent: fn() => echo 'this runs in the parent process')
->run(
fn () => User::find(1)->someLongRunningFunction(),
fn () => User::find(2)->someLongRunningFunction(),
);
You can also pass different closures, to be run in the child and the parent process
use Spatie\Fork\Fork;
Fork::new()
->before(
child: fn() => echo 'this runs in the child process',
parent: fn() => echo 'this runs in the parent process',
)
->run(
fn () => User::find(1)->someLongRunningFunction(),
fn () => User::find(2)->someLongRunningFunction(),
);
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.
