improves Filter tool naming

matiux · Oct 24, 2022 · a767eb2 · a767eb2
1 parent 90ba1bb
commit a767eb2
Show file tree

Hide file tree

Showing 23 changed files with 229 additions and 229 deletions.
diff --git a/src/Matiux/DDDStarterPack/Aggregate/Domain/Repository/Filter/FilterApplier.php b/src/Matiux/DDDStarterPack/Aggregate/Domain/Repository/Filter/FilterApplier.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DDDStarterPack\Aggregate\Domain\Repository\Filter;
+
+/**
+ * @template T
+ */
+interface FilterApplier
+{
+    public function key(): string;
+
+    /**
+     * @param T                     $target
+     * @param FilterApplierRegistry $filterApplierRegistry
+     */
+    public function apply($target, FilterApplierRegistry $filterApplierRegistry): void;
+
+    public function supports(FilterApplierRegistry $filterApplierRegistry): bool;
+}
diff --git a/...Domain/Repository/Filter/FilterParams.php → ...pository/Filter/FilterApplierRegistry.php b/...Domain/Repository/Filter/FilterParams.php → ...pository/Filter/FilterApplierRegistry.php
@@ -6,39 +6,39 @@
 
 use InvalidArgumentException;
 
-class FilterParams
+class FilterApplierRegistry
 {
-    /** @var FilterParamsApplier[] */
-    protected array $appliers = [];
+    /** @var FilterApplier[] */
+    protected array $filterAppliers = [];
 
     /**
-     * @param array<array-key, FilterParamsApplier> $appliers
-     * @param array                                 $neededFilters
+     * @param array<array-key, FilterApplier> $filterAppliers
+     * @param array                           $neededFilters
      */
-    public function __construct(array $appliers, protected array $neededFilters)
+    public function __construct(array $filterAppliers, protected array $neededFilters)
     {
-        $this->setAppliers($appliers);
+        $this->setAppliers($filterAppliers);
     }
 
     /**
-     * @param FilterParamsApplier[] $appliers
+     * @param FilterApplier[] $filterAppliers
      */
-    private function setAppliers(array $appliers): void
+    private function setAppliers(array $filterAppliers): void
     {
-        foreach ($appliers as $applier) {
+        foreach ($filterAppliers as $applier) {
             $this->addApplier($applier);
         }
     }
 
-    public function addApplier(FilterParamsApplier $applier): void
+    public function addApplier(FilterApplier $filterApplier): void
     {
-        $key = $applier->key();
+        $key = $filterApplier->key();
 
-        if (isset($this->appliers[$key])) {
+        if (isset($this->filterAppliers[$key])) {
             throw new InvalidArgumentException("Applier for key '{$key}' is already set");
         }
 
-        $this->appliers[$key] = $applier;
+        $this->filterAppliers[$key] = $filterApplier;
     }
 
     /**
@@ -63,7 +63,7 @@ public function getFilterValueForKey(string $key, string $default = ''): mixed
 
     public function applyToTarget(mixed $target): void
     {
-        foreach ($this->appliers as $applier) {
+        foreach ($this->filterAppliers as $applier) {
             if ($applier->supports($this)) {
                 $applier->apply($target, $this);
             }

diff --git a/src/Matiux/DDDStarterPack/Aggregate/Domain/Repository/Filter/FilterBuilder.php b/src/Matiux/DDDStarterPack/Aggregate/Domain/Repository/Filter/FilterBuilder.php
@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DDDStarterPack\Aggregate\Domain\Repository\Filter;
+
+use InvalidArgumentException;
+use LogicException;
+use Traversable;
+
+class FilterBuilder
+{
+    /** @var FilterApplier[] */
+    protected array $filterAppliers = [];
+
+    protected bool $frozen = false;
+
+    /**
+     * @param FilterApplier[]|Traversable<FilterApplier> $filterAppliers
+     */
+    public function __construct($filterAppliers = [])
+    {
+        if ($filterAppliers instanceof Traversable) {
+            $filterAppliers = iterator_to_array($filterAppliers);
+        }
+
+        foreach ($filterAppliers as $applier) {
+            $this->addApplier($applier);
+        }
+    }
+
+    public function addApplier(FilterApplier $filterApplier): void
+    {
+        if ($this->frozen) {
+            throw new LogicException('The builder is frozen');
+        }
+
+        $key = $filterApplier->key();
+
+        if (isset($this->filterAppliers[$key])) {
+            throw new InvalidArgumentException("Applier for key '{$key}' is already set");
+        }
+
+        $this->filterAppliers[$key] = $filterApplier;
+    }
+
+    public function build(array $neededFilters): FilterApplierRegistry
+    {
+        $this->frozen = true;
+
+        return new FilterApplierRegistry(array_values($this->filterAppliers), $neededFilters);
+    }
+}
diff --git a/src/Matiux/DDDStarterPack/Aggregate/Domain/Repository/Filter/FilterParamsApplier.php b/src/Matiux/DDDStarterPack/Aggregate/Domain/Repository/Filter/FilterParamsApplier.php
diff --git a/src/Matiux/DDDStarterPack/Aggregate/Domain/Repository/Filter/FilterParamsBuilder.php b/src/Matiux/DDDStarterPack/Aggregate/Domain/Repository/Filter/FilterParamsBuilder.php
diff --git a/src/Matiux/DDDStarterPack/Aggregate/Domain/Repository/Filter/PaginationFilterRequest.php b/src/Matiux/DDDStarterPack/Aggregate/Domain/Repository/Filter/PaginationFilterRequest.php
@@ -14,8 +14,8 @@ trait PaginationFilterRequest
     public function withPagination(null|int $page, null|int $perPage): self
     {
         if ($page && $perPage) {
-            $this->paginationFilters[PaginationFilterParamsApplierKeys::PAGE] = $page;
-            $this->paginationFilters[PaginationFilterParamsApplierKeys::PER_PAGE] = $perPage;
+            $this->paginationFilters[PaginationKeyFilterApplier::PAGE] = $page;
+            $this->paginationFilters[PaginationKeyFilterApplier::PER_PAGE] = $perPage;
         }
 
         return $this;

diff --git a/...ter/PaginationFilterParamsApplierKeys.php → ...ory/Filter/PaginationKeyFilterApplier.php b/...ter/PaginationFilterParamsApplierKeys.php → ...ory/Filter/PaginationKeyFilterApplier.php
@@ -4,7 +4,7 @@
 
 namespace DDDStarterPack\Aggregate\Domain\Repository\Filter;
 
-interface PaginationFilterParamsApplierKeys
+interface PaginationKeyFilterApplier
 {
     public const PAGE = 'page';
     public const PER_PAGE = 'per_page';

diff --git a/src/Matiux/DDDStarterPack/Aggregate/Domain/Repository/Filter/SortingFilterRequest.php b/src/Matiux/DDDStarterPack/Aggregate/Domain/Repository/Filter/SortingFilterRequest.php
@@ -11,8 +11,8 @@ trait SortingFilterRequest
     public function withSorting(null|string $sortingField, null|string $sortingDirection): self
     {
         if ($sortingField && $sortingDirection) {
-            $this->sortingFilters[SortingFilterParamsApplierKeys::SORT] = $sortingField;
-            $this->sortingFilters[SortingFilterParamsApplierKeys::SORT_DIRECTION] = $sortingDirection;
+            $this->sortingFilters[SortingKeyFilterApplier::SORT] = $sortingField;
+            $this->sortingFilters[SortingKeyFilterApplier::SORT_DIRECTION] = $sortingDirection;
         }
 
         return $this;

diff --git a/...Filter/SortingFilterParamsApplierKeys.php → ...sitory/Filter/SortingKeyFilterApplier.php b/...Filter/SortingFilterParamsApplierKeys.php → ...sitory/Filter/SortingKeyFilterApplier.php
@@ -4,7 +4,7 @@
 
 namespace DDDStarterPack\Aggregate\Domain\Repository\Filter;
 
-interface SortingFilterParamsApplierKeys
+interface SortingKeyFilterApplier
 {
     public const SORT = 'sort_field';
     public const SORT_DIRECTION = 'sort_direction';

diff --git a/...arterPack/Aggregate/Infrastructure/Doctrine/Repository/DoctrineFilterParamsRepository.php b/...arterPack/Aggregate/Infrastructure/Doctrine/Repository/DoctrineFilterParamsRepository.php
@@ -4,7 +4,7 @@
 
 namespace DDDStarterPack\Aggregate\Infrastructure\Doctrine\Repository;
 
-use DDDStarterPack\Aggregate\Domain\Repository\Filter\FilterParams;
+use DDDStarterPack\Aggregate\Domain\Repository\Filter\FilterApplierRegistry;
 use DDDStarterPack\Aggregate\Domain\Repository\Paginator\Paginator;
 use Doctrine\ORM\QueryBuilder;
 use Webmozart\Assert\Assert;
@@ -15,27 +15,27 @@
 abstract class DoctrineFilterParamsRepository extends DoctrineRepository
 {
     /**
-     * @param FilterParams $filterParams
+     * @param FilterApplierRegistry $filterApplierRegistry
      *
      * @return Paginator<T>
      */
-    protected function doByFilterParamsWithPagination(FilterParams $filterParams): Paginator
+    protected function doByFilterParamsWithPagination(FilterApplierRegistry $filterApplierRegistry): Paginator
     {
-        $qb = $this->createQuery($filterParams);
+        $qb = $this->createQuery($filterApplierRegistry);
 
-        [$offset, $limit] = $this->calculatePagination($filterParams, $qb);
+        [$offset, $limit] = $this->calculatePagination($filterApplierRegistry, $qb);
 
         return $this->createPaginator($qb, $offset, $limit);
     }
 
     /**
-     * @param FilterParams $filterParams
+     * @param FilterApplierRegistry $filterApplierRegistry
      *
      * @return T[]
      */
-    protected function doByFilterParams(FilterParams $filterParams): array
+    protected function doByFilterParams(FilterApplierRegistry $filterApplierRegistry): array
     {
-        $qb = $this->createQuery($filterParams);
+        $qb = $this->createQuery($filterApplierRegistry);
 
         $results = $qb->getQuery()->getResult();
 
@@ -44,25 +44,25 @@ protected function doByFilterParams(FilterParams $filterParams): array
         return $results;
     }
 
-    private function createQuery(FilterParams $filterParams): QueryBuilder
+    private function createQuery(FilterApplierRegistry $filterApplierRegistry): QueryBuilder
     {
         $qb = $this->em->createQueryBuilder();
 
         $qb->select($this->getEntityAliasName())
             ->from($this->getEntityClassName(), $this->getEntityAliasName());
 
-        $filterParams->applyToTarget($qb);
+        $filterApplierRegistry->applyToTarget($qb);
 
         return $qb;
     }
 
     /**
-     * @param FilterParams $filterParams
-     * @param QueryBuilder $qb
+     * @param FilterApplierRegistry $filterApplierRegistry
+     * @param QueryBuilder          $qb
      *
      * @return list<int>
      */
-    protected function calculatePagination(FilterParams $filterParams, QueryBuilder $qb): array
+    protected function calculatePagination(FilterApplierRegistry $filterApplierRegistry, QueryBuilder $qb): array
     {
         $result = $qb->getQuery()->getResult();
 
@@ -73,11 +73,11 @@ protected function calculatePagination(FilterParams $filterParams, QueryBuilder
         $offset = 0;
         $limit = 0 != $totalResult ? $totalResult : 1;
 
-        if (-1 != $filterParams->getFilterValueForKey('per_page')) {
-            $offset = $this->calculateOffset($filterParams);
+        if (-1 != $filterApplierRegistry->getFilterValueForKey('per_page')) {
+            $offset = $this->calculateOffset($filterApplierRegistry);
 
             /** @var int $limit */
-            $limit = $filterParams->getFilterValueForKey('per_page');
+            $limit = $filterApplierRegistry->getFilterValueForKey('per_page');
         }
 
         return [intval($offset), intval($limit)];
@@ -92,13 +92,13 @@ protected function calculatePagination(FilterParams $filterParams, QueryBuilder
      */
     abstract protected function createPaginator(QueryBuilder $qb, int $offset, int $limit): Paginator;
 
-    private function calculateOffset(FilterParams $filterParams): int
+    private function calculateOffset(FilterApplierRegistry $filterApplierRegistry): int
     {
         /** @var int $page */
-        $page = $filterParams->getFilterValueForKey('page');
+        $page = $filterApplierRegistry->getFilterValueForKey('page');
 
         /** @var int $perPage */
-        $perPage = $filterParams->getFilterValueForKey('per_page');
+        $perPage = $filterApplierRegistry->getFilterValueForKey('per_page');
 
         return ($page - 1) * $perPage;
     }

diff --git a/...StarterPack/Aggregate/Infrastructure/Doctrine/Repository/Filter/DoctrineFilterApplier.php b/...StarterPack/Aggregate/Infrastructure/Doctrine/Repository/Filter/DoctrineFilterApplier.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DDDStarterPack\Aggregate\Infrastructure\Doctrine\Repository\Filter;
+
+use DDDStarterPack\Aggregate\Domain\Repository\Filter\FilterApplier;
+use DDDStarterPack\Aggregate\Domain\Repository\Filter\FilterApplierRegistry;
+use Doctrine\ORM\QueryBuilder;
+
+/**
+ * @implements FilterApplier<QueryBuilder>
+ */
+abstract class DoctrineFilterApplier implements FilterApplier
+{
+    /**
+     * @param QueryBuilder          $target
+     * @param FilterApplierRegistry $filterApplierRegistry
+     */
+    abstract public function apply($target, FilterApplierRegistry $filterApplierRegistry): void;
+}