spinen/laravel-garbage-man

Scheduled job to clean out Laravel's soft deleted records at configured interval.

SPINEN's Laravel Garbage Man

, _(*1)

The soft deletes are great in Laravel to make sure that some deleted data can be recovered. This package allows you to configure an array of models with how many days that you want the soft deleted data to stay in the database., _(*2)

Build Status

Branch	Status	Coverage	Code Quality
Develop
Master

Prerequisite

NOTE: If you need to use < PHP 7.2, please stay with version 1.x

As side from Laravel >= 5.1.10 (5.1.10 is the first version that had the warn method, so that is the minimum for logging), there is 1 package that is required., _(*3)

• nesbot/carbon

Install

Install Garbage Man:, _(*4)

$ composer require spinen/laravel-garbage-man

For >= Laravel 5.5, you are done with the installation

The package uses the auto registration feature of Laravel 5., _(*5)

Upgrading to 2.x from 1.x

As of Laravel 5.8 (and deprecated in 5.4), the fire() method on the dispatcher contract was removed in favor of dispatch(). Therefore, we have updated our code to use dispatch(). You will need to change fire() to dispatch() in your config/garbageman.php file., _(*6)

Using the command

The command is registered with laravel as garbageman:purge. You can run it one of 2 ways..., _(*7)

1. from the command line php artisan garbageman:purge;
2. via a scheduled task.

To automatically run the script as a scheduled job, then add the following to the schedule method of App\Console\Kernel.php:, _(*8)

$schedule->command('garbageman:purge')
         ->daily();

You can use whatever schedule that you need to keep the records purged out. Just review the list at http://laravel.com/docs/master/scheduling#schedule-frequency-options., _(*9)

You can also use any of the advanced configuration options of the task scheduler like "Task Output" or "Task Hooks" as listed on the Laravel documentation., _(*10)

Configuration

Publish the package config file to config/garbageman.php:, _(*11)

$ php artisan vendor:publish

This file is fully documented. You will need to make the changes to that file to suit your needs. There are 3 main configuration items..., _(*12)

1. Dispatch purge events - Dispatch events on purge of each record.
2. Logging level - Level to log.
3. Schedule - Models & number of days to allow the soft deleted record to stay before purging.

Dispatch purge events (dispatch_purge_events)

You may hook into the purge of each record by throwing events before & after deleting of each record. There are 2 events thrown:, _(*13)

• garbageman.purging:<full/model/name>
• garbageman.purged:<full/model/name>

The model is passed with each of the events. The "purging" event is thrown just before the actual delete & "purged" is thrown just after the actual deletion., _(*14)

Please note: This is an expensive operation as it requires a SQL command for each record to delete so that the record can be thrown with the events. Therefore, unless you need to catch the events to perform some other action, leave this false to allow all records per model to get deleted with a single SQL call., _(*15)

Logging level (logging_level)

The level that log messages are generated, which will display information on the console output and in the logs., _(*16)

There is a key for the console & one for the log. Here is an example..., _(*17)

'logging_level' => [
    'console' => 3,
    'log'     => 6,
],

Alternatively, you can set the levels with environmental variables GARBAGEMAN_CONSOLE_LOG_LEVEL and GARBAGEMAN_LOG_LEVEL., _(*18)

Schedule (schedule)

The age is in days for each model. Here is an example..., _(*19)

'schedule' => [
    App\ModelOne::class => 14,
    App\ModelTwo::class => 30,
],

This would purge any ModelOnes that were deleted over 14 days ago and any ModelTwos that were deleted over 30 days ago., _(*20)