vendor/easycorp/easyadmin-bundle/src/Orm/EntityPaginator.php line 67

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Orm;
  5. use Doctrine\ORM\QueryBuilder;
  6. use Doctrine\ORM\Tools\Pagination\CountWalker;
  7. use Doctrine\ORM\Tools\Pagination\Paginator;
  8. use EasyCorp\Bundle\EasyAdminBundle\Config\Option\EA;
  9. use EasyCorp\Bundle\EasyAdminBundle\Contracts\Orm\EntityPaginatorInterface;
  10. use EasyCorp\Bundle\EasyAdminBundle\Dto\PaginatorDto;
  11. use EasyCorp\Bundle\EasyAdminBundle\Factory\EntityFactory;
  12. use EasyCorp\Bundle\EasyAdminBundle\Router\AdminUrlGenerator;
  14. /**
  15.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  16.  */
  17. final class EntityPaginator implements EntityPaginatorInterface
  18. {
  19.     private AdminUrlGenerator $adminUrlGenerator;
  20.     private EntityFactory $entityFactory;
  21.     private ?int $currentPage = null;
  22.     private ?int $pageSize = null;
  23.     private ?int $rangeSize = null;
  24.     private ?int $rangeEdgeSize = null;
  25.     private $results;
  26.     private $numResults;
  27.     private ?int $rangeFirstResultNumber = null;
  28.     private ?int $rangeLastResultNumber = null;
  30.     public function __construct(AdminUrlGenerator $adminUrlGenerator, EntityFactory $entityFactory)
  31.     {
  32.         $this->adminUrlGenerator = $adminUrlGenerator;
  33.         $this->entityFactory = $entityFactory;
  34.     }
  36.     public function paginate(PaginatorDto $paginatorDto, QueryBuilder $queryBuilder): EntityPaginatorInterface
  37.     {
  38.         $this->pageSize = $paginatorDto->getPageSize();
  39.         $this->rangeSize = $paginatorDto->getRangeSize();
  40.         $this->rangeEdgeSize = $paginatorDto->getRangeEdgeSize();
  41.         $this->currentPage = max(1, $paginatorDto->getPageNumber());
  42.         $firstResult = ($this->currentPage - 1) * $this->pageSize;
  43.         $this->rangeFirstResultNumber = $this->pageSize * ($this->currentPage - 1) + 1;
  44.         $this->rangeLastResultNumber = $this->rangeFirstResultNumber + $this->pageSize - 1;
  46.         $query = $queryBuilder
  47.             ->setFirstResult($firstResult)
  48.             ->setMaxResults($this->pageSize)
  49.             ->getQuery();
  51.         if (0 === \count($queryBuilder->getDQLPart('join'))) {
  52.             $query->setHint(CountWalker::HINT_DISTINCT, false);
  53.         }
  55.         $paginator = new Paginator($query, $paginatorDto->fetchJoinCollection());
  57.         if (null === $useOutputWalkers = $paginatorDto->useOutputWalkers()) {
  58.             $havingPart = $queryBuilder->getDQLPart('having');
  59.             if (\is_array($havingPart)) {
  60.                 $useOutputWalkers = \count($havingPart) > 0;
  61.             } else {
  62.                 $useOutputWalkers = null !== $havingPart;
  63.             }
  64.         }
  65.         $paginator->setUseOutputWalkers($useOutputWalkers);
  67.         $this->results = $paginator->getIterator();
  68.         $this->numResults = $paginator->count();
  69.         if ($this->rangeLastResultNumber > $this->numResults) {
  70.             $this->rangeLastResultNumber = $this->numResults;
  71.         }
  73.         return $this;
  74.     }
  76.     public function generateUrlForPage(int $page): string
  77.     {
  78.         return $this->adminUrlGenerator->set(EA::PAGE, $page)->includeReferrer()->generateUrl();
  79.     }
  81.     public function getCurrentPage(): int
  82.     {
  83.         return $this->currentPage;
  84.     }
  86.     public function getLastPage(): int
  87.     {
  88.         return (int) ceil($this->numResults / $this->pageSize);
  89.     }
  91.     /**
  92.      * It returns the closest available pages around the current page.
  93.      * E.g. a paginator with 35 pages, if current page = 1, returns [1, 2, 3, 4, null, 35]
  94.      *      if current page = 18, returns [1, null, 15, 16, 17, 18, 19, 20, 21, null, 35]
  95.      * NULL values mean a gap in the pagination (they can be represented as ellipsis in the templates).
  96.      *
  97.      * This code was inspired by https://github.com/django/django/blob/55fabc53373a8c7ef31d8c4cffd2a07be0a88c2e/django/core/paginator.py#L134
  98.      * (c) Django Project
  99.      *
  100.      * @return iterable<int|null>
  101.      */
  102.     public function getPageRange(?int $pagesOnEachSide = null, ?int $pagesOnEdges = null): iterable
  103.     {
  104.         $pagesOnEachSide = $pagesOnEachSide ?? $this->rangeSize;
  105.         $pagesOnEdges = $pagesOnEdges ?? $this->rangeEdgeSize;
  107.         if (0 === $pagesOnEachSide) {
  108.             return null;
  109.         }
  111.         if ($this->getLastPage() <= ($pagesOnEachSide + $pagesOnEdges) * 2) {
  112.             return yield from range(1, $this->getLastPage());
  113.         }
  115.         if ($this->getCurrentPage() > ($pagesOnEachSide + $pagesOnEdges + 1)) {
  116.             yield from range(1, $pagesOnEdges);
  117.             yield null;
  118.             yield from range($this->getCurrentPage() - $pagesOnEachSide, $this->getCurrentPage());
  119.         } else {
  120.             yield from range(1, $this->getCurrentPage());
  121.         }
  123.         if ($this->getCurrentPage() < ($this->getLastPage() - $pagesOnEachSide - $pagesOnEdges - 1)) {
  124.             yield from range($this->getCurrentPage() + 1, $this->getCurrentPage() + $pagesOnEachSide);
  125.             yield null;
  126.             yield from range($this->getLastPage() - $pagesOnEdges + 1, $this->getLastPage());
  127.         } elseif ($this->getCurrentPage() + 1 <= $this->getLastPage()) {
  128.             yield from range($this->getCurrentPage() + 1, $this->getLastPage());
  129.         }
  130.     }
  132.     public function getPageSize(): int
  133.     {
  134.         return $this->pageSize;
  135.     }
  137.     public function hasPreviousPage(): bool
  138.     {
  139.         return $this->currentPage > 1;
  140.     }
  142.     public function getPreviousPage(): int
  143.     {
  144.         return max(1, $this->currentPage - 1);
  145.     }
  147.     public function hasNextPage(): bool
  148.     {
  149.         return $this->currentPage < $this->getLastPage();
  150.     }
  152.     public function getNextPage(): int
  153.     {
  154.         return min($this->getLastPage(), $this->currentPage + 1);
  155.     }
  157.     public function hasToPaginate(): bool
  158.     {
  159.         return $this->numResults > $this->pageSize;
  160.     }
  162.     public function isOutOfRange(): bool
  163.     {
  164.         if (1 === $this->currentPage) {
  165.             return false;
  166.         }
  168.         return $this->currentPage < 1 || $this->currentPage > $this->getLastPage();
  169.     }
  171.     public function getNumResults(): int
  172.     {
  173.         return $this->numResults;
  174.     }
  176.     public function getResults(): ?iterable
  177.     {
  178.         return $this->results;
  179.     }
  181.     /*
  182.      * Returns the result number (e.g. 21) of the first value
  183.      * included in the current results range. It's useful to
  184.      * display a message like: "Showing 21 to 40 of 135 entries"
  185.      */
  186.     public function getRangeFirstResultNumber(): int
  187.     {
  188.         return $this->rangeFirstResultNumber;
  189.     }
  191.     /*
  192.      * Returns the result number (e.g. 40) of the last value
  193.      * included in the current results range. It's useful to
  194.      * display a message like: "Showing 21 to 40 of 135 entries"
  195.      */
  196.     public function getRangeLastResultNumber(): int
  197.     {
  198.         return $this->rangeLastResultNumber;
  199.     }
  201.     public function getResultsAsJson(): string
  202.     {
  203.         $jsonResult = [];
  204.         foreach ($this->getResults() ?? [] as $entityInstance) {
  205.             $entityDto = $this->entityFactory->createForEntityInstance($entityInstance);
  207.             $jsonResult['results'][] = [
  208.                 EA::ENTITY_ID => $entityDto->getPrimaryKeyValueAsString(),
  209.                 'entityAsString' => $entityDto->toString(),
  210.             ];
  211.         }
  213.         $nextPageUrl = !$this->hasNextPage() ? null : $this->adminUrlGenerator->set(EA::PAGE, $this->getNextPage())->removeReferrer()->generateUrl();
  214.         $jsonResult['next_page'] = $nextPageUrl;
  216.         return json_encode($jsonResult, \JSON_THROW_ON_ERROR);
  217.     }
  218. }