Add forum subscription support

swilla · swilla · commit fa898a9237a2 · 2026-06-06T11:53:47.000-04:00
diff --git a/database/migrations/create_forum_post_subscriptions_table.php b/database/migrations/create_forum_post_subscriptions_table.php
@@ -0,0 +1,47 @@
+<?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::create('forum_post_subscriptions', function (Blueprint $table) {
+            $table->id();
+            $tenantColumn = null;
+
+            if (config('filament-forum.tenancy.enabled')) {
+                $tenantModel = config('filament-forum.tenancy.model');
+                $tenantColumn = config('filament-forum.tenancy.column')
+                    ?: str($tenantModel)->classBasename()->snake()->append('_id')->toString();
+
+                $table->foreignIdFor($tenantModel)
+                    ->constrained()
+                    ->cascadeOnDelete();
+            }
+
+            $table->foreignId('forum_post_id')->constrained()->cascadeOnDelete();
+            $table->foreignId('user_id')->constrained()->cascadeOnDelete();
+            $table->timestamps();
+
+            $uniqueColumns = config('filament-forum.tenancy.enabled')
+                ? [(string) $tenantColumn, 'forum_post_id', 'user_id']
+                : ['forum_post_id', 'user_id'];
+
+            $table->unique($uniqueColumns);
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('forum_post_subscriptions');
+    }
+};
diff --git a/database/migrations/create_forum_subscriptions_table.php b/database/migrations/create_forum_subscriptions_table.php
@@ -0,0 +1,47 @@
+<?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::create('forum_subscriptions', function (Blueprint $table) {
+            $table->id();
+            $tenantColumn = null;
+
+            if (config('filament-forum.tenancy.enabled')) {
+                $tenantModel = config('filament-forum.tenancy.model');
+                $tenantColumn = config('filament-forum.tenancy.column')
+                    ?: str($tenantModel)->classBasename()->snake()->append('_id')->toString();
+
+                $table->foreignIdFor($tenantModel)
+                    ->constrained()
+                    ->cascadeOnDelete();
+            }
+
+            $table->foreignId('forum_id')->constrained()->cascadeOnDelete();
+            $table->foreignId('user_id')->constrained()->cascadeOnDelete();
+            $table->timestamps();
+
+            $uniqueColumns = config('filament-forum.tenancy.enabled')
+                ? [(string) $tenantColumn, 'forum_id', 'user_id']
+                : ['forum_id', 'user_id'];
+
+            $table->unique($uniqueColumns);
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('forum_subscriptions');
+    }
+};
diff --git a/resources/lang/en/filament-forum.php b/resources/lang/en/filament-forum.php
@@ -17,6 +17,8 @@
     'forum.delete.modal.heading' => 'Delete Forum',
     'forum.delete.modal.description' => 'Are you sure you want to delete this forum? This action cannot be undone.',
     'forum.delete.notification' => 'Forum deleted successfully',
