Download the PHP package maize-tech/laravel-model-expires without Composer

# Laravel Model Expires [](https://packagist.org/packages/maize-tech/laravel-model-expires) [](https://github.com/maize-tech/laravel-model-expires/actions?query=workflow%3Arun-tests+branch%3Amain) [](https://github.com/maize-tech/laravel-model-expires/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain) [](https://packagist.org/packages/maize-tech/laravel-model-expires) With this package you can add expiration date to any model and exclude expired models from queries. When needed, you could send a notification for expiring models. You can also set a deletion date for every model and automatically clean them up with a command. ## Installation You can install the package via composer: You can publish the config and migration files and run the migrations with: This is the contents of the published config file: ## Usage ### Basic To use the package, add the `Maize\ModelExpires\HasExpiration` trait to all models you want to have an expiration date: That's it! All you have to do from now on is calling the `setExpiresAt` method every time you want to set an expiration and/or deletion date: ### Checking expiration and deletion days left You can also check whether a model is expired and calculate the amount of days before its expiration (or deletion): ### Excluding expired models When you want to exclude expired models, all you have to do is use the `withoutExpired` scope method: ### Retrieving only expired models When you want to retrieve expired models, all you have to do is use the `onlyExpired` scope method: ### Default expiration date If you wish, you can define a default expiration date. This can be done in two ways. First, you can set a value for `expires_after_days` property under `config/model-expires.php` config file. When set, all models including the `Maize\ModelExpires\HasExpiration` trait will automatically have an expiration date upon its creation: The second way is overriding the `defaultExpiresAt` method within all models you want to have a default expiration date: ### Default deletion date If you wish, you can define a default deletion date. This can be done in two ways. First, you can set a value for `deletes_after_days` property under `config/model-expires.php` config file. When set, all models including the `Maize\ModelExpires\HasExpiration` trait will automatically have a deletion date upon its creation: The second way is overriding the `defaultDeletesAt` method within all models you want to have a default deletion date: ### Scheduling expiration check The package comes with the `expires:check` command, which automatically fires a `ModelExpiring` event for all expiring models. To do so, you should define how often you want to fire the event. All you have to do is overriding the `fireExpiringEventBeforeDays` for all models using the `HasExpiration` trait: By default, the method returns an empty array, meaning models will never fire expiring events. Once done, you can schedule the command on a daily basis using the `schedule` method of the console kernel (usually located under the `App\Console` directory): ### Scheduling models deletion The package also comes with the `expires:delete` command, which automatically deletes all expired and deletable models. This comes pretty useful when automatizing its execution using Laravel's scheduling. All you have to do is add the following instruction to the `schedule` method of the console kernel (usually located under the `App\Console` directory): ## Testing ## Changelog Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. ## Contributing Please see [CONTRIBUTING](https://github.com/maize-tech/.github/blob/main/CONTRIBUTING.md) for details. ## Security Vulnerabilities Please review [our security policy](https://github.com/maize-tech/.github/security/policy) on how to report security vulnerabilities. ## Credits - [Enrico De Lazzari](https://github.com/enricodelazzari) - [Riccardo Dalla Via](https://github.com/riccardodallavia) - [All Contributors](../../contributors) ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information.