create new adapter for doctrine result cache

Author: fd6130

src/Pagination/Adapter/DoctrineAdapter.php

@@ -0,0 +1,62 @@
+<?php declare(strict_types=1);
+
+namespace Fd\HslBundle\Pagination\Adapter;
+
+use Doctrine\ORM\Query;
+use Doctrine\ORM\QueryBuilder;
+use Doctrine\ORM\Tools\Pagination\Paginator;
+use Pagerfanta\Adapter\AdapterInterface;
+
+/**
+ * Adapter which calculates pagination from a Doctrine ORM Query or QueryBuilder.
+ */
+class DoctrineAdapter implements AdapterInterface
+{
+    private Paginator $paginator;
+    private ?int $lifetime;
+    private ?string $resultCacheId;
+
+    /**
+     * @param Query|QueryBuilder $query
+     * @param bool               $fetchJoinCollection Whether the query joins a collection (true by default)
+     * @param bool|null          $useOutputWalkers    Flag indicating whether output walkers are used in the paginator
+     */
+    public function __construct($query, bool $fetchJoinCollection = true, ?bool $useOutputWalkers = null, ?int $lifetime = null, ?string $resultCacheId = null)
+    {
+        $this->paginator = new Paginator($query, $fetchJoinCollection);
+        $this->paginator->setUseOutputWalkers($useOutputWalkers);
+        $this->lifetime = $lifetime;
+        $this->resultCacheId = $resultCacheId;
+    }
+
+    public function getQuery(): Query
+    {
+        return $this->paginator->getQuery();
+    }
+
+    public function getFetchJoinCollection(): bool
+    {
+        return $this->paginator->getFetchJoinCollection();
+    }
+
+    public function getNbResults(): int
+    {
+        return \count($this->paginator);
+    }
+
+    public function getSlice(int $offset, int $length): iterable
+    {
+        $paginator = $this->paginator->getQuery()
+            ->setFirstResult($offset)
+            ->setMaxResults($length);
+                
+        if($this->lifetime == null && $this->resultCacheId == null)
+        {
+            return $this->paginator->getIterator();
+        }
+        
+        $paginator->enableResultCache($this->lifetime, $this->resultCacheId);
+
+        return $this->paginator->getIterator();
+    }
+}

src/Pagination/Paginator.php

@@ -2,7 +2,9 @@
 
 namespace Fd\HslBundle\Pagination;
 
+use Doctrine\ORM\Query;
 use Doctrine\ORM\QueryBuilder;
+use Fd\HslBundle\Pagination\Adapter\DoctrineAdapter;
 use League\Fractal\Manager;
 use League\Fractal\Pagination\PagerfantaPaginatorAdapter;
 use League\Fractal\Resource\Collection;
@@ -30,15 +32,15 @@ public function __construct(RouterInterface $router, RequestStack $requestStack,
     /**
      * {@inheritdoc}
      */
-    public function paginate($result, $transformer): ResourceAbstract
+    public function paginate($result, $transformer, ?int $lifetime = null, ?string $resultCacheId = null): ResourceAbstract
     {
         $request = $this->requestStack->getCurrentRequest();
         $page = $request->query->getInt('page', 1);
         $limitPerPage = $request->query->getInt('limit', $this->limit);
 
-        if($result instanceof QueryBuilder)
+        if($result instanceof QueryBuilder || $result instanceof Query)
         {
-            $adapter = new QueryAdapter($result);
+            $adapter = new DoctrineAdapter($result, true, null, $lifetime, $resultCacheId);
         }
         else
         {

src/Pagination/PaginatorInterface.php

@@ -2,6 +2,9 @@
 
 namespace Fd\HslBundle\Pagination;
 
+use Doctrine\Common\Collections\Collection;
+use Doctrine\ORM\Query;
+use Doctrine\ORM\QueryBuilder;
 use League\Fractal\Resource\ResourceAbstract;
 
 interface PaginatorInterface
@@ -11,12 +14,14 @@ interface PaginatorInterface
     /**
      * Paginate the result and transform the value using transformer.
      * 
-     * @param QueryBuilder|array|Collection $result result to be paginate
-     * @param string $transformer transformer service id
+     * @param Query|QueryBuilder|array|Collection $result Result to be paginate
+     * @param string $transformer Service id or FQCN
+     * @param int|null $lifetime For doctrine cache only - cache lifetime
+     * @param string|null $resultCacheId For doctrine cache only - unique cache id
      * 
      * @return ResourceAbstract
      */
-    public function paginate($result, $transformer): ResourceAbstract;
+    public function paginate($result, $transformer, ?int $lifetime = null, ?string $resultCacheId = null): ResourceAbstract;
 
     public function setLimitPerPage(int $max);
 }