add only parameter for collection and save search

ushahidi · Nov 1, 2024 · 5a83780 · 5a83780
1 parent 9376f6f
commit 5a83780
Show file tree

Hide file tree

Showing 17 changed files with 305 additions and 268 deletions.
diff --git a/src/Ushahidi/Modules/V5/Actions/Collection/Handlers/FetchCollectionByIdQueryHandler.php b/src/Ushahidi/Modules/V5/Actions/Collection/Handlers/FetchCollectionByIdQueryHandler.php
@@ -33,6 +33,14 @@ protected function isSupported(Query $query)
     public function __invoke($query) //: array
     {
         $this->isSupported($query);
-        return $this->collection_repository->findById($query->getId());
+        return $this->collection_repository->findById(
+            $query->getId(),
+            false,
+            array_unique(array_merge(
+                $query->getFields(),
+                $query->getFieldsForRelationship()
+            )),
+            $query->getWithRelationship()
+        );
     }
 }
diff --git a/src/Ushahidi/Modules/V5/Actions/Collection/Handlers/FetchCollectionQueryHandler.php b/src/Ushahidi/Modules/V5/Actions/Collection/Handlers/FetchCollectionQueryHandler.php
@@ -46,41 +46,13 @@ protected function isSupported(Query $query)
      */
     public function __invoke($query) //: LengthAwarePaginator
     {
-        // TODO: This is redundant, we should be able to remove this
         $this->isSupported($query);
-
-        $search_fields = $query->getSearchData();
-
-        $search = new SearchData();
-
-        // TODO: Move this to the Query class
-        $user = Auth::guard()->user();
-
-        $search->setFilter('is_saved_search', false);
-        $search->setFilter('with_post_count', true);
-
-        // Querying Values
-        $search->setFilter('keyword', $search_fields->q());
-        $search->setFilter('role', $search_fields->role());
-        $search->setFilter('is_admin', $search_fields->role() === "admin");
-        $search->setFilter('user_id', $user->id ?? null);
-
-        // Paging Values
-        $limit = $query->getLimit();
-
-        $search->setFilter('limit', $limit);
-        $search->setFilter('skip', $limit * ($query->getPage() - 1));
-
-        // Sorting Values
-        $search->setFilter('sort', $query->getSortBy());
-        $search->setFilter('order', $query->getOrder());
-
-        $this->collection_repository->setSearchParams($search);
-
-        // TODO: We shouldn't let the repository return a Laravel paginator instance,
-        // this should be created in the controller
-        $result = $this->collection_repository->fetch();
-
-        return $result;
+        $only_fields =  array_unique(array_merge($query->getFields(), $query->getFieldsForRelationship()));
+        return $this->collection_repository->paginate(
+            $query->getPaging(),
+            $query->getSearchFields(),
+            $only_fields,
+            $query->getWithRelationship()
+        );
     }
 }
diff --git a/src/Ushahidi/Modules/V5/Actions/Collection/Queries/FetchCollectionByIdQuery.php b/src/Ushahidi/Modules/V5/Actions/Collection/Queries/FetchCollectionByIdQuery.php
@@ -3,10 +3,13 @@
 namespace Ushahidi\Modules\V5\Actions\Collection\Queries;
 
 use App\Bus\Query\Query;