+    'forum.subscribe' => 'Follow forum',
+    'forum.unsubscribe' => 'Unfollow forum',
 
     /*
     |--------------------------------------------------------------------------
@@ -32,6 +34,8 @@
     'forum-post.unknown' => 'Unknown',
     'forum-post.last-reply' => 'Last reply',
     'forum-post.toggle-favorite' => 'Toggle Favorite',
+    'forum-post.subscribe' => 'Follow post',
+    'forum-post.unsubscribe' => 'Unfollow post',
     'forum-post.views' => '{0} No views yet|{1} :value view|[2,*] :value views',
     'forum-post.replies' => '{0} No reply yet|{1} :value reply|[2,*] :value replies',
 
diff --git a/src/Events/ForumPostSubscribed.php b/src/Events/ForumPostSubscribed.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace Tapp\FilamentForum\Events;
+
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+use Tapp\FilamentForum\Models\ForumPost;
+
+class ForumPostSubscribed
+{
+    use Dispatchable;
+    use SerializesModels;
+
+    public function __construct(
+        public mixed $user,
+        public ForumPost $forumPost,
+    ) {}
+}
diff --git a/src/Events/ForumPostUnsubscribed.php b/src/Events/ForumPostUnsubscribed.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace Tapp\FilamentForum\Events;
+
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+use Tapp\FilamentForum\Models\ForumPost;
+
+class ForumPostUnsubscribed
+{
+    use Dispatchable;
+    use SerializesModels;
+
+    public function __construct(
+        public mixed $user,
+        public ForumPost $forumPost,
+    ) {}
+}
diff --git a/src/Events/ForumSubscribed.php b/src/Events/ForumSubscribed.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace Tapp\FilamentForum\Events;
+
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+use Tapp\FilamentForum\Models\Forum;
+
+class ForumSubscribed
+{
+    use Dispatchable;
+    use SerializesModels;
+
+    public function __construct(
+        public mixed $user,
+        public Forum $forum,
+    ) {}
+}
diff --git a/src/Events/ForumUnsubscribed.php b/src/Events/ForumUnsubscribed.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace Tapp\FilamentForum\Events;
+
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+use Tapp\FilamentForum\Models\Forum;
+
+class ForumUnsubscribed
+{
+    use Dispatchable;
+    use SerializesModels;
+
+    public function __construct(
+        public mixed $user,
+        public Forum $forum,
+    ) {}
+}
diff --git a/src/Filament/Resources/ForumPosts/Schemas/ForumPostInfolist.php b/src/Filament/Resources/ForumPosts/Schemas/ForumPostInfolist.php
@@ -28,6 +28,13 @@ public static function configure(Schema $schema): Schema
                             ->tooltip(__('filament-forum::filament-forum.forum-post.toggle-favorite'))
                             ->icon(fn (ForumPost $record) => $record->isFavorite() ? 'heroicon-s-star' : 'heroicon-o-star')
                             ->action(fn (ForumPost $record) => $record->toggleFavorite()),
+                        Action::make('subscription')
+                            ->iconButton()
+                            ->tooltip(fn (ForumPost $record) => $record->isSubscribed()
+                                ? __('filament-forum::filament-forum.forum-post.unsubscribe')
+                                : __('filament-forum::filament-forum.forum-post.subscribe'))
+                            ->icon(fn (ForumPost $record) => $record->isSubscribed() ? 'heroicon-s-bell' : 'heroicon-o-bell')
+                            ->action(fn (ForumPost $record) => $record->toggleSubscription()),
                         Action::make('share')
                             ->icon('heroicon-o-share')
                             ->action(function ($livewire) {
diff --git a/src/Filament/Resources/Forums/Pages/ManageForumPosts.php b/src/Filament/Resources/Forums/Pages/ManageForumPosts.php
@@ -3,14 +3,17 @@
 namespace Tapp\FilamentForum\Filament\Resources\Forums\Pages;
 
 use BackedEnum;
+use Filament\Actions\Action;
 use Filament\Actions\CreateAction;
 use Filament\Panel;
 use Filament\Resources\Pages\ManageRelatedRecords;
 use Filament\Tables\Table;
 use Illuminate\Contracts\Support\Htmlable;
+use Illuminate\Support\Facades\Auth;
 use Tapp\FilamentForum\Filament\Resources\ForumPosts\ForumPostResource;
 use Tapp\FilamentForum\Filament\Resources\ForumPosts\Tables\ForumPostsTable;
 use Tapp\FilamentForum\Filament\Resources\Forums\ForumResource;
+use Tapp\FilamentForum\Models\Forum;
 use Tapp\FilamentForum\Models\ForumPost;
 
 class ManageForumPosts extends ManageRelatedRecords
@@ -43,15 +46,35 @@ public function table(Table $table): Table
     {
         return ForumPostsTable::configure($table)
             ->headerActions([
+                Action::make('subscription')
+                    ->label(fn (): string => $this->forumSubscriptionRecord()->isSubscribed()
+                        ? __('filament-forum::filament-forum.forum.unsubscribe')
+                        : __('filament-forum::filament-forum.forum.subscribe'))
+                    ->icon(fn (): string => $this->forumSubscriptionRecord()->isSubscribed() ? 'heroicon-s-bell' : 'heroicon-o-bell')
+                    ->visible(fn (): bool => Auth::check())
+                    ->action(fn () => $this->toggleForumSubscription()),
                 CreateAction::make(),
             ]);
     }
 
+    public function toggleForumSubscription(): void
+    {
+        $this->forumSubscriptionRecord()->toggleSubscription();
+    }
+
     public function toggleFavorite($recordId)
     {
         $forumPostrecord = ForumPost::find($recordId);
         $forumPostrecord->toggleFavorite();
 
         $this->dispatch('favorite-toggled', recordId: $recordId, isFavorite: $forumPostrecord->isFavorite());
     }
+
+    protected function forumSubscriptionRecord(): Forum
+    {
+        /** @var Forum $forum */
+        $forum = $this->getOwnerRecord();
+
+        return $forum;
+    }
 }
diff --git a/src/FilamentForumServiceProvider.php b/src/FilamentForumServiceProvider.php
@@ -34,6 +34,8 @@ public function configurePackage(Package $package): void
                 'create_forum_user_table',
                 'create_forum_posts_table',
                 'create_favorite_forum_post_table',
+                'create_forum_subscriptions_table',
+                'create_forum_post_subscriptions_table',
                 'create_forum_post_views_table',
                 'create_forum_comments_table',
                 'create_forum_comment_reactions_table',
diff --git a/src/Models/Forum.php b/src/Models/Forum.php
@@ -16,10 +16,12 @@
 use Spatie\MediaLibrary\InteractsWithMedia;
 use Tapp\FilamentForum\Database\Factories\ForumFactory;
 use Tapp\FilamentForum\Models\Traits\BelongsToTenant;
