Assign expiration dates to Eloquent models

Installation

You can install the package via composer:

composer require mvdnbrk/laravel-model-expires

Usage

To use an expiration date on a model, use the

Expirable

use Illuminate\Database\Eloquent\Model;
use Mvdnbrk\EloquentExpirable\Expirable;

class Subscription extends Model
{
    use Expirable;
}

You should add an

expires_at

class CreateSubscriptionsTable extends Migration
{
    public function up(): void
    {
        Schema::create('subscriptions', function (Blueprint $table) {
            $table->expires();
        });
    }

public function down(): void
{
    Schema::dropExpires();
}
}

The

Expirable

expires_at

DateTime

Carbon

Customizing the column name

You may customize the column name by setting the

EXIRES_AT

getExpiresAtColumn

class Subscription extends Model
{
    use Expirable;

const EXPIRES_AT = 'ends_at';
}

$table->expires('ends_at');
$table->dropExpires('ends_at);

Setting expiration

You may set the expiration of a model by setting the

expires_at

$subscription->expires_at = 600;

Instead of passing the number of seconds as an integer, you may also pass a

DateTime

$subscription->expires_at = now()->addMinutes(10);

Discarding expiration

You may discard the expiration of a model by setting a negative or zero TTL or use the

discardExpiration

$subscription->expires_at = 0;
$subscription->expires_at = -5;

$subscription->discardExpiration()->save();

Determining expiration

To determine if a given model instance has expired, use the

expired

if ($subscription->expired()) {
    //
}

To determine if a given model will expire in the future use the

willExpire

if ($subscription->willExpire()) {
    //
}

Querying models

The

withoutExpired

$subscriptions = App\Models\Subscription::withoutExpired()->get();

The

onlyExpired

$subscriptions = App\Models\Subscription::onlyExpired()->get();

The

expiring

$subscriptions = App\Models\Subscription::expiring()->get();

The

notExpiring

$subscriptions = App\Models\Subscription::notExpiring()->get();

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

composer test

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.