+use Ushahidi\Modules\V5\Traits\OnlyParameter\QueryWithOnlyParameter;
+use Illuminate\Http\Request;
+use Ushahidi\Modules\V5\Models\Set as CollectionModel;
 
 class FetchCollectionByIdQuery implements Query
 {
-
+    use QueryWithOnlyParameter;
 
     /**
      * int
@@ -15,10 +18,24 @@ class FetchCollectionByIdQuery implements Query
 
     public function __construct(int $id = 0)
     {
-
         $this->id = $id;
     }
 
+    public static function fromRequest(int $id, Request $request): self
+    {
+        if ($id <= 0) {
+            throw new \InvalidArgumentException('Id must be a positive number');
+        }
+        $query =  new self($id);
+        $query->addOnlyParameteresFromRequest(
+            $request,
+            CollectionModel::COLLECTION_ALLOWED_FIELDS,
+            CollectionModel::ALLOWED_RELATIONSHIPS,
+            CollectionModel::REQUIRED_FIELDS
+        );
+        return $query;
+    }
+
     public function getId(): int
     {
         return $this->id;

diff --git a/src/Ushahidi/Modules/V5/Actions/Collection/Queries/FetchCollectionQuery.php b/src/Ushahidi/Modules/V5/Actions/Collection/Queries/FetchCollectionQuery.php
@@ -4,55 +4,33 @@
 
 use App\Bus\Query\Query;
 use Ushahidi\Modules\V5\DTO\CollectionSearchFields;
+use Ushahidi\Modules\V5\Traits\OnlyParameter\QueryWithOnlyParameter;
+use Ushahidi\Modules\V5\Traits\HasPaginate;
+use Ushahidi\Modules\V5\Traits\HasSearchFields;
+use Illuminate\Http\Request;
+use Ushahidi\Modules\V5\Models\Set as CollectionModel;
 
 class FetchCollectionQuery implements Query
 {
+    use QueryWithOnlyParameter;
+    use HasPaginate;
+    use HasSearchFields;
+
     const DEFAULT_LIMIT = 0;
     const DEFAULT_ORDER = "DESC";
     const DEFAULT_SORT_BY = "featured";
 
-    private $limit;
-    private $page;
-    private $sortBy;
-    private $order;
-    private $search_data;
-
-    public function __construct(
-        int $limit,
-        int $page,
-        string $sortBy,
-        string $order,
-        CollectionSearchFields $search_data
-    ) {
-        $this->limit = $limit;
-        $this->page = $page;
-        $this->sortBy = $sortBy;
-        $this->order = $order;
-        $this->search_data = $search_data;
-    }
-
-    public function getLimit(): int
-    {
-        return $this->limit > 0 ? $this->limit : config('paging.default_laravel_pageing_limit');
-    }
-
-    public function getPage(): int
-    {
-        return $this->page;
-    }
-
-    public function getSortBy(): string
-    {
-        return $this->sortBy;
-    }
-
-    public function getOrder(): string
-    {
-        return $this->order;
-    }
-
-    public function getSearchData()
+    public static function fromRequest(Request $request): self
     {
-        return $this->search_data;
+        $query = new self();
+        $query->setPaging($request, self::DEFAULT_SORT_BY, self::DEFAULT_ORDER, self::DEFAULT_LIMIT);
+        $query->setSearchFields(new CollectionSearchFields($request));
+        $query->addOnlyParameteresFromRequest(
+            $request,
+            CollectionModel::COLLECTION_ALLOWED_FIELDS,
+            CollectionModel::ALLOWED_RELATIONSHIPS,
+            CollectionModel::REQUIRED_FIELDS
+        );
+        return $query;
     }
 }
diff --git a/src/Ushahidi/Modules/V5/Actions/SavedSearch/Handlers/FetchSavedSearchByIdQueryHandler.php b/src/Ushahidi/Modules/V5/Actions/SavedSearch/Handlers/FetchSavedSearchByIdQueryHandler.php
@@ -25,14 +25,21 @@ protected function isSupported(Query $query)
         );
     }
 
-
     /**
      * @param FetchSavedSearchByIdQuery $query
      * @return array
      */
     public function __invoke($query) //: array
     {
         $this->isSupported($query);
-        return $this->saved_search_repository->findById($query->getId(), 1);
+        return $this->saved_search_repository->findById(
+            $query->getId(),
+            1,
+            array_unique(array_merge(
+                $query->getFields(),
+                $query->getFieldsForRelationship()
+            )),
+            $query->getWithRelationship()
+        );
     }
 }
diff --git a/src/Ushahidi/Modules/V5/Actions/SavedSearch/Handlers/FetchSavedSearchQueryHandler.php b/src/Ushahidi/Modules/V5/Actions/SavedSearch/Handlers/FetchSavedSearchQueryHandler.php
@@ -6,8 +6,6 @@
 use App\Bus\Query\Query;
 use Ushahidi\Modules\V5\Actions\SavedSearch\Queries\FetchSavedSearchQuery;
 use Ushahidi\Modules\V5\Repository\Set\SetRepository as SavedSearchRepository;
-use Ushahidi\Core\Tool\SearchData;
-use Illuminate\Support\Facades\Auth;
 
 class FetchSavedSearchQueryHandler extends AbstractQueryHandler
 {
@@ -33,32 +31,12 @@ protected function isSupported(Query $query)
     public function __invoke($query) //: LengthAwarePaginator
     {
         $this->isSupported($query);
-
-        $search_fields = $query->getSearchData();
-
-        $search = new SearchData();
-        $user = Auth::guard()->user();
-
-        $search->setFilter('keyword', $search_fields->q());
-        $search->setFilter('role', $search_fields->role());
-        $search->setFilter('is_admin', $search_fields->role() == "admin");
-        // $search->setFilter('is_guest', !Auth::user() || !Auth::user()->id);
-        // $search->setFilter('is_me_only', $search_fields->public());
-        $search->setFilter('user_id', $user->id ?? null);
-
-        $search->setFilter('is_saved_search', true);
-
-        // Paging Values
-        $limit = $query->getLimit() ?? config('paging.default_laravel_pageing_limit');
-        $search->setFilter('limit', $limit);
-        $search->setFilter('skip', $limit * ($query->getPage() - 1));
-
-        // Sorting Values
-        $search->setFilter('sort', $query->getSortBy());
-        $search->setFilter('order', $query->getOrder());
-
-        $this->saved_search_repository->setSearchParams($search);
-
-        return $this->saved_search_repository->fetch();
+        $only_fields =  array_unique(array_merge($query->getFields(), $query->getFieldsForRelationship()));
+        return $this->saved_search_repository->paginate(
+            $query->getPaging(),
+            $query->getSearchFields(),
+            $only_fields,
+            $query->getWithRelationship()
+        );
     }
 }
