kobalazs/laravel-restrict-soft-deletes

Restrict deletes for Eloquent models that implement soft deletes.

dev-master 2018-11-13 16:21 UTC

Requires

• php: >=5.4
• illuminate/database: ~5.0
• illuminate/events: ~5.0

Requires (Dev)

• phpunit/phpunit: ^4.8

CC-BY-SA-4.0

• Balazs Kovacs

README

Restrict deletes for Eloquent models that implement soft deletes. Based on the idea of Michael Dyrynda at https://dyrynda.com.au/blog/cascading-soft-deletes-with-laravel-and-eloquent

Installation

Run composer require kobalazs/laravel-restrict-soft-deletes

Usage

1. Use RestrictSoftDeletes in your Model you want to have restricted
2. Add a protected attibute to your Model class listing the Eloquent relationships to be watched
3. In case of an attempted deletion on a restricted model the trait will throw a Netpok\Database\Support\DeleteRestrictionException (HTTP 403)

Example

namespace App;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
use Netpok\Database\Support\RestrictSoftDeletes;

class User extends Model
{
    use SoftDeletes;
    use RestrictSoftDeletes;

    /**
     * The relations restricting model deletion
     */
    protected $restrictDeletes = ['posts'];

    /**
     * Eloquent relationship (has to be defined for RestrictSoftDeletes to work!)
     */
    public function posts()
    {
        return $this->hasMany('App\Post');
    }

    ...
}

In this example a User can not be deleted while they have any Post that is not soft-deleted.