Laravel bannable package for blocking and banning Eloquent models. Using this package any model can be made bannable such as Organizations, Teams, Groups, and others.
Download package into the project using Composer.
composer require qirolab/laravel-bannable
Laravel 5.5 (or higher) uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.
For Laravel 5.4 or earlier releases version include the service provider within app/config/app.php
:
'providers' => [
Qirolab\Laravel\Bannable\BannableServiceProvider::class,
],
Now need to add nullable banned_at
timestamp column to model. So, create a new migration file.
php artisan make:migration add_banned_at_column_to_users_table
Add $table->timestamp('banned_at')->nullable();
in this new migration file as in below example.
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class AddBannedAtColumnToUsersTable extends Migration
{
public function up()
{
Schema::table('users', function (Blueprint $table) {
$table->timestamp('banned_at')->nullable();
});
}
public function down()
{
Schema::table('users', function (Blueprint $table) {
$table->dropColumn('banned_at');
});
}
}
Now run migration.
php artisan migrate
Use Bannable
trait in the Model as in below example.
use Qirolab\Laravel\Bannable\Traits\Bannable;
use Illuminate\Foundation\Auth\User as Authenticatable;
class User extends Authenticatable
{
use Bannable;
}
$user->ban();
$user->ban([
'comment' => 'ban comment!',
]);
Here expired_at
attribute could be \Carbon\Carbon
instance or any time string which could be parsed by \Carbon\Carbon::parse($string) method:
$user->ban([
'expired_at' => '2086-03-28 00:00:00',
]);
or
$user->ban([
'expired_at' => ' 1 year',
]);
or
$date = Carbon::now()->addWeeks(2);
$user->ban([
'expired_at' => $date,
]);
On unban
all related ban models are soft deletes.
$user->unban();
$user->isBanned();
$user->isNotBanned();
Qirolab\Laravel\Bannable\Models\Ban::deleteExpired();
$users = User::withoutBanned()->get();
$users = User::withBanned()->get();
$users = User::onlyBanned()->get();
By default all banned models will be hidden. To disable query scopes all the time you can define disableBannedAtScope
method in bannable model.
/**
* Determine which BannedAtScope should be applied or not.
*
* @return bool
*/
public function disableBannedAtScope()
{
return true;
}
On model entity ban \Qirolab\Laravel\Bannable\Events\ModelWasBanned
event is fired.
On model entity unban \Qirolab\Laravel\Bannable\Events\ModelWasUnbanned
event is fired.
To prevent banned users to go to protected routes Qirolab\Laravel\Bannable\Middleware\ForbidBannedUser
middleware is created.
Register it in $routeMiddleware array of app/Http/Kernel.php file:
protected $routeMiddleware = [ 'isBannedUser' => \Qirolab\Laravel\Bannable\Middleware\ForbidBannedUser::class, ]