FEATURE: implement laravel ban functionality for user model

app/Models/User.php

@@ -2,6 +2,8 @@
 
 namespace App\Models;
 
+use Cog\Contracts\Ban\Bannable as BannableInterface;
+use Cog\Laravel\Ban\Traits\Bannable;
 // use Illuminate\Contracts\Auth\MustVerifyEmail;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Foundation\Auth\User as Authenticatable;
@@ -11,7 +13,7 @@
 use Laravel\Jetstream\HasTeams;
 use Laravel\Sanctum\HasApiTokens;
 
-class User extends Authenticatable
+class User extends Authenticatable implements BannableInterface
 {
     use HasApiTokens;
 
@@ -22,6 +24,8 @@ class User extends Authenticatable
     use Notifiable;
     use TwoFactorAuthenticatable;
 
+    use Bannable;
+
     /**
      * The attributes that are mass assignable.
      *

app/Providers/FortifyServiceProvider.php

@@ -53,6 +53,7 @@ public function boot(): void
                 ->orWhere('username', $request->email)->first();
 
             if ($user &&
+                $user->isNotBanned() &&
                 Hash::check($request->password, $user->password)) {
                 return $user;
             }

bootstrap/providers.php

@@ -4,5 +4,6 @@
     App\Providers\AppServiceProvider::class,
     App\Providers\FortifyServiceProvider::class,
     App\Providers\JetstreamServiceProvider::class,
+    Cog\Laravel\Ban\Providers\BanServiceProvider::class,
     Vinkas\Discourse\ServiceProvider::class,
 ];

composer.json

@@ -6,6 +6,7 @@
     "license": "MIT",
     "require": {
         "php": "^8.2",
+        "cybercog/laravel-ban": "^4.9",
         "laravel/framework": "^11.9",
         "laravel/jetstream": "^5.3",
         "laravel/sanctum": "^4.0",

database/migrations/2017_03_04_000000_create_bans_table.php

@@ -0,0 +1,49 @@
+<?php
+
+/*
+ * This file is part of Laravel Ban.
+ *
+ * (c) Anton Komarev <anton@komarev.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateBansTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up(): void
+    {
+        Schema::create('bans', function (Blueprint $table) {
+            $table->increments('id');
+            $table->morphs('bannable');
+            $table->nullableMorphs('created_by');
+            $table->text('comment')->nullable();
+            $table->timestamp('expired_at')->nullable();
+            $table->softDeletes();
+            $table->timestamps();
+
+            $table->index('expired_at');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('bans');
+    }
+}

database/migrations/2024_11_19_090718_add_banned_at_column_to_users_table.php

@@ -0,0 +1,28 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::table('users', function (Blueprint $table) {
+            $table->timestamp('banned_at')->nullable();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::table('users', function (Blueprint $table) {
+            $table->dropColumn('banned_at');
+        });
+    }
+};