INSTALL_LUMEN.md

Installation - Lumen

This plugin can only be installed from Composer.

Run the following command:

composer require imtigger/laravel-job-status

0. Setup config_path polyfill if not

Follow the instruction by mabasic to add config_path helper function to your lumen installation.

1. Add Service Provider and QueueManager Binding

Add the following to your bootstrap/app.php:

$app->bind(\Illuminate\Queue\QueueManager::class, function ($app) {
    return new \Illuminate\Queue\QueueManager($app);
});

$app->register(Imtigger\LaravelJobStatus\LaravelJobStatusServiceProvider::class);

2. Publish migration and config

cp vendor/imtigger/laravel-job-status/database/migrations/2017_05_01_000000_create_job_statuses_table.php ./database/migrat
ions/
cp vendor/imtigger/laravel-job-status/config/job-status.php ./config/

3. Migrate Database

php artisan migrate

4. Use a custom JobStatus model (optional)

To use your own JobStatus model you can change the model in config/job-status.php

return [
    'model' => App\JobStatus::class,
];

5. Improve job_id capture (optional)

The first laravel event that can be captured to insert the job_id into the JobStatus model is the Queue::before event. This means that the JobStatus won't have a job_id until it is being processed for the first time.

If you would like the job_id to be stored immediately you can add the LaravelJobStatusServiceProvider to your bootstrap/app.php, which tells laravel to use our Dispatcher.

$app->register(Imtigger\LaravelJobStatus\LaravelJobStatusBusServiceProvider::class);

6. Setup dedicated database connection (optional)

Laravel support only one transcation per database connection.

All changes made by JobStatus are also within transaction and therefore invisible to other connnections (e.g. progress page)

If your job will update progress within transaction, copy your connection in config/database.php under another name like 'mysql-job-status' with same config.

Then set your connection to 'database_connection' => 'mysql-job-status' in config/job-status.php