README

Requirements

• PHP >= 8.1
• Laravel ~10.x

Installation

composer require stylers/laravel-ban

You can publish the migration

php artisan vendor:publish --provider="Stylers\LaravelBan\Providers\BanServiceProvider"

After the migration has been published, you can run the migrations

php artisan migrate

Usage

• How to add User to Bannable

use Stylers\LaravelBan\Contracts\Models\Traits\BannableInterface;
use Stylers\LaravelBan\Models\Traits\Bannable;

class User extends Authenticatable implements BannableInterface
{
    use Notifiable;
    use Bannable;
}

Ban

use Carbon\Carbon;

$user = User::first();

$comment = "Reason of ban."; // ?string
$startAt = Carbon::addWeek(); // ?DateTimeInterface
$endAt = Carbon::now()->addWeeks(2); // ?DateTimeInterface

$ban = $user->ban(); // Ban without comment and timestamps (start_at, end_at) - never expire
$ban = $user->ban($comment, null, $endAt); // Ban for 2 weeks with comment
$ban = $user->ban($comment); // Ban without expire
$ban = $user->ban($comment, $startAt, $endAt); // Ban for a week with comment from next week

Unban

Remove active bans

$user = User::first();
$unbans = $user->unban();

Events

use Stylers\LaravelBan\Events\Banned;
use Stylers\LaravelBan\Events\Unbanned;

Middleware for User

• Update $routeMiddleware in App\Http\Kernel.php

use Stylers\LaravelBan\Http\Middleware\CheckUserBan;

protected $routeMiddleware = [
    ...
    'check_user_ban' => CheckUserBan::class,
];

• Update your routes in routes/ or App\Providers\RouteServiceProvider

protected function mapWebRoutes()
{
    Route::middleware('web', 'check_user_ban')
         ->namespace($this->namespace)
         ->group(base_path('routes/web.php'));
}