Need help with laravel-deletable?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

f9webltd
140 Stars 5 Forks MIT License 16 Commits 0 Opened issues

Description

:space_invader: Gracefully restrict deletion of Laravel Eloquent models

Services available

!
?

Need anything else?

Contributors list

Packagist Version Scrutinizer coverage (GitHub/BitBucket) Scrutinizer code quality (GitHub/Bitbucket) Travis (.org) StyleCI Status Packagist License

Laravel Deletable

Gracefully handle deletion restrictions on your Eloquent models, as featured on Laravel News

Requirements

PHP >= 7.2, Laravel >= 5.8.

PHP 8.0 is supported for Laravel >= 6x

Installation

composer require f9webltd/laravel-deletable

The package will automatically register itself.

Optionally publish the configuration file by running:

php artisan vendor:publish
and selecting the appropriate package.

Documentation

### Usage

Within an Eloquent model use the

RestrictsDeletion
trait:
namespace App;

use F9Web\LaravelDeletable\Traits\RestrictsDeletion; use Illuminate\Database\Eloquent\Model;

class User extends Model { use RestrictsDeletion; }

The trait overrides calls to Eloquent's

delete()
method.

Implement the

isDeletable()
method within the model in question.

This method should return

true
to allow deletion and
false
to deny deletion:
namespace App;

use F9Web\LaravelDeletable\Traits\RestrictsDeletion; use Illuminate\Database\Eloquent\Model;

class User extends Model { use RestrictsDeletion;

public function isDeletable() : bool { return $this->orders()->doesntExist(); }
}

The above denies deletion of users with orders.

None deletable models throw an exception when the

isDeletable()
method returns
false
:
namespace App\Controllers;

use F9Web\LaravelDeletable\Exceptions\NoneDeletableModel; use App\User;

class UsersController { public function destroy(User $user) : bool { try { $user->delete(); } catch (NoneDeletableModel $e) { // dd($ex->getMessage()); } }
}

Eloquent Base Model

As the default

isDeletable()
method returns
true
, a base Eloquent model can be optionally defined from which all models extend. Each model can then optionally implement the
isDeletable()
method as needed.

Customising Messages

The default exception message is defined within the config

f9web-laravel-deletable.messages.default
and is simply
The model cannot be deleted
.

By setting

f9web-laravel-deletable.messages.default
to
null
a more detailed message is automatically generated i.e.
Restricted deletion: App\User - 1 is not deletable
.

Custom messages can be set within the

isDeletable()
method:
namespace App;

use F9Web\LaravelDeletable\Traits\RestrictsDeletion; use Illuminate\Database\Eloquent\Model; use Illuminate\Support\Str;

class User extends Model { use RestrictsDeletion;

public function isDeletable() : bool { if (Str::endsWith($this->email, 'f9web.co.uk')) { return $this->denyDeletionReason('Users with f9web.co.uk company email addresses cannot be deleted'); }

return true;

}
}

The

denyDeletionReason()
method can be used to specify the exception message.

In the above case, the exception message is

Users with f9web.co.uk company email addresses cannot be deleted
.

Multiple Checks

Multiple checks can be performed within

isDeletable()
if necessary, each of which returning a different exception message:
namespace App;

use F9Web\LaravelDeletable\Traits\RestrictsDeletion; use Illuminate\Database\Eloquent\Model; use Illuminate\Support\Str;

class User extends Model { use RestrictsDeletion;

public function isDeletable() : bool { if (Str::endsWith($this->email, 'f9web.co.uk')) { return $this->denyDeletionReason('Users with f9web.co.uk company email addresses cannot be deleted'); }

if ($this->orders->isNotEmpty()) {
   return false;
}

if ($this->purchaseOrders->isNotEmpty()) {
   return $this->denyDeletionReason('This user has active purchase orders and cannot be deleted');
}

if ($this->overdueInvoices->isNotEmpty()) {
   return $this->denyDeletionReason('Users with overdue invoices cannot be deleted');
}

return true;

}
}

Contribution

Any ideas are welcome. Feel free to submit any issues or pull requests.

Testing

composer test

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

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.