vendor/knplabs/knp-components/src/Knp/Component/Pager/Paginator.php line 56

Open in your IDE?
  1. <?php
  3. namespace Knp\Component\Pager;
  5. use Knp\Component\Pager\Exception\PageLimitInvalidException;
  6. use Knp\Component\Pager\Exception\PageNumberInvalidException;
  7. use Knp\Component\Pager\Exception\PageNumberOutOfRangeException;
  8. use Knp\Component\Pager\Pagination\PaginationInterface;
  9. use Symfony\Component\HttpFoundation\Request;
  10. use Symfony\Component\HttpFoundation\RequestStack;
  11. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  13. /**
  14. * Paginator uses event dispatcher to trigger pagination
  15. * lifecycle events. Subscribers are expected to paginate
  16. * wanted target and finally it generates pagination view
  17. * which is only the result of paginator
  18. */
  19. final class Paginator implements PaginatorInterface
  20. {
  21. private EventDispatcherInterface $eventDispatcher;
  23. /**
  24. * Default options of paginator
  25. *
  26. * @var array<string, scalar>
  27. */
  28. private array $defaultOptions = [
  29. self::PAGE_PARAMETER_NAME => 'page',
  30. self::SORT_FIELD_PARAMETER_NAME => 'sort',
  31. self::SORT_DIRECTION_PARAMETER_NAME => 'direction',
  32. self::FILTER_FIELD_PARAMETER_NAME => 'filterParam',
  33. self::FILTER_VALUE_PARAMETER_NAME => 'filterValue',
  34. self::DISTINCT => true,
  35. self::PAGE_OUT_OF_RANGE => self::PAGE_OUT_OF_RANGE_IGNORE,
  36. self::DEFAULT_LIMIT => self::DEFAULT_LIMIT_VALUE,
  37. ];
  39. private ?RequestStack $requestStack;
  41. public function __construct(EventDispatcherInterface $eventDispatcher, RequestStack $requestStack = null)
  42. {
  43. $this->eventDispatcher = $eventDispatcher;
  44. $this->requestStack = $requestStack;
  45. }
  47. /**
  48. * Override the default paginator options
  49. * to be reused for paginations
  50. */
  51. public function setDefaultPaginatorOptions(array $options): void
  52. {
  53. $this->defaultOptions = \array_merge($this->defaultOptions, $options);
  54. }
  56. public function paginate($target, int $page = 1, int $limit = null, array $options = []): PaginationInterface
  57. {
  58. if ($page <= 0) {
  59. throw PageNumberInvalidException::create($page);
  60. }
  62. $limit = $limit ?? $this->defaultOptions[self::DEFAULT_LIMIT];
  63. if ($limit <= 0) {
  64. throw PageLimitInvalidException::create($limit);
  65. }
  67. $offset = ($page - 1) * $limit;
  68. $options = \array_merge($this->defaultOptions, $options);
  70. // normalize default sort field
  71. if (isset($options[PaginatorInterface::DEFAULT_SORT_FIELD_NAME]) && is_array($options[PaginatorInterface::DEFAULT_SORT_FIELD_NAME])) {
  72. $options[PaginatorInterface::DEFAULT_SORT_FIELD_NAME] = implode('+', $options[PaginatorInterface::DEFAULT_SORT_FIELD_NAME]);
  73. }
  75. $request = null === $this->requestStack ? Request::createFromGlobals() : $this->requestStack->getCurrentRequest();
  77. // default sort field and direction are set based on options (if available)
  78. if (isset($options[self::DEFAULT_SORT_FIELD_NAME]) && !$request->query->has($options[self::SORT_FIELD_PARAMETER_NAME])) {
  79. $request->query->set($options[self::SORT_FIELD_PARAMETER_NAME], $options[self::DEFAULT_SORT_FIELD_NAME]);
  81. if (!$request->query->has($options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME])) {
  82. $request->query->set($options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME], $options[PaginatorInterface::DEFAULT_SORT_DIRECTION] ?? 'asc');
  83. }
  84. }
  86. // before pagination start
  87. $beforeEvent = new Event\BeforeEvent($this->eventDispatcher, $request);
  88. $this->eventDispatcher->dispatch($beforeEvent, 'knp_pager.before');
  89. // items
  90. $itemsEvent = new Event\ItemsEvent($offset, $limit);
  91. $itemsEvent->options = &$options;
  92. $itemsEvent->target = &$target;
  93. $this->eventDispatcher->dispatch($itemsEvent, 'knp_pager.items');
  94. if (!$itemsEvent->isPropagationStopped()) {
  95. throw new \RuntimeException('One of listeners must count and slice given target');
  96. }
  97. if ($page > ceil($itemsEvent->count / $limit)) {
  98. $pageOutOfRangeOption = $options[PaginatorInterface::PAGE_OUT_OF_RANGE] ?? $this->defaultOptions[PaginatorInterface::PAGE_OUT_OF_RANGE];
  99. if ($pageOutOfRangeOption === PaginatorInterface::PAGE_OUT_OF_RANGE_FIX && $itemsEvent->count > 0) {
  100. // replace page number out of range with max page
  101. return $this->paginate($target, (int) ceil($itemsEvent->count / $limit), $limit, $options);
  102. }
  103. if ($pageOutOfRangeOption === self::PAGE_OUT_OF_RANGE_THROW_EXCEPTION && $page > 1) {
  104. throw new PageNumberOutOfRangeException(
  105. sprintf('Page number: %d is out of range.', $page),
  106. (int) ceil($itemsEvent->count / $limit)
  107. );
  108. }
  109. }
  111. // pagination initialization event
  112. $paginationEvent = new Event\PaginationEvent;
  113. $paginationEvent->target = &$target;
  114. $paginationEvent->options = &$options;
  115. $this->eventDispatcher->dispatch($paginationEvent, 'knp_pager.pagination');
  116. if (!$paginationEvent->isPropagationStopped()) {
  117. throw new \RuntimeException('One of listeners must create pagination view');
  118. }
  119. // pagination class can be different, with different rendering methods
  120. $paginationView = $paginationEvent->getPagination();
  121. $paginationView->setCustomParameters($itemsEvent->getCustomPaginationParameters());
  122. $paginationView->setCurrentPageNumber($page);
  123. $paginationView->setItemNumberPerPage($limit);
  124. $paginationView->setTotalItemCount($itemsEvent->count);
  125. $paginationView->setPaginatorOptions($options);
  126. $paginationView->setItems($itemsEvent->items);
  128. // after
  129. $afterEvent = new Event\AfterEvent($paginationView);
  130. $this->eventDispatcher->dispatch($afterEvent, 'knp_pager.after');
  132. return $paginationView;
  133. }
  134. }