betalabs / laravel5-soft-cascade
Soft Delete & Restore Cascader
Requires
- php: >=5.5.9
Requires (Dev)
- codacy/coverage: dev-master
- laravel/framework: 5.4
- laravel/laravel: 5.*
- laravel/lumen-framework: 5.*
- phpunit/phpunit: 4.*
README
Laravel/Lumen 5 Soft Cascade Delete & Restore
Cascade delete and restore when using the Laravel or Lumen SoftDeletes feature.
Why do I need it?
To make soft deleting and restoring relations easy.
If you enjoy features like MySQL cascade deleting but want to use Laravels SoftDeletes feature you'll need to do some extra steps to ensure your relations are properly deleted or restored.
This package is intended to replace those steps with a simple array that defines the relations you want to cascade.
Installation
Install with composer
composer require askedio/laravel5-soft-cascade
Register the service provider in your config/app.php
Laravel:
Askedio\SoftCascade\Providers\GenericServiceProvider::class,
Lumen:
Askedio\SoftCascade\Providers\LumenServiceProvider::class,
Usage
In your Model enable the trait and define $softCascade. Example.
use \Askedio\SoftCascade\Traits\SoftCascadeTrait;
protected $softCascade = ['profiles'];
$softCascade is an array of your relation names, in the example you'll see we've defined function profiles() for the relation.
Nested relations work by defining $softCascade in the related Model as you can see here.
After you've defined your relations you can simply trigger delete() or restore() on your Model and your relations will have the same task performed.
User::first()->delete();
User::withTrashed()->first()->restore();
Supported Databases
- MySQL
- SQLite
Testing
I have written some very basic tests, certainly more needs to be done here. If you find this useful please help by testing other databases or writing better unit tests because I must move on.
Issues & Contributing
I will be using this with MySQL in a new API so any issues I find related to my use will be resolved. If you find an issue with MySQL please report it and I will fix it.
If you are using another database and have issues please contribute by submitting a pull request. I do not have time to test this with other database but assume all would work.