meerkatmcr/simple-blocker

Simple user-blocking functionality for Laravel 5.x

1.0.1 2019-12-12 12:04 UTC

Requires

• illuminate/support: ^5.0

MIT

• Stephen Smith

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).