vendor/knplabs/knp-paginator-bundle/src/Subscriber/SlidingPaginationSubscriber.php line 29

  1. <?php
  3. namespace Knp\Bundle\PaginatorBundle\Subscriber;
  5. use Knp\Bundle\PaginatorBundle\Pagination\SlidingPagination;
  6. use Knp\Component\Pager\Event\PaginationEvent;
  7. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  8. use Symfony\Component\HttpKernel\Event\RequestEvent;
  9. use Symfony\Component\HttpKernel\HttpKernelInterface;
  11. final class SlidingPaginationSubscriber implements EventSubscriberInterface
  12. {
  13.     private ?string $route = null;
  15.     /** @var array<string, mixed> */
  16.     private array $params = [];
  18.     /** @var array<string, mixed> */
  19.     private array $options;
  21.     /**
  22.      * @param array<string, mixed> $options
  23.      */
  24.     public function __construct(array $options)
  25.     {
  26.         $this->options = $options;
  27.     }
  29.     public function onKernelRequest(RequestEvent $event): void
  30.     {
  31.         if (HttpKernelInterface::MAIN_REQUEST !== $event->getRequestType()) {
  32.             return;
  33.         }
  35.         $request = $event->getRequest();
  37.         $this->route = $request->attributes->get('_route');
  38.         $this->params = \array_replace($request->query->all(), $request->attributes->get('_route_params', []));
  39.         foreach ($this->params as $key => $param) {
  40.             if (\str_starts_with($key, '_')) {
  41.                 unset($this->params[$key]);
  42.             }
  43.         }
  44.     }
  46.     public function pagination(PaginationEvent $event): void
  47.     {
  48.         // default sort field and order
  49.         $eventOptions = $event->options;
  51.         if (isset($eventOptions['defaultSortFieldName']) && !isset($this->params[$eventOptions['sortFieldParameterName']])) {
  52.             $this->params[$eventOptions['sortFieldParameterName']] = $eventOptions['defaultSortFieldName'];
  53.         }
  55.         if (isset($eventOptions['defaultSortDirection']) && !isset($this->params[$eventOptions['sortDirectionParameterName']])) {
  56.             $this->params[$eventOptions['sortDirectionParameterName']] = $eventOptions['defaultSortDirection'];
  57.         }
  59.         // remove default sort params from pagination links
  60.         if (isset($eventOptions['removeDefaultSortParams']) && true === $eventOptions['removeDefaultSortParams']) {
  61.             $defaultSortFieldName = $eventOptions['defaultSortFieldName'];
  62.             $sortFieldParameterName = $this->params[$eventOptions['sortFieldParameterName']];
  63.             $isFieldEqual = $defaultSortFieldName === $sortFieldParameterName;
  64.             $defaultSortDirection = $eventOptions['defaultSortDirection'];
  65.             $sortDirectionParameterName = $this->params[$eventOptions['sortDirectionParameterName']];
  66.             $isDirectionEqual = $defaultSortDirection === $sortDirectionParameterName;
  68.             if (isset($defaultSortFieldName, $sortFieldParameterName, $defaultSortDirection, $sortDirectionParameterName) && $isFieldEqual && $isDirectionEqual) {
  69.                 unset($this->params[$eventOptions['sortFieldParameterName']], $this->params[$eventOptions['sortDirectionParameterName']]);
  70.             }
  71.         }
  73.         $pagination = new SlidingPagination($this->params);
  75.         $pagination->setUsedRoute($this->route);
  76.         $pagination->setTemplate($this->options['defaultPaginationTemplate']);
  77.         $pagination->setSortableTemplate($this->options['defaultSortableTemplate']);
  78.         $pagination->setFiltrationTemplate($this->options['defaultFiltrationTemplate']);
  79.         $pagination->setPageRange($this->options['defaultPageRange']);
  80.         $pagination->setPageLimit($this->options['defaultPageLimit']);
  82.         $event->setPagination($pagination);
  83.         $event->stopPropagation();
  84.     }
  86.     /**
  87.      * @return array<string, array<int, int|string>>
  88.      */
  89.     public static function getSubscribedEvents(): array
  90.     {
  91.         return [
  92.             'knp_pager.pagination' => ['pagination', 1],
  93.         ];
  94.     }
  95. }