totov / laravel-soft-delete-morph-to-many-pivots
Allow morphToMany relationship pivots to be soft deleted.
Installs: 6 713
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 0
Requires
- php: ^8.1
- illuminate/contracts: ^10.0
- spatie/laravel-package-tools: ^1.14.0
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^7.8
- nunomaduro/larastan: ^2.0.1
- orchestra/testbench: ^8.8
- pestphp/pest: ^2.20
- pestphp/pest-plugin-arch: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- spatie/laravel-ray: ^1.26
README
Installation
You can install the package via composer:
composer require totov/laravel-soft-delete-morph-to-many-pivots
Usage
Use the MorphToManySoftDeletesTrait
trait along with the morphToManySoft
function and which returns a MorphToManySoftDeletes
use Illuminate\Database\Eloquent\Model; use Totov\LaravelSoftDeleteMorphToManyPivots\MorphToManySoftDeletes; use Totov\LaravelSoftDeleteMorphToManyPivots\Traits\MorphToManySoftDeletesTrait; class User extends Model { use MorphToManySoftDeletesTrait; public function user_types(): MorphToManySoftDeletes { return $this->morphToManySoft(UserType::class, 'types'); } }
On the morphed model, use the morphedByManySoft
function:
use Illuminate\Database\Eloquent\Model; use Totov\LaravelSoftDeleteMorphToManyPivots\MorphToManySoftDeletes; use Totov\LaravelSoftDeleteMorphToManyPivots\Traits\MorphToManySoftDeletesTrait; class UserType extends Model { use MorphToManySoftDeletesTrait; public function users(): MorphToManySoftDeletes { return $this->morphedByManySoft(User::class, 'types'); } }
Ensure that your pivot table has a deleted_at
column which can be used for the soft deleting.
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
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.