dillingham / soft-deletes-parent
Soft delete children when parent soft deletes
Fund package maintenance!
dillingham
Installs: 1 273
Dependents: 0
Suggesters: 0
Security: 0
Stars: 58
Watchers: 1
Forks: 4
Open Issues: 1
Requires
- php: ^8.0
- illuminate/contracts: ^8.37
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.1
- nunomaduro/collision: ^5.3
- nunomaduro/larastan: ^0.7.12
- orchestra/testbench: ^6.15
- phpmd/phpmd: ^2.10
- phpunit/phpunit: ^9.3
- spatie/laravel-ray: ^1.23
README
Automatically soft delete a model's children while maintaining their own soft deleted state when you restore the parent model. After installing the trait below, the Post
model's parent_deleted_at
will update whenever an Author
model is deleted or restored. This allows you to maintain the original deleted_at
for the Post
model after Author
is restored. The Post
model will scope queries to exclude any where the parent is deleted.
Installation
You can install the package via composer:
composer require dillingham/soft-deletes-parent
Usage
Add the parent_deleted_at
column to your table:
Schema::table('posts', function (Blueprint $table) { $table->softDeletesParent(); });
And add the trait and parent model to your child model:
<?php namespace App\Models; use Dillingham\SoftDeletesParent\SoftDeletesParent; use Illuminate\Database\Eloquent\Model; class Post extends Model { use SoftDeletesParent; }
<?php namespace App\Providers; class AppServiceProvider { public function register() { Post::softDeletesParent(Author::class); } }
Scopes
With parent trashed:
Post::withParentTrashed()->get();
Only parent trashed:
Post::onlyParentTrashed()->get();
Testing
composer test
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.