add contract for repositories with filters.

Warxcell · May 21, 2021 · 45741da · 45741da
1 parent a10688d
commit 45741da
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 14 deletions.
diff --git a/src/Filters.php b/src/Filters.php
@@ -66,32 +66,22 @@ public function appendFilter(QueryBuilder $queryBuilder, string $alias, string $
         return $queryBuilder->filters[$filterName] = true;
     }
 
-    /**
-     * @throws \Doctrine\ORM\NonUniqueResultException
-     */
-    public function findOneByFilters(iterable $filterBy)
+    public function findOneByFilters(iterable $filterBy): ?object
     {
         return $this->createQueryBuilderByFilters('entity', $filterBy)->getQuery()->getOneOrNullResult();
     }
 
-    public function findByFilters(iterable $filterBy)
+    public function findByFilters(iterable $filterBy): array
     {
         return $this->createQueryBuilderByFilters('entity', $filterBy)->getQuery()->getResult();
     }
 
-    /**
-     * @throws \Doctrine\ORM\NoResultException
-     * @throws \Doctrine\ORM\NonUniqueResultException
-     */
-    public function getSingleResultByFilters(iterable $filterBy)
+    public function getSingleResultByFilters(iterable $filterBy): object
     {
         return $this->createQueryBuilderByFilters('entity', $filterBy)->getQuery()->getSingleResult();
     }
 
-    /**
-     * @throws \Doctrine\ORM\NoResultException
-     * @throws \Doctrine\ORM\NonUniqueResultException
-     */
+
     public function countByFilters(iterable $filterBy): int
     {
         return (int)$this

diff --git a/src/HasFilters.php b/src/HasFilters.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Arxy\DoctrineORMFilters;
+
+use Doctrine\ORM\QueryBuilder;
+
+interface HasFilters
+{
+    public function createQueryBuilderByFilters(
+        string $alias,
+        iterable $filterBy,
+        string $indexBy = null
+    ): QueryBuilder;
+
+    public function appendFilter(QueryBuilder $queryBuilder, string $alias, string $filterName, ...$values): bool;
+
+    /**
+     * @throws \Doctrine\ORM\NonUniqueResultException
+     */
+    public function findOneByFilters(iterable $filterBy): ?object;
+
+    public function findByFilters(iterable $filterBy): array;
+
+    /**
+     * @throws \Doctrine\ORM\NoResultException
+     * @throws \Doctrine\ORM\NonUniqueResultException
+     */
+    public function getSingleResultByFilters(iterable $filterBy): object;
+
+    public function countByFilters(iterable $filterBy): int;
+}
diff --git a/tests/TestRepository.php b/tests/TestRepository.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Arxy\DoctrineORMFilters\Tests;
+
+use Arxy\DoctrineORMFilters\Filters;
+use Arxy\DoctrineORMFilters\HasFilters;
+
+class TestRepository implements HasFilters
+{
+    use Filters;
+
+    public function createQueryBuilder($alias, $indexBy = null)
+    {
+
+    }
+
+    public function getFilters(): array
+    {
+        return [];
+    }
+}