Clean up unneeded records

This package will clean up unneeded records for your Eloquent models.

The only things you have to do is let your models implement the GetsCleanedUp-interface and schedule a command that performs the cleanup.

Here's a quick example of a model that implements GetsCleanedUp:

use Spatie\ModelCleanup\GetsCleanedUp;
use Illuminate\Database\Eloquent\Builder;
use Carbon\Carbon;

class LogItem extends Model implements GetsCleanedUp
{
    ...
    
     public static function cleanUp(Builder $query) : Builder
     {
        // Delete all records older than a year
        return $query->where('created_at', '<', Carbon::now()->subYear());
     }
}

Support us

Learn how to create a package like this one, by watching our premium video course:

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/laravel-model-cleanup

Next, you must publish the config file:

php artisan vendor:publish --provider="Spatie\ModelCleanup\ModelCleanupServiceProvider"

This is the content of the published config file model-cleanup.php.

return [

    /*
     * All models that use the GetsCleanedUp interface in these directories will be cleaned.
     */
    'directories' => [
        // app_path('models'),
    ],

    /*
     * All models in this array that use the GetsCleanedUp interface will be cleaned.
     */
    'models' => [
        // App\LogItem::class,
    ],

    /*
     * Specify whether to search the configured `directories` recursively. 
     * Set to false to only search for models directly inside the specified paths.
     */
    'recursive' => true,
];

Usage

Configure models to remove

All models that you want to clean up must implement the GetsCleanedUp-interface. In the required cleanUp-method you can specify a query that selects the records that should be deleted.

Let's say you have a model called LogItem, that you would like to cleaned up. In this case your model could look like this:

use Spatie\ModelCleanup\GetsCleanedUp;
use Illuminate\Database\Eloquent\Builder;
use Carbon\Carbon;

class LogItem extends Model implements GetsCleanedUp
{
    ...
    
    public static function cleanUp(Builder $query) : Builder
    {
        return $query->where('created_at', '<', Carbon::now()->subYear());
    }
    
}

When running the console command clean:models all logItems older than a year will be deleted.

Configure models to forceRemove

All models that have the SoftDeletes trait that you want to clean up completly from the database must implement the GetsForcedCleanedUp-interface. In the required forceCleanUp-method you can specify a query that selects the records that should be forceDeleted.

Let's say you have a model called LogItem, that you would like to cleaned up. In this case your model could look like this:

use Spatie\ModelCleanup\GetsForcedCleanedUp;
use Illuminate\Database\Eloquent\Builder;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\SoftDeletes;

class LogItem extends Model implements GetsForcedCleanedUp
{
    use SoftDeletes;
    ...
    
    public static function forceCleanUp(Builder $query) : Builder
    {
        return $query->onlyTrashed()->where('deleted_at', '<', Carbon::now()->subDay());
    }
    
}

When running the console command clean:models all logItems that were deleted more than a year from Carbon::now will be deleted completly from the database.

Command

When running the console command clean:models all the items on cleanUp will be deleted.

This command can be scheduled in Laravel's console kernel.

// app/Console/Kernel.php

protected function schedule(Schedule $schedule)
{
   $schedule->command('clean:models')->daily();
}

Events

After the model has been cleaned Spatie\ModelCleanup\ModelWasCleanedUp will be fired even if there were no records deleted.

It has two public properties: modelClass and numberOfDeletedRecords.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

Postcardware

You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.

We publish all received postcards on our company website.

Credits

• Jolita Grazyte
• Freek Van der Herten
• All Contributors

License

The MIT License (MIT). Please see License File for more information.