createnl/expires

Set expiration date for database records, like future deleted at columns

Expires

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

A package to add expiration date to database records., _(*2)

Install

Via Composer

``` bash $ composer require createnl/expires, <sub>(*3)</sub>

## Usage

### Your migration
``` php

$table->dateTime('expires_at')->nullable()->default(null);

Your model

``` php, <sub>(*4)</sub>

class Model extends Eloquent { use Createnl\Expires\Expirable, <sub>(*5)</sub>

/**
 * Indicates if the model should set an auto expire
 *
 * @var bool
 */
protected static $autoExpire = true;

/**
 * Indicates if the model should reset the expiration date on model update
 *
 * @var bool
 */
protected static $autoExtend = true;

/**
 * The amount of interval to be added to the
 * Please see ISO_8601 durations for correct markups
 *
 * @var string (\DateInterval)
 */
protected static $autoExpireDate = 'P5Y';

}, <sub>(*6)</sub>

### Methods

``` php

// Get records with expired
$model->withExpired() : Builder;

// Get only expired records
$model->onlyExpired() : Builder;

// Update expiration date
$model->setExpiration(Carbon $date) : Model;

// Remove expiration date
$model->unExpire() : Model;

// Check if record is expired
$model->isExpired() : bool;

// Get carbon object of expiration date
$model->expiresAt() :? Carbon;

// Extend expiration by defined interval
$model->extendExpiration() : Model;

// Disable automatic setting of expiration date
Model::disableExpiring() : void;

// Enable automatic setting of expiration date
Model::enableExpiring() : void;

Custom expiration date logic

``` php, <sub>(*7)</sub>

/** * @override * Get Carbon object of parsed expiration date. * * @return Carbon */ public function expirationDate() : Carbon { // @todo: Manipulate expiration date $interval = new \DateInterval(self::$autoExpireDate); return $this->freshTimestamp()->add($interval); }, <sub>(*8)</sub>

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Testing

``` bash
$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*9)</sub>

Security

If you discover any security related issues, please email alex@create.nl instead of using the issue tracker., <sub>(*10)</sub>

Credits

• Alex Lisenkov
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*11)</sub>