Merge pull request #20 from laravelcm/feature-forum

Feature forum

Author: mckenziearts

app/Filters/AbstractFilter.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Arr;
+
+abstract class AbstractFilter
+{
+    abstract public function filter(Builder $builder, $value): Builder;
+
+    public function mappings(): array
+    {
+        return [];
+    }
+
+    protected function resolveFilterValue($key)
+    {
+        return Arr::get($this->mappings(), $key);
+    }
+}

app/Filters/AbstractFilters.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace App\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\Request;
+
+abstract class AbstractFilters
+{
+    protected Builder $builder;
+
+    protected array $filters = [];
+
+    public function __construct(public Request $request)
+    {
+    }
+
+    /**
+     * Get all filters and make a new instance.
+     *
+     * @param  Builder $builder
+     * @return Builder
+     */
+    public function filter(Builder $builder): Builder
+    {
+        foreach ($this->getFilters() as $filter => $value) {
+            $this->resolverFilter($filter)->filter($builder, $value);
+        }
+
+        return $builder;
+    }
+
+    /**
+     * Add Filters to current filter class.
+     *
+     * @param  array $filters
+     * @return $this
+     */
+    public function add(array $filters): self
+    {
+        $this->filters = array_merge($this->filters, $filters);
+
+        return $this;
+    }
+
+    /**
+     * Get the Filter instance Class.
+     *
+     * @param  $filter
+     * @return mixed
+     */
+    public function resolverFilter($filter)
+    {
+        return new $this->filters[$filter];
+    }
+
+    /**
+     * Fetch all relevant filters from the request.
+     *
+     * @return array
+     */
+    public function getFilters(): array
+    {
+        return array_filter($this->request->only(array_keys($this->filters)));
+    }
+}

app/Filters/Thread/SortByFilter.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Filters\Thread;
+
+use App\Filters\AbstractFilter;
+use Illuminate\Database\Eloquent\Builder;
+
+class SortByFilter extends AbstractFilter
+{
+    public function mappings(): array
+    {
+        return [
+            'recent' => 'recent',
+            'resolved' => 'resolved',
+            'unresolved' => 'unresolved',
+        ];
+    }
+
+    public function filter(Builder $builder, $value): Builder
+    {
+        $value = $this->resolveFilterValue($value);
+
+        switch ($value) {
+            case null:
+                return $builder;
+            case 'recent':
+                return $builder->recent();
+            case 'resolved':
+                return $builder->resolved();
+            case 'unresolved':
+                return $builder->unresolved();
+        }
+    }
+}

app/Filters/Thread/ThreadFilters.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Filters\Thread;
+
+use App\Filters\AbstractFilters;
+
+class ThreadFilters extends AbstractFilters
+{
+    /**
+     * Registered filters to operate upon.
+     *
+     * @var array
+     */
+    protected array $filters = [
+        'sortBy' => SortByFilter::class,
+    ];
+}

app/Http/Controllers/Forum/ThreadController.php

@@ -5,6 +5,7 @@
 use App\Http\Controllers\Controller;
 use App\Models\Channel;
 use App\Models\Thread;
+use Illuminate\Http\Request;
 
 class ThreadController extends Controller
 {
@@ -13,14 +14,24 @@ public function __construct()
         $this->middleware(['auth', 'verified'], ['only' => ['create']]);
     }
 
-    public function index()
+    public function index(Request $request)
     {
-        return view('forum.index', ['channel' => null]);
+        $filter = getFilter('sortBy', ['recent', 'resolved', 'unresolved']);
+        $threads = Thread::filter($request)->withviewscount()->paginate(10);
+
+        return view('forum.index', [
+            'channel' => null,
+            'threads' => $threads,
+            'filter' => $filter,
+        ]);
     }
 
-    public function channel(Channel $channel)
+    public function channel(Request $request, Channel $channel)
     {
-        return view('forum.index', compact('channel'));
+        $filter = getFilter('sortBy', ['recent', 'resolved', 'unresolved']);
+        $threads = Thread::forChannel($channel)->filter($request)->withviewscount()->paginate(10);
+
+        return view('forum.index', compact('channel', 'threads', 'filter'));
     }
 
     public function create()

app/Http/Livewire/Forum/Browse.php

@@ -6,6 +6,7 @@
 use App\Contracts\ReplyInterface;
 use App\Contracts\SubscribeInterface;
 use App\Exceptions\CouldNotMarkReplyAsSolution;
+use App\Filters\Thread\ThreadFilters;
 use App\Traits\HasAuthor;
 use App\Traits\HasReplies;
 use App\Traits\HasSlug;
@@ -16,9 +17,7 @@
 use CyrildeWit\EloquentViewable\Contracts\Viewable;
 use CyrildeWit\EloquentViewable\InteractsWithViews;
 use Exception;
-use Illuminate\Contracts\Pagination\Paginator;
 use Illuminate\Database\Eloquent\Builder;
-use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
@@ -171,26 +170,37 @@ public function unmarkSolution()
         $this->save();
     }
 
-    public function scopeResolved(Builder $query): Builder
+    public function scopeForChannel(Builder $query, Channel $channel): Builder
     {
-        return $query->whereNotNull('solution_reply_id');
+        return $query->whereHas('channels', function ($query) use ($channel) {
+            if ($channel->hasItems()) {
+                $query->whereIn('channels.id', array_merge([$channel->id], $channel->items->modelKeys()));
+            } else {
+                $query->where('channels.slug', $channel->slug());
+            }
+        });
     }
 
