vendor/knplabs/knp-components/src/Knp/Component/Pager/Event/Subscriber/Sortable/SolariumQuerySubscriber.php line 24

Open in your IDE?
  1. <?php
  3. namespace Knp\Component\Pager\Event\Subscriber\Sortable;
  5. use Knp\Component\Pager\Event\ItemsEvent;
  6. use Knp\Component\Pager\PaginatorInterface;
  7. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  8. use Symfony\Component\HttpFoundation\Request;
  10. /**
  11.  * Solarium query sorting
  12.  *
  13.  * @author Marek Kalnik <marekk@theodo.fr>
  14.  */
  15. class SolariumQuerySubscriber implements EventSubscriberInterface
  16. {
  17.     private Request $request;
  19.     public function __construct(Request $request)
  20.     {
  21.         $this->request = $request;
  22.     }
  24.     public function items(ItemsEvent $event): void
  25.     {
  26.         // Check if the result has already been sorted by an other sort subscriber
  27.         $customPaginationParameters = $event->getCustomPaginationParameters();
  28.         if (!empty($customPaginationParameters['sorted']) ) {
  29.             return;
  30.         }
  32.         if (is_array($event->target) && 2 === count($event->target)) {
  33.             $values = array_values($event->target);
  34.             [$client, $query] = $values;
  36.             if ($client instanceof \Solarium\Client && $query instanceof \Solarium\QueryType\Select\Query\Query) {
  37.                 $event->setCustomPaginationParameter('sorted', true);
  38.                 $sortField = $event->options[PaginatorInterface::SORT_FIELD_PARAMETER_NAME];
  39.                 if (null !== $sortField && $this->request->query->has($sortField)) {
  40.                     if (isset($event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST])) {
  41.                         if (!in_array($this->request->query->get($sortField), $event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST])) {
  42.                             throw new \UnexpectedValueException("Cannot sort by: [{$this->request->query->get($sortField)}] this field is not in allow list.");
  43.                         }
  44.                     }
  46.                     $query->addSort($this->request->query->get($sortField), $this->getSortDirection($event));
  47.                 }
  48.             }
  49.         }
  50.     }
  52.     public static function getSubscribedEvents(): array
  53.     {
  54.         return [
  55.             // trigger before the pagination subscriber
  56.             'knp_pager.items' => ['items', 1],
  57.         ];
  58.     }
  60.     private function getSortDirection($event): string
  61.     {
  62.         $sortDir = $event->options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME];
  64.         return null !== $sortDir && $this->request->query->has($sortDir) &&
  65.             strtolower($this->request->query->get($sortDir)) === 'asc' ? 'asc' : 'desc';
  66.     }
  67. }