+use Tapp\FilamentForum\Models\Traits\CanSubscribeToForum;
 
 class Forum extends Model implements HasMedia
 {
     use BelongsToTenant;
+    use CanSubscribeToForum;
 
     /** @use HasFactory<ForumFactory> */
     use HasFactory;
diff --git a/src/Models/ForumPost.php b/src/Models/ForumPost.php
@@ -13,11 +13,13 @@
 use Tapp\FilamentForum\Events\PostWasReacted;
 use Tapp\FilamentForum\Models\Traits\BelongsToTenant;
 use Tapp\FilamentForum\Models\Traits\CanFavoriteForumPost;
+use Tapp\FilamentForum\Models\Traits\CanSubscribeToForumPost;
 
 class ForumPost extends Model
 {
     use BelongsToTenant;
     use CanFavoriteForumPost;
+    use CanSubscribeToForumPost;
 
     /** @use HasFactory<ForumPostFactory> */
     use HasFactory;
diff --git a/src/Models/Traits/CanSubscribeToForum.php b/src/Models/Traits/CanSubscribeToForum.php
@@ -0,0 +1,102 @@
+<?php
+
+namespace Tapp\FilamentForum\Models\Traits;
+
+use Filament\Facades\Filament;
+use Illuminate\Contracts\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+use Tapp\FilamentForum\Events\ForumSubscribed;
+use Tapp\FilamentForum\Events\ForumUnsubscribed;
+
+trait CanSubscribeToForum
+{
+    public function toggleSubscription($user = null): void
+    {
+        $user ??= auth()->user();
+
+        if (! $user) {
+            return;
+        }
+
+        if ($this->isSubscribed($user)) {
+            $this->subscribedUsers()->detach($user->getKey());
+
+            ForumUnsubscribed::dispatch($user, $this);
+
+            return;
+        }
+
+        $this->subscribedUsers()->attach($user->getKey(), $this->subscriptionPivotData());
+
+        ForumSubscribed::dispatch($user, $this);
+    }
+
+    public function isSubscribed($user = null): bool
+    {
+        $user ??= auth()->user();
+
+        if (! $user) {
+            return false;
+        }
+
+        return $this->subscribedUsers()
+            ->whereKey($user->getKey())
+            ->when(
+                config('filament-forum.tenancy.enabled') && Filament::hasTenancy(),
+                fn (Builder $query) => $query->where(
+                    'forum_subscriptions.'.static::getTenantColumnName(),
+                    Filament::getTenant()->getKey(),
+                ),
+            )
+            ->exists();
+    }
+
+    public function getIsSubscribedAttribute(): bool
+    {
+        return $this->isSubscribed();
+    }
+
+    public function subscribedUsers(): BelongsToMany
+    {
+        $relationship = $this->belongsToMany(config('auth.providers.users.model'), 'forum_subscriptions');
+
+        if (config('filament-forum.tenancy.enabled')) {
+            $relationship->withPivot(static::getTenantColumnName());
+        }
+
+        return $relationship->withTimestamps();
+    }
+
+    public function scopeSubscribed($query): Builder
+    {
+        return $query->whereHas('subscribedUsers', function ($query) {
+            $query->where('forum_subscriptions.user_id', auth()->id());
+
+            if (config('filament-forum.tenancy.enabled') && Filament::hasTenancy()) {
+                $query->where('forum_subscriptions.'.static::getTenantColumnName(), Filament::getTenant()->getKey());
+            }
+        });
+    }
+
+    public function scopeNotSubscribed($query): Builder
+    {
+        return $query->whereDoesntHave('subscribedUsers', function ($query) {
+            $query->where('forum_subscriptions.user_id', auth()->id());
+
+            if (config('filament-forum.tenancy.enabled') && Filament::hasTenancy()) {
+                $query->where('forum_subscriptions.'.static::getTenantColumnName(), Filament::getTenant()->getKey());
+            }
+        });
+    }
+
+    protected function subscriptionPivotData(): array
+    {
+        if (! config('filament-forum.tenancy.enabled') || ! Filament::hasTenancy()) {
+            return [];
+        }
+
+        return [
+            static::getTenantColumnName() => Filament::getTenant()->getKey(),
+        ];
+    }
+}
diff --git a/src/Models/Traits/CanSubscribeToForumPost.php b/src/Models/Traits/CanSubscribeToForumPost.php
diff --git a/src/Models/Traits/HasForumSubscriptions.php b/src/Models/Traits/HasForumSubscriptions.php
diff --git a/tests/Feature/ForumSubscriptionTest.php b/tests/Feature/ForumSubscriptionTest.php
diff --git a/tests/Models/User.php b/tests/Models/User.php
