[WIP] Pagination Example

.gitignore

@@ -6,3 +6,4 @@ vendor
 .php-cs-fixer.cache
 node_modules
 package-lock.json
+.phpunit.result.cache

composer.json

@@ -25,6 +25,7 @@
         "gedmo/doctrine-extensions": "^3.0",
         "hubspot/hubspot-php": "^5.0",
         "knplabs/doctrine-behaviors": "^2.0.6",
+        "knplabs/knp-paginator-bundle": "^5.8",
         "runroom-packages/form-handler-bundle": "^0.16",
         "runroom-packages/render-event-bundle": "^0.16",
         "runroom-packages/sortable-behavior-bundle": "^0.16",

src/BasicEntities/Controller/BookController.php

@@ -26,10 +26,10 @@ public function __construct(BookService $service)
         $this->service = $service;
     }
 
-    public function books(): Response
+    public function books(int $page): Response
     {
         return $this->render('@RunroomSamples/BasicEntities/books.html.twig', [
-            'model' => $this->service->getBooksViewModel(),
+            'model' => $this->service->getBooksViewModel($page),
         ]);
     }
 

src/BasicEntities/Repository/BookRepository.php

@@ -16,6 +16,8 @@
 use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
 use Doctrine\ORM\Query\Expr\Join;
 use Doctrine\Persistence\ManagerRegistry;
+use Knp\Bundle\PaginatorBundle\Pagination\SlidingPaginationInterface;
+use Knp\Component\Pager\PaginatorInterface;
 use Runroom\SamplesBundle\BasicEntities\Entity\Book;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RequestStack;
@@ -30,12 +32,17 @@
 class BookRepository extends ServiceEntityRepository
 {
     private RequestStack $requestStack;
+    private PaginatorInterface $paginator;
 
-    public function __construct(ManagerRegistry $registry, RequestStack $requestStack)
-    {
+    public function __construct(
+        ManagerRegistry $registry,
+        RequestStack $requestStack,
+        PaginatorInterface $paginator
+    ) {
         parent::__construct($registry, Book::class);
 
         $this->requestStack = $requestStack;
+        $this->paginator = $paginator;
     }
 
     public function findBySlug(string $slug): Book
@@ -55,4 +62,24 @@ public function findBySlug(string $slug): Book
 
         return $book;
     }
+
+    /**
+     * @phpstan-return SlidingPaginationInterface<Book>
+     *
+     * @psalm-return SlidingPaginationInterface
+     */
+    public function getPaginatedBooks(int $page, int $limitPerPage): SlidingPaginationInterface
+    {
+        $request = $this->requestStack->getCurrentRequest() ?? new Request();
+
+        $queryBuilder = $this->createQueryBuilder('books')
+            ->where('books.publish = true')
+            ->leftJoin('books.translations', 'translations', Join::WITH, 'translations.locale = :locale')
+            ->setParameter('locale', $request->getLocale());
+
+        $pagination = $this->paginator->paginate($queryBuilder, $page, $limitPerPage);
+        \assert($pagination instanceof SlidingPaginationInterface);
+
+        return $pagination;
+    }
 }

src/BasicEntities/Service/BookService.php

