Download the PHP package doloan09/laravel-model-expires without Composer
On this page you can find all versions of the php package doloan09/laravel-model-expires. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download doloan09/laravel-model-expires
More information about doloan09/laravel-model-expires
Files in doloan09/laravel-model-expires
Package laravel-model-expires
Short Description A package to assign expiration dates to Eloquent models
License MIT
Homepage https://github.com/mvdnbrk/laravel-model-expires
Informations about the package laravel-model-expires
Assign expiration dates to Eloquent models
Installation
You can install the package via composer:
Usage
To use an expiration date on a model, use the Expirable
trait:
You should add an expires_at
column to your database table.
This packages contains a helper method to create this column:
The Expirable
trait will automatically cast the expires_at
attribute to a DateTime
/ Carbon
instance for you.
Customizing the column name
You may customize the column name by setting the EXIRES_AT
constant or by overriding the getExpiresAtColumn
method on your model.
Setting expiration
You may set the expiration of a model by setting the expires_at
attribute with a TTL in seconds:
Instead of passing the number of seconds as an integer, you may also pass a DateTime
instance representing the expiration date:
Discarding expiration
You may discard the expiration of a model by setting a negative or zero TTL or use the discardExpiration
method:
Determining expiration
To determine if a given model instance has expired, use the expired
method:
To determine if a given model will expire in the future use the willExpire
method:
Querying models
The withoutExpired
method will retrieve models that are not expired:
The onlyExpired
method will retrieve only the expired models:
The expiring
method will retrieve only models that will expire in the future:
The notExpiring
method will retrieve only models that will not expire:
Todo
- Add a
expired:prune
console command to delete expired models, or perform custom implementation. - Add a query scope that will query models that will expire in
...
Testing
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Mark van den Broek
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-model-expires with dependencies
illuminate/support Version ^6.0 || ^7.0 || ^8.0 || ^9.0
illuminate/database Version ^6.0 || ^7.0 || ^8.0 || ^9.0