diff --git a/src/Ushahidi/Modules/V5/Actions/SavedSearch/Queries/FetchSavedSearchByIdQuery.php b/src/Ushahidi/Modules/V5/Actions/SavedSearch/Queries/FetchSavedSearchByIdQuery.php
@@ -3,10 +3,13 @@
 namespace Ushahidi\Modules\V5\Actions\SavedSearch\Queries;
 
 use App\Bus\Query\Query;
+use Ushahidi\Modules\V5\Traits\OnlyParameter\QueryWithOnlyParameter;
+use Illuminate\Http\Request;
+use Ushahidi\Modules\V5\Models\Set as SavedSearch;
 
 class FetchSavedSearchByIdQuery implements Query
 {
-
+    use QueryWithOnlyParameter;
 
     /**
      * int
@@ -15,10 +18,19 @@ class FetchSavedSearchByIdQuery implements Query
 
     public function __construct(int $id = 0)
     {
-
         $this->id = $id;
     }
 
+    public static function fromRequest(int $id, Request $request): self
+    {
+        if ($id <= 0) {
+            throw new \InvalidArgumentException('Id must be a positive number');
+        }
+        $query =  new self($id);
+        $query->addOnlyParameteresFromRequest($request, SavedSearch::ALLOWED_FIELDS, SavedSearch::ALLOWED_RELATIONSHIPS, SavedSearch::REQUIRED_FIELDS);
+        return $query;
+    }
+
     public function getId(): int
     {
         return $this->id;

diff --git a/src/Ushahidi/Modules/V5/Actions/SavedSearch/Queries/FetchSavedSearchQuery.php b/src/Ushahidi/Modules/V5/Actions/SavedSearch/Queries/FetchSavedSearchQuery.php
@@ -4,55 +4,28 @@
 
 use App\Bus\Query\Query;
 use Ushahidi\Modules\V5\DTO\SavedSearchSearchFields;
+use Ushahidi\Modules\V5\Traits\OnlyParameter\QueryWithOnlyParameter;
+use Ushahidi\Modules\V5\Traits\HasPaginate;
+use Ushahidi\Modules\V5\Traits\HasSearchFields;
+use Illuminate\Http\Request;
+use Ushahidi\Modules\V5\Models\Set;
 
 class FetchSavedSearchQuery implements Query
 {
+    use QueryWithOnlyParameter;
+    use HasPaginate;
+    use HasSearchFields;
+
     const DEFAULT_LIMIT = 0;
     const DEFAULT_ORDER = "ASC";
     const DEFAULT_SORT_BY = "id";
 
-    private $limit;
-    private $page;
-    private $sortBy;
-    private $order;
-    private $search_data;
-
-    public function __construct(
-        int $limit,
-        int $page,
-        string $sortBy,
-        string $order,
-        SavedSearchSearchFields $search_data
-    ) {
-        $this->limit = $limit;
-        $this->page = $page;
-        $this->sortBy = $sortBy;
-        $this->order = $order;
-        $this->search_data = $search_data;
-    }
-
-    public function getLimit(): int
-    {
-        return $this->limit;
-    }
-
-    public function getPage(): int
-    {
-        return $this->page;
-    }
-
-    public function getSortBy(): string
-    {
-        return $this->sortBy;
-    }
-
-    public function getOrder(): string
-    {
-        return $this->order;
-    }
-
-    public function getSearchData()
+    public static function fromRequest(Request $request): self
     {
-        return $this->search_data;
+        $query = new self();
+        $query->setPaging($request, self::DEFAULT_SORT_BY, self::DEFAULT_ORDER, self::DEFAULT_LIMIT);
+        $query->setSearchFields(new SavedSearchSearchFields($request));
+        $query->addOnlyParameteresFromRequest($request, Set::ALLOWED_FIELDS, Set::ALLOWED_RELATIONSHIPS, Set::REQUIRED_FIELDS);
+        return $query;
     }
 }