laravel-cascade-soft-deletes

by michaeldyrynda

Cascading deletes for Eloquent models that implement soft deletes

440 Stars 43 Forks Last release: 7 months ago (3.0.0) MIT License 89 Commits 14 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Cascading soft deletes for the Laravel PHP Framework

v3.0.0

Travis Build Status Scrutinizer Code Quality Code Coverage Latest Stable Version Total Downloads License Buy us a tree

Introduction

In scenarios when you delete a parent record - say for example a blog post - you may want to also delete any comments associated with it as a form of self-maintenance of your data.

Normally, you would use your database's foreign key constraints, adding an

ON DELETE CASCADE
rule to the foreign key constraint in your comments table.

It may be useful to be able to restore a parent record after it was deleted. In those instances, you may reach for Laravel's soft deleting functionality.

In doing so, however, you lose the ability to use the cascading delete functionality that your database would otherwise provide. That is where this package aims to bridge the gap in functionality when using the

SoftDeletes
trait.

Code Samples

use App\Comment;
use Iatstuti\Database\Support\CascadeSoftDeletes;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Post extends Model { use SoftDeletes, CascadeSoftDeletes;

protected $cascadeDeletes = ['comments'];

protected $dates = ['deleted_at'];

public function comments()
{
    return $this->hasMany(Comment::class);
}

}

Now you can delete an

App\Post
record, and any associated
App\Comment
records will be deleted. If the
App\Comment
record implements the
CascadeSoftDeletes
trait as well, it's children will also be deleted and so on.
$post = App\Post::find($postId)
$post->delete(); // Soft delete the post, which will also trigger the delete() method on any comments and their children.

Note: It's important to know that when you cascade your soft deleted child records, there is no way to know which were deleted by the cascading operation, and which were deleted prior to that. This means that when you restore the blog post, the associated comments will not be.

Because this trait hooks into the

deleting
Eloquent model event, we can prevent the parent record from being deleted as well as any child records, if any exception is triggered. A
LogicException
will be triggered if the model does not use the
Illuminate\Database\Eloquent\SoftDeletes
trait, or if any of the defined
cascadeDeletes
relationships do not exist, or do not return an instance of
Illuminate\Database\Eloquent\Relations\Relation
.

Additional Note: If you already have existing event listeners in place for a model that is going to cascade soft deletes, you can adjust the priority or firing order of events to have CascadeSoftDeletes fire after your event. To do this you can set the priority of your deleting event listener to be 1.

MODEL::observe( MODELObserver::class, 1 );
The second param is the priority.

MODEL::deleting( MODELObserver::class, 1 );

As of right now this is not documented in the Larvel docs, but just know that the default priority is

0
for all listeners, and that
0
is the lowest priority. Passing a param of greater than
0
to your listener will cause your listener to fire before listeners with default priority of
0

Installation

This trait is installed via Composer. To install, simply add to your

composer.json
file:
$ composer require iatstuti/laravel-cascade-soft-deletes

Support

If you are having general issues with this package, feel free to contact me on Twitter.

If you believe you have found an issue, please report it using the GitHub issue tracker, or better yet, fork the repository and submit a pull request.

If you're using this package, I'd love to hear your thoughts. Thanks!

Treeware

You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees here

Read more about Treeware at treeware.earth

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.