@@ -19,16 +19,20 @@
 
 class BookService
 {
+    public const LIMIT_PER_PAGE = 6;
+
     private BookRepository $repository;
 
     public function __construct(BookRepository $repository)
     {
         $this->repository = $repository;
     }
 
-    public function getBooksViewModel(): BooksViewModel
+    public function getBooksViewModel(int $page): BooksViewModel
     {
-        return new BooksViewModel($this->repository->findBy(['publish' => true], ['position' => 'ASC']));
+        $pagination = $this->repository->getPaginatedBooks($page, self::LIMIT_PER_PAGE);
+
+        return new BooksViewModel($pagination);
     }
 
     public function getBookViewModel(string $slug): BookViewModel

src/BasicEntities/ViewModel/BooksViewModel.php

@@ -13,28 +13,35 @@
 
 namespace Runroom\SamplesBundle\BasicEntities\ViewModel;
 
+use Knp\Bundle\PaginatorBundle\Pagination\SlidingPaginationInterface;
 use Runroom\SamplesBundle\BasicEntities\Entity\Book;
 
 class BooksViewModel
 {
     /**
-     * @var Book[]
+     * @phpstan-var SlidingPaginationInterface<Book>
+     *
+     * @psalm-var SlidingPaginationInterface
      */
-    private array $books;
+    protected $pagination;
 
     /**
-     * @param Book[] $books
+     * @phpstan-param SlidingPaginationInterface<Book> $pagination
+     *
+     * @psalm-param SlidingPaginationInterface $pagination
      */
-    public function __construct(array $books)
+    public function __construct(SlidingPaginationInterface $pagination)
     {
-        $this->books = $books;
+        $this->pagination = $pagination;
     }
 
     /**
-     * @return Book[]
+     * @phpstan-return SlidingPaginationInterface<Book>
+     *
+     * @psalm-return SlidingPaginationInterface
      */
-    public function getBooks(): array
+    public function getPagination(): SlidingPaginationInterface
     {
-        return $this->books;
+        return $this->pagination;
     }
 }

src/Resources/config/routing.yaml

@@ -6,8 +6,12 @@ runroom_samples.home:
 
 # BasicEntities
 runroom_samples.basic_entities.books:
-    path: /books
+    path: /books/{page}
     controller: Runroom\SamplesBundle\BasicEntities\Controller\BookController::books
+    defaults:
+        page: 1
+    requirements:
+        page: '\d+'
 
 runroom_samples.basic_entities.book:
     path: /book/{slug}

src/Resources/views/BasicEntities/books.html.twig

@@ -1,10 +1,33 @@
 {% extends '@RunroomSamples/base.html.twig' %}
 
+{% block contentClass %}books-list{% endblock %}
+
 {% block content %}
-    {% for book in model.books %}
-        <a href="{{ path('runroom_samples.basic_entities.book', {slug: book.slug}) }}">
-            <p>{{ book.title }}</p>
-            <div>{{ book.description|raw }}</div>
-        </a>
-    {% endfor %}
+<div class="wrapper">
+    <ul class="flex flex-wrap my-10">
+        {% for book in model.pagination.items %}
+            <li class="w-1/3 rounded shadow-lg p-5 book-item no-underline">
+                <div class="h-40 {% if book.picture %} bg-gradient-to-r from-orange-400 via-red-500 to-pink-500{% endif %}"
+                >
+                </div>
+                <div class="py-5">
+                    <div class="font-bold text-xl">{{ book.title }}</div>
+                    <p class="text-gray-700 text-base wysiwyg">
+                        {{ book.description|raw }}
+                    </p>
+                </div>
+            </li>
+            {# <div class="book-item">
+                <li>
+                    <a href="{{ path('runroom_samples.basic_entities.book', {slug: book.slug}) }}">{{book.title}}</a>
+                </li>
+            </div> #}
+        {% endfor %}
+    </ul>
+
+    <div class="flex justify-center my-10">
+        {% include '@RunroomSamples/pagination.html.twig' with { pagination: model.pagination } %}
+    </div>
+
+</div>
 {% endblock %}

src/Resources/views/pagination.html.twig

@@ -0,0 +1,41 @@
+{% set paginationData = pagination.paginationData %}
+{% set route = app.request.attributes.get('_route') %}
+{% set routeParams = app.request.attributes.get('_route_params')|merge(app.request.query.all) %}
+
+{% if paginationData.pageCount > 1 %}
+    <div class="flex items-baseline flex-row">
+        {% if paginationData.first is defined and paginationData.current != paginationData.first %}
+            <span class="px-3 py-2 text-lg font-bold">
+                <a href="{{ path(route, routeParams|merge({'page': paginationData.first})) }}">&lt;&lt;</a>
+            </span>
+        {% endif %}
+
+        {% if paginationData.previous is defined %}
+            <span class="px-3 text-lg py-2">
+                <a rel="prev" href="{{ path(route, routeParams|merge({'page': paginationData.previous})) }}">&lt;</a>
+            </span>
+        {% endif %}
+
+        {% for page in paginationData.pagesInRange %}
+            {% if page != paginationData.current %}
+                <span class="px-3 py-2 text-lg">
+                    <a href="{{ path(route, routeParams|merge({'page': page})) }}">{{ page }}</a>
+                </span>
+            {% else %}
+                <span class="px-3 py-2 text-lg font-bold">{{ page }}</span>
+            {% endif %}
+        {% endfor %}
+
+        {% if paginationData.next is defined %}
+            <span class="px-3 py-2 text-lg">
+                <a rel="next" href="{{ path(route, routeParams|merge({'page': paginationData.next})) }}">&gt;</a>
+            </span>
+        {% endif %}
+
+        {% if paginationData.last is defined and paginationData.current != paginationData.last %}
+            <span class="px-3 py-2 text-lg border-gray-400 font-bold">
+                <a href="{{ path(route, routeParams|merge({'page': paginationData.last})) }}">&gt;&gt;</a>
+            </span>
+        {% endif %}
+    </div>
+{% endif %}

tests/App/Kernel.php

@@ -18,6 +18,7 @@
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use FOS\CKEditorBundle\FOSCKEditorBundle;
 use Knp\Bundle\MenuBundle\KnpMenuBundle;
+use Knp\Bundle\PaginatorBundle\KnpPaginatorBundle;
 use Knp\DoctrineBehaviors\DoctrineBehaviorsBundle;
 use Runroom\FormHandlerBundle\RunroomFormHandlerBundle;
 use Runroom\RenderEventBundle\RunroomRenderEventBundle;
@@ -54,6 +55,7 @@ public function registerBundles(): iterable
             new FOSCKEditorBundle(),
             new FrameworkBundle(),
             new KnpMenuBundle(),
+            new KnpPaginatorBundle(),
             new SecurityBundle(),
             new TwigBundle(),
             new SonataMediaBundle(),

tests/BasicEntities/Unit/BookControllerTest.php

@@ -13,6 +13,7 @@
 
 namespace Runroom\SamplesBundle\Tests\BasicEntities\Unit;
 
+use Knp\Bundle\PaginatorBundle\Pagination\SlidingPaginationInterface;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Runroom\SamplesBundle\BasicEntities\Controller\BookController;
@@ -54,11 +55,12 @@ protected function setUp(): void
      */
     public function itRenderBooks(): void
     {
-        $model = new BooksViewModel([]);
+        $model = new BooksViewModel($this->createStub(SlidingPaginationInterface::class));
+        $page = 1;
 
-        $this->service->method('getBooksViewModel')->willReturn($model);
+        $this->service->method('getBooksViewModel')->with($page)->willReturn($model);
 
-        $response = $this->controller->books();
+        $response = $this->controller->books($page);
 
         static::assertSame(200, $response->getStatusCode());
     }

tests/BasicEntities/Unit/BookServiceTest.php

@@ -13,6 +13,7 @@
 
 namespace Runroom\SamplesBundle\Tests\BasicEntities\Unit;
 
+use Knp\Bundle\PaginatorBundle\Pagination\SlidingPaginationInterface;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Runroom\SamplesBundle\BasicEntities\Factory\BookFactory;
@@ -34,7 +35,6 @@ class BookServiceTest extends TestCase
     protected function setUp(): void
     {
         $this->repository = $this->createMock(BookRepository::class);
-
         $this->service = new BookService($this->repository);
     }
 
@@ -43,13 +43,14 @@ protected function setUp(): void
      */
     public function itBuildsBooksViewModel(): void
     {
-        $expectedBooks = [BookFactory::createOne()->object()];
+        $pagination = $this->createStub(SlidingPaginationInterface::class);
+        $page = 1;
 
-        $this->repository->method('findBy')->with(['publish' => true], ['position' => 'ASC'])->willReturn($expectedBooks);
+        $this->repository->method('getPaginatedBooks')->willReturn($pagination);
 
-        $model = $this->service->getBooksViewModel();
+        $model = $this->service->getBooksViewModel($page);
 
-        static::assertSame($model->getBooks(), $expectedBooks);
+        static::assertSame($model->getPagination(), $pagination);
     }
 
     /**