src/Pagination/Paginator.php line 60

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace App\Pagination;
  14. use Doctrine\ORM\QueryBuilder as DoctrineQueryBuilder;
  15. use Doctrine\ORM\Tools\Pagination\CountWalker;
  16. use Doctrine\ORM\Tools\Pagination\Paginator as DoctrinePaginator;
  18. /**
  19.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  20.  */
  21. class Paginator
  22. {
  23.     /**
  24.      * Use constants to define configuration options that rarely change instead
  25.      * of specifying them under parameters section in config/services.yaml file.
  26.      *
  27.      * See https://symfony.com/doc/current/best_practices.html#use-constants-to-define-options-that-rarely-change
  28.      */
  29.     public const PAGE_SIZE = 10;
  31.     private int $currentPage;
  32.     private \Traversable $results;
  33.     private int $numResults;
  35.     public function __construct(
  36.         private DoctrineQueryBuilder $queryBuilder,
  37.         private int $pageSize = self::PAGE_SIZE
  38.     ) {
  39.     }
  41.     public function paginate(int $page = 1): self
  42.     {
  43.         $this->currentPage = max(1, $page);
  44.         $firstResult = ($this->currentPage - 1) * $this->pageSize;
  46.         $query = $this->queryBuilder
  47.             ->setFirstResult($firstResult)
  48.             ->setMaxResults($this->pageSize)
  49.             ->getQuery();
  51.         if (0 === \count($this->queryBuilder->getDQLPart('join'))) {
  52.             $query->setHint(CountWalker::HINT_DISTINCT, false);
  53.         }
  55.         $paginator = new DoctrinePaginator($query, true);
  57.         $useOutputWalkers = \count($this->queryBuilder->getDQLPart('having') ?: []) > 0;
  58.         $paginator->setUseOutputWalkers($useOutputWalkers);
  60.         $this->results = $paginator->getIterator();
  61.         $this->numResults = $paginator->count();
  63.         return $this;
  64.     }
  66.     public function getCurrentPage(): int
  67.     {
  68.         return $this->currentPage;
  69.     }
  71.     public function getLastPage(): int
  72.     {
  73.         return (int) ceil($this->numResults / $this->pageSize);
  74.     }
  76.     public function getPageSize(): int
  77.     {
  78.         return $this->pageSize;
  79.     }
  81.     public function hasPreviousPage(): bool
  82.     {
  83.         return $this->currentPage > 1;
  84.     }
  86.     public function getPreviousPage(): int
  87.     {
  88.         return max(1, $this->currentPage - 1);
  89.     }
  91.     public function hasNextPage(): bool
  92.     {
  93.         return $this->currentPage < $this->getLastPage();
  94.     }
  96.     public function getNextPage(): int
  97.     {
  98.         return min($this->getLastPage(), $this->currentPage + 1);
  99.     }
  101.     public function hasToPaginate(): bool
  102.     {
  103.         return $this->numResults > $this->pageSize;
  104.     }
  106.     public function getNumResults(): int
  107.     {
  108.         return $this->numResults;
  109.     }
  111.     public function getResults(): \Traversable
  112.     {
  113.         return $this->results;
  114.     }
  115. }