Delete old files in Laravel apps
This package will delete old files from directories. You can use a configuration file to specify the maximum age of a file in a certain directory.
Installation
You can install the package via composer:
composer require spatie/laravel-directory-cleanup
In Laravel 5.5 the service provider will automatically get registered. In older versions of the framework just add the service provider in config/app.php file:
'providers' => [
...
Spatie\DirectoryCleanup\DirectoryCleanupServiceProvider::class,
];
Next, you must publish the config file:
php artisan vendor:publish --provider="Spatie\DirectoryCleanup\DirectoryCleanupServiceProvider"
This is the content of the published config file laravel-directory-cleanup
return [
'directories' => [
/*
* Here you can specify which directories need to be cleanup. All files older than
* the specified amount of minutes will be deleted.
*/
/*
'path/to/a/directory' => [
'deleteAllOlderThanMinutes' => 60 * 24,
],
*/
],
/*
* If a file is older than the amount of minutes specified, a cleanup policy will decide if that file
* should be deleted. By default every file that is older that the specified amount of minutes
* will be deleted.
*
* You can customize this behaviour by writing your own clean up policy. A valid policy
* is any class that implements `Spatie\DirectoryCleanup\Policies\CleanupPolicy`.
*/
'cleanup_policy' => \Spatie\DirectoryCleanup\Policies\DeleteEverything::class,
];
Usage
Specify the directories that need cleaning in the config file.
When running the console command clean:directories all files in the specified directories older then deleteAllOlderThanMinutes will be deleted. Empty subdirectories will also be deleted.
This command can be scheduled in Laravel's console kernel.
// app/Console/Kernel.php
protected function schedule(Schedule $schedule)
{
$schedule->command('clean:directories')->daily();
}
Writing a custom clean up policy
If you want to apply additional conditional logic before a file is deleted, you can replace the default cleanup_policy with a custom one.
Create a class which implements Spatie\DirectoryCleanup\Policies\CleanupPolicy and add your logic to the shouldDelete method.
// app/CleanupPolicies/MyPolicy.php
namespace App\CleanupPolicies;
use Symfony\Component\Finder\SplFileInfo;
use Spatie\DirectoryCleanup\Policies\CleanupPolicy;
class MyPolicy implements CleanupPolicy
{
public function shouldDelete(SplFileInfo $file) : bool
{
$filesToKeep = ['robots.txt'];
return ! in_array($file->getFilename(), $filesToKeep);
}
}
Changelog
Please see CHANGELOG for more information 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, Samberstraat 69D, 2060 Antwerp, Belgium.
We publish all received postcards on our company website.
Credits
Support us
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Does your business depend on our contributions? Reach out and support us on Patreon.
All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.
License
The MIT License (MIT). Please see License File for more information.