feature #991 Switch to Doctrine's Pager (javiereguiluz)

This PR was squashed before being merged into the master branch (closes #991).

Discussion
----------

Switch to Doctrine's Pager

Pagerfanta library could be soon be unmaintained: whiteoctober/Pagerfanta#278

Let's switch to Doctrine Pager.

Commits
-------

65872cd Switch to Doctrine's Pager

Author: javiereguiluz

composer.json

@@ -31,8 +31,7 @@
         "symfony/yaml": "*",
         "tgalopin/html-sanitizer-bundle": "^1.1",
         "twig/extensions": "^1.5",
-        "twig/twig": "^2.6",
-        "white-october/pagerfanta-bundle": "^1.1"
+        "twig/twig": "^2.6"
     },
     "require-dev": {
         "dama/doctrine-test-bundle": "^5.0",

composer.lock

@@ -9,7 +9,6 @@
     Symfony\Bundle\MonologBundle\MonologBundle::class => ['all' => true],
     Symfony\Bundle\SwiftmailerBundle\SwiftmailerBundle::class => ['all' => true],
     Symfony\Bundle\TwigBundle\TwigBundle::class => ['all' => true],
-    WhiteOctober\PagerfantaBundle\WhiteOctoberPagerfantaBundle::class => ['all' => true],
     Symfony\Bundle\DebugBundle\DebugBundle::class => ['dev' => true, 'test' => true],
     Symfony\Bundle\WebServerBundle\WebServerBundle::class => ['dev' => true],
     Symfony\Bundle\WebProfilerBundle\WebProfilerBundle::class => ['dev' => true, 'test' => true],

config/bundles.php

@@ -57,7 +57,9 @@ public function index(Request $request, int $page, string $_format, PostReposito
         // Every template name also has two extensions that specify the format and
         // engine for that template.
         // See https://symfony.com/doc/current/templating.html#template-suffix
-        return $this->render('blog/index.'.$_format.'.twig', ['posts' => $latestPosts]);
+        return $this->render('blog/index.'.$_format.'.twig', [
+            'paginator' => $latestPosts,
+        ]);
     }
 
     /**

src/Controller/BlogController.php

@@ -15,9 +15,8 @@
 use App\Entity\Tag;
 use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
 use Doctrine\Common\Persistence\ManagerRegistry;
-use Doctrine\ORM\Query;
-use Pagerfanta\Adapter\DoctrineORMAdapter;
-use Pagerfanta\Pagerfanta;
+use Doctrine\ORM\QueryBuilder;
+use Doctrine\ORM\Tools\Pagination\Paginator;
 
 /**
  * This custom Doctrine repository contains some methods which are useful when
@@ -36,31 +35,23 @@ public function __construct(ManagerRegistry $registry)
         parent::__construct($registry, Post::class);
     }
 
-    public function findLatest(int $page = 1, Tag $tag = null): Pagerfanta
+    public function findLatest(int $page = 1, Tag $tag = null): array
     {
         $qb = $this->createQueryBuilder('p')
             ->addSelect('a', 't')
             ->innerJoin('p.author', 'a')
             ->leftJoin('p.tags', 't')
             ->where('p.publishedAt <= :now')
             ->orderBy('p.publishedAt', 'DESC')
-            ->setParameter('now', new \DateTime());
+            ->setParameter('now', new \DateTime())
+        ;
 
         if (null !== $tag) {
             $qb->andWhere(':tag MEMBER OF p.tags')
                 ->setParameter('tag', $tag);
         }
 
-        return $this->createPaginator($qb->getQuery(), $page);
-    }
-
-    private function createPaginator(Query $query, int $page): Pagerfanta
-    {
-        $paginator = new Pagerfanta(new DoctrineORMAdapter($query));
-        $paginator->setMaxPerPage(Post::NUM_ITEMS);
-        $paginator->setCurrentPage($page);
-
-        return $paginator;
+        return $this->createPaginator($qb, $page);
     }
 
     /**
@@ -110,4 +101,31 @@ private function extractSearchTerms(string $searchQuery): array
             return 2 <= mb_strlen($term);
         });
     }
+
+    private function createPaginator(QueryBuilder $queryBuilder, int $currentPage, int $pageSize = Post::NUM_ITEMS)
+    {
+        $currentPage = $currentPage < 1 ? 1 : $currentPage;
+        $firstResult = ($currentPage - 1) * $pageSize;
+
+        $query = $queryBuilder
+            ->setFirstResult($firstResult)
+            ->setMaxResults($pageSize)
+            ->getQuery();
+
+        $paginator = new Paginator($query);
+        $numResults = $paginator->count();
+        $hasPreviousPage = $currentPage > 1;
+        $hasNextPage = ($currentPage * $pageSize) < $numResults;
+
+        return [
+            'results' => $paginator->getIterator(),
+            'currentPage' => $currentPage,
+            'hasPreviousPage' => $hasPreviousPage,
+            'hasNextPage' => $hasNextPage,
+            'previousPage' => $hasPreviousPage ? $currentPage - 1 : null,
+            'nextPage' => $hasNextPage ? $currentPage + 1 : null,
+            'numPages' => (int) ceil($numResults / $pageSize),
+            'haveToPaginate' => $numResults > $pageSize,
+        ];
+    }
 }

src/Repository/PostRepository.php

@@ -128,9 +128,6 @@
     "ocramius/proxy-manager": {
         "version": "2.1.x-dev"
     },
-    "pagerfanta/pagerfanta": {
-        "version": "v2.0.1"
-    },
     "paragonie/random_compat": {
         "version": "v9.99.99.x-dev"
     },
@@ -473,9 +470,6 @@
     "twig/twig": {
         "version": "2.x-dev"
     },
-    "white-october/pagerfanta-bundle": {
-        "version": "v1.2.2"
-    },
     "zendframework/zend-code": {
         "version": "3.3-dev"
     }

symfony.lock

@@ -3,7 +3,7 @@
 {% block body_id 'blog_index' %}
 
 {% block main %}
-    {% for post in posts %}
+    {% for post in paginator.results %}
         <article class="post">
             <h2>
                 <a href="{{ path('blog_post', {slug: post.slug}) }}">
@@ -24,9 +24,29 @@
         <div class="well">{{ 'post.no_posts_found'|trans }}</div>
     {% endfor %}
 
-    {% if posts.haveToPaginate %}
+    {% if paginator.haveToPaginate %}
         <div class="navigation text-center">
-            {{ pagerfanta(posts, 'twitter_bootstrap3_translated', {routeName: 'blog_index_paginated', routeParams: app.request.query.all}) }}
+            <ul class="pagination">
+                {% if paginator.hasPreviousPage %}
+                    <li class="prev"><a href="{{ path('blog_index_paginated', {page: paginator.previousPage}) }}" rel="previous"><i class="fa fw fa-long-arrow-left"></i> Previous</a></li>
+                {% else %}
+                    <li class="prev disabled"><span><i class="fa fw fa-arrow-left"></i> Previous</span></li>
+                {% endif %}
+
+                {% for i in 1..paginator.numPages %}
+                    {% if i == paginator.currentPage %}
+                        <li class="active"><span>{{ i }} <span class="sr-only">(current)</span></span></li>
+                    {% else %}
+                        <li><a href="{{ path('blog_index_paginated', {page: i}) }}">{{ i }}</a></li>
+                    {% endif %}
+                {% endfor %}
+
+                {% if paginator.hasNextPage %}
+                    <li class="prev"><a href="{{ path('blog_index_paginated', {page: paginator.nextPage}) }}" rel="next">Next <i class="fa fw fa-arrow-right"></i></a></li>
+                {% else %}
+                    <li class="next disabled"><span>Next <i class="fa fw fa-arrow-right"></i></span></li>
+                {% endif %}
+            </ul>
         </div>
     {% endif %}
 {% endblock %}