README
Gearman JobServer implementation for Laravel
Gearman
Gearman is a MQ (Message Queue) provider with foreground and background capabilities. This makes it one of the few PHP-suited synchronous MQ handlers.
gearman.org
Laravel
Laravel is on of the leanest and meanest PHP Frameworks around - perfectly suited for rest API projects.
laravel.com
The package
The Jobserver package is a Gearman dispatch implementation for Laravel. The package functions as an abstraction layer to send both foreground as background jobs to a MQ server (Gearman in this case).
The Jobserver package is taylored to use in the 3-layer structure (app <-> api <-> worker).
Read more about installing and using the jobserver package here:
3-layer - JobServer package
3-Layer - Set up Message Queueing
Implementation
Add the package to your API dependencies. To use the local "synced" mode - skipping a local Gearman installation - add the models/Ghostjob.php file to your worker app/models directory.
To make the synced connection between the API and worker job function work, add "echo Ghostjob::evaluate ('controllerDispatch', $argv);" to the end of the required function files.
Installation
Add the Jobserver package to the composer requirements of your API project. In project/composer.json, add the koenbetsens/jobserver entry
array
(
'Illuminate\Foundation\Providers\ArtisanServiceProvider',
...
'Illuminate\Workbench\WorkbenchServiceProvider',
'koenbetsens\jobserver\JobServerServiceProvider'
)
The package has 2 modes: "Gearman mode" (default) and "Synchronized mode" to enable functional communication without an actual MQ install.
#### Gearman mode
If your Gearman server runs on the same machine as your API project, Jobserver will work out-of-the-box. To send your jobs to an external queue, create a config file named `app/config/gearman.php` to store your Gearman server location. You can add multiple servers, or single servers for multiple environments, by creating [config environment-folders](
http://laravel.com/docs/4.2/configuration#environment-configuration)
array
(
'gearman.project-url.ext' => '4730'
)
);
#### Synchronized (local) mode
To save yourself the hassle of installing Gearman locally for development, you can enabled the **sync mode** for **php-cli** based execution of the jobload. This mode will only work when debug mode is on, to prevent sync mode in production-level environments.
##### Configuration
The configuration can be added directly to your `app/config/
local/app.php` file. Your worker path points to the **job functions directory** (usually named `/jobs`)
true,
/**
|--------------------------------------------------------------------------
| Synchronized
|--------------------------------------------------------------------------
| If set, the API will call the worker directly, instead of using a jobserver.
**/
'synchronized' => true,
/**
|--------------------------------------------------------------------------
| Worker path
|--------------------------------------------------------------------------
| This path is used by the local Jobserver to sync a queue request.
**/
'worker' => array
(
'path' => '/path/to/project/worker/jobs'
)
);
##### Ghostjob model
We need to emulate a job model for syncronized usage. Copy the `/models/Ghostjob.php` file from the Jobserver package to the `app/models` folder in your worker project. Now you can selectively add the Ghostjob evaluation in the job-function files like this: