README

This package deletes soft deleted rows automatically after a time interval that you define.

Installation

Step 1

Require the package with composer using the following command:

composer require falconsw/soft-delete-cleaner

Step 2

The service provider will automatically get registered. Or you may manually add the service provider in your config/app.php file:

'providers' => [
    // ...
    \FalconSW\SoftDeleteCleaner\SoftDeleteCleanerServiceProvider::class,
];

Step 3

Now its the time for scheduling the command. in you app/Console/Kernel.php file, paste this code in schedule() function:

protected function schedule(Schedule $schedule)
{
    // ...
    $schedule->command(\FalconSW\SoftDeleteCleaner\SoftDeleteCleanerCommand::class)->hourly();
    // ...
}

In the code above, the command scheduled to run hourly. you can change it. For more information, please read this page.

Step 4 (Optional)

You can publish the config file with this following command:

php artisan vendor:publish --provider="FalconSW\SoftDeleteCleaner\SoftDeleteCleanerServiceProvider" --tag=config

Also you can set the SOFT_DELETE_CLEANER_EXPIRE_TIME value in .env file. like the following code:

...
SOFT_DELETE_CLEANER_EXPIRE_TIME='1 day'
...

Usage

in your models that used SoftDeletes trait, you can enable Soft Delete Cleaner with this code:

class SampleModel extends Model
{
    use SoftDeletes;
    const SOFT_DELETE_CLEANER_STATUS = true;
}

Just write const SOFT_DELETE_CLEANER_STATUS = true in your models! Also you can set expiration time for your deleted entities using the following line:

const SOFT_DELETE_CLEANER_EXPIRE_TIME = '5 months';

In the code above, expiration time for your soft deleted entity model is 5 months. The final code is:

class SampleModel extends Model
{
    use SoftDeletes;
    const SOFT_DELETE_CLEANER_STATUS = true;
    const SOFT_DELETE_CLEANER_EXPIRE_TIME = '5 months';
}

You can set any other values for SOFT_DELETE_CLEANER_EXPIRE_TIME like 5(means 5 days), 2 hours, 45 days, 2.5 months, 1 year, etc.

Note: If you don't set any value for SOFT_DELETE_CLEANER_EXPIRE_TIME in your model, the soft deleted models with SOFT_DELETE_CLEANER_STATUS = true will be hard deleted after the time defined in config file named auto-hard-deleter.php.

Soft Delete Cleaner Command

Also you can hard delete expired rows manually using this artisan command:

php artisan soft-delete:clean

falconsw / soft-delete-cleaner

Maintainers

Details