A simple package for making Laravel Eloquent models 'archivable'. This package allows for the easy archiving of models by creating various macros to be used within method chaining.
You can install the package via composer:
composer require joelbutcher/laravel-archivableThe Archivable trait works similarly to Laravel's SoftDeletes trait. To ensure proper usage of the trait. This package also ships with a helpful macro for Laravel's \Illuminate\Database\Schema\Blueprint. To get started, simply add the archivedAt macro to your migration, like so:
Schema::create('posts', function (Blueprint $table) {
$table->id();
$table->unsignedBigInteger('user_id');
$table->string('title');
$table->timestamps();
$table->archivedAt(); // Macro
});You can now, safely, include the Archivable tait in your eloquent model:
namespace App\Models;
use \Illuminate\Database\Eloquent\Model;
class Post extends Model {
use Archivable;
...
}The extensions shipped with this trait include; archive, unArchive, WithArchived, withoutArchived, onlyArchived and can be used accordingly:
$user = User::first();
$user->archive();
$user->unArchive();
$usersWithArchived = User::query()->withArchived();
$onlyArchivedUsers = User::query()->onlyArchived();By default, the global scope of this trait uses the withoutArchived extension when the trait is added to a model.
Currently, a test suite doesn't exist for this package. However, I will be writing tests in line with Laravel's testing schemes for traits. If you wish to contribute any unit tests of your own, please refer to the contribution guides below
Please see CHANGELOG for more information what has changed recently.
Please see CONTRIBUTING for details.
If you discover any security related issues, please email joel@joelbutcher.co.uk instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.
This package was generated using the Laravel Package Boilerplate.