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

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