-    public function scopeUnresolved(Builder $query): Builder
+    public function scopeRecent(Builder $query): Builder
     {
-        return $query->whereNull('solution_reply_id');
+        return $query->feedQuery()->orderByDesc('last_posted_at');
     }
 
-    public function scopeForChannel(Builder $query, string $channel): Builder
+    public function scopeResolved(Builder $query): Builder
     {
-        return $query->whereHas('channels', function ($query) use ($channel) {
-            $query->where('channels.slug', $channel);
-        });
+        return $query->feedQuery()
+            ->whereNotNull('solution_reply_id');
     }
 
-    public function scopeRecent(Builder $query): Builder
+    public function scopeUnresolved(Builder $query): Builder
+    {
+        return $query->feedQuery()
+            ->whereNull('solution_reply_id');
+    }
+
+    public function scopeFilter(Builder $builder, $request, array $filters = []): Builder
     {
-        return self::feedQuery()->orderByDesc('created_at');
+        return (new ThreadFilters($request))->add($filters)->filter($builder);
     }
 
     public function delete()
@@ -214,37 +224,12 @@ public function toFeedItem(): FeedItem
             ->authorName($this->user->name);
     }
 
-    public static function feed(int $limit = 20): Collection
-    {
-        return static::feedQuery()->limit($limit)->get();
-    }
-
-    public static function feedPaginated(int $perPage = 20): Paginator
-    {
-        return static::feedQuery()->paginate($perPage);
-    }
-
-    public static function feedByChannelPaginated(Channel $channel, int $perPage = 20): Paginator
-    {
-        return static::feedByChannelQuery($channel)
-            ->paginate($perPage);
-    }
-
-    public static function feedByChannelQuery(Channel $channel): Builder
-    {
-        return static::feedQuery()
-            ->join('channel_thread', function ($join) {
-                $join->on('threads.id', 'channel_thread.thread_id');
-            })
-            ->where('channel_thread.channel_id', $channel->id);
-    }
-
     /**
      * This will order the threads by creation date and latest reply.
      */
-    public static function feedQuery(): Builder
+    public function scopeFeedQuery(Builder $query): Builder
     {
-        return static::with([
+        return $query->with([
             'solutionReply',
             'replies',
             'reactions',
@@ -283,7 +268,7 @@ public static function resolutionTime()
 
     public static function getFeedItems(): SupportCollection
     {
-        return static::feedQuery()
+        return static::with(['reactions'])->feedQuery()
             ->paginate(static::FEED_PAGE_SIZE)
             ->getCollection();
     }

app/Models/Thread.php

@@ -70,3 +70,12 @@ function canonical(string $route, array $params = []): string
         return route($route, $params);
     }
 }
+
+if (! function_exists('getFilter')) {
+    function getFilter(string $key, array $filters = [], string $default = 'recent'): string
+    {
+        $filter = (string) request($key);
+
+        return in_array($filter, $filters) ? $filter : $default;
+    }
+}

app/helpers.php

@@ -0,0 +1,28 @@
+<nav class="relative z-0 rounded-lg shadow flex divide-x divide-skin-base" aria-label="Tabs">
+    <a
+        href="{{ url(request()->url() . '?sortBy=recent') }}"
+        aria-current="{{ $filter === 'recent' ? 'page' : 'false' }}"
+        class="w-full {{ $filter === 'recent' ? 'text-skin-inverted': 'text-skin-base hover:text-skin-inverted' }} rounded-l-lg group relative min-w-0 flex-1 overflow-hidden bg-skin-card py-4 px-6 text-sm font-medium text-center hover:bg-skin-card-muted focus:z-10"
+    >
+        <span>Récent</span>
+        <span aria-hidden="true" class="{{ $filter === 'recent' ? 'bg-skin-primary': 'bg-transparent' }} absolute inset-x-0 bottom-0 h-0.5"></span>
+    </a>
+
+    <a
+        href="{{ url(request()->url() . '?sortBy=resolved') }}"
+        aria-current="{{ $filter === 'resolved' ? 'page' : 'false' }}"
+        class="w-full {{ $filter === 'resolved' ? 'text-skin-inverted': 'text-skin-base hover:text-skin-inverted' }} group relative min-w-0 flex-1 overflow-hidden bg-skin-card py-4 px-6 text-sm font-medium text-center hover:bg-skin-card-muted focus:z-10"
+    >
+        <span>Résolu</span>
+        <span aria-hidden="true" class="{{ $filter === 'resolved' ? 'bg-skin-primary': 'bg-transparent' }} absolute inset-x-0 bottom-0 h-0.5"></span>
+    </a>
+
+    <a
+        href="{{ url(request()->url() . '?sortBy=unresolved') }}"
+        aria-current="{{ $filter === 'unresolved' ? 'page' : 'false' }}"
+        class="w-full {{ $filter === 'unresolved' ? 'text-skin-inverted': 'text-skin-base hover:text-skin-inverted' }} rounded-r-lg group relative min-w-0 flex-1 overflow-hidden bg-skin-card py-4 px-6 text-sm font-medium text-center hover:bg-skin-card-muted focus:z-10"
+    >
+        <span>Non résolu</span>
+        <span aria-hidden="true" class="{{ $filter === 'unresolved' ? 'bg-skin-primary': 'bg-transparent' }} absolute inset-x-0 bottom-0 h-0.5"></span>
+    </a>
+</nav>