meerkatmcr/simple-blocker

Simple user-blocking functionality for Laravel 5.x

Maintainers

Details

github.com/meerkatmcr/simple-blocker

Source

Issues

Installs: 2

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

1.0.1 2019-12-12 12:04 UTC

Requires

MIT c8a5a360c1d77d77229388aa1399597b14c3c4c4

  • Stephen Smith <stephen.smith3141.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-12 22:42:42 UTC

README

Very simple user-blocking functionality for Laravel 5.x

Installation

Notes

This package assumes that your users table is called users. If it is not, publish the migration and edit the table name.

Method

  • Install the package with composer install meerkatmcr/simple-blocker
  • Perform the database migration php artisan migrate
  • Add the MeerkatMcr\SimpleBlocker\Traits\Blockable trait to your user model.

Usage

Blocking and unblocking

The Blockable trait provides three methods:

  • block() block the user
  • unblock() unblock the user
  • isBlocked() return TRUE if the user is blocked

block() and unblock() are both fluent, and neither saves the model.

Middleware

The MeerkatMcr\SimpleBlocker\Middleware\CheckUserBlocked middleware will abort a request with code 403 if the current user is blocked.

To use it, register it in app/Http/Kernel.php as with any other middleware class. See the Laravel manual for further details.

The abort message is configurable - its key is simple-blocker.message. This package publishes its config file (simple-blocker.php).