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

  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.     /** @var string */
  14.     private $route;
  16.     /** @var array<string, mixed> */
  17.     private $params = [];
  19.     /** @var array<string, mixed> */
  20.     private $options;
  22.     /**
  23.      * @param array<string, mixed> $options
  24.      */
  25.     public function __construct(array $options)
  26.     {
  27.         $this->options = $options;
  28.     }
  30.     public function onKernelRequest(RequestEvent $event): void
  31.     {
  32.         if (HttpKernelInterface::MASTER_REQUEST !== $event->getRequestType()) {
  33.             return;
  34.         }
  36.         $request = $event->getRequest();
  38.         $this->route = $request->attributes->get('_route');
  39.         $this->params = \array_replace($request->query->all(), $request->attributes->get('_route_params', []));
  40.         foreach ($this->params as $key => $param) {
  41.             if (\strpos($key, '_') === 0) {
  42.                 unset($this->params[$key]);
  43.             }
  44.         }
  45.     }
  47.     public function pagination(PaginationEvent $event): void
  48.     {
  49.         // default sort field and order
  50.         $eventOptions = $event->options;
  52.         if (isset($eventOptions['defaultSortFieldName']) && !isset($this->params[$eventOptions['sortFieldParameterName']])) {
  53.             $this->params[$eventOptions['sortFieldParameterName']] = $eventOptions['defaultSortFieldName'];
  54.         }
  56.         if (isset($eventOptions['defaultSortDirection']) && !isset($this->params[$eventOptions['sortDirectionParameterName']])) {
  57.             $this->params[$eventOptions['sortDirectionParameterName']] = $eventOptions['defaultSortDirection'];
  58.         }
  60.         // remove default sort params from pagination links
  61.         if (isset($eventOptions['removeDefaultSortParams']) && true === $eventOptions['removeDefaultSortParams']) {
  62.             $defaultSortFieldName = $eventOptions['defaultSortFieldName'];
  63.             $sortFieldParameterName = $this->params[$eventOptions['sortFieldParameterName']];
  64.             $isFieldEqual = $defaultSortFieldName === $sortFieldParameterName;
  65.             $defaultSortDirection = $eventOptions['defaultSortDirection'];
  66.             $sortDirectionParameterName = $this->params[$eventOptions['sortDirectionParameterName']];
  67.             $isDirectionEqual = $defaultSortDirection === $sortDirectionParameterName;
  69.             if (isset($defaultSortFieldName, $sortFieldParameterName, $defaultSortDirection, $sortDirectionParameterName) && $isFieldEqual && $isDirectionEqual) {
  70.                 unset($this->params[$eventOptions['sortFieldParameterName']], $this->params[$eventOptions['sortDirectionParameterName']]);
  71.             }
  72.         }
  74.         $pagination = new SlidingPagination($this->params);
  76.         $pagination->setUsedRoute($this->route);
  77.         $pagination->setTemplate($this->options['defaultPaginationTemplate']);
  78.         $pagination->setSortableTemplate($this->options['defaultSortableTemplate']);
  79.         $pagination->setFiltrationTemplate($this->options['defaultFiltrationTemplate']);
  80.         $pagination->setPageRange($this->options['defaultPageRange']);
  81.         $pagination->setPageLimit($this->options['defaultPageLimit']);
  83.         $event->setPagination($pagination);
  84.         $event->stopPropagation();
  85.     }
  87.     /**
  88.      * @return array<string, array<int, int|string>>
  89.      */
  90.     public static function getSubscribedEvents(): array
  91.     {
  92.         return [
  93.             'knp_pager.pagination' => ['pagination', 1],
  94.         ];
  95.     }
  96. }