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

  1. <?php
  3. namespace Knp\Component\Pager\Event\Subscriber\Sortable;
  5. use Elastica\Query;
  6. use Elastica\SearchableInterface;
  7. use Knp\Component\Pager\ArgumentAccess\ArgumentAccessInterface;
  8. use Knp\Component\Pager\Event\ItemsEvent;
  9. use Knp\Component\Pager\Exception\InvalidValueException;
  10. use Knp\Component\Pager\PaginatorInterface;
  11. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  13. class ElasticaQuerySubscriber implements EventSubscriberInterface
  14. {
  15.     private ArgumentAccessInterface $argumentAccess;
  17.     public function __construct(ArgumentAccessInterface $argumentAccess)
  18.     {
  19.         $this->argumentAccess = $argumentAccess;
  20.     }
  22.     public function items(ItemsEvent $event): void
  23.     {
  24.         // Check if the result has already been sorted by another sort subscriber
  25.         $customPaginationParameters = $event->getCustomPaginationParameters();
  26.         if (!empty($customPaginationParameters['sorted']) ) {
  27.             return;
  28.         }
  30.         if (is_array($event->target) && 2 === count($event->target) && reset($event->target) instanceof SearchableInterface && end($event->target) instanceof Query) {
  31.             [$searchable, $query] = $event->target;
  32.             $event->setCustomPaginationParameter('sorted', true);
  33.             $sortField = $event->options[PaginatorInterface::SORT_FIELD_PARAMETER_NAME];
  34.             $sortDir = $event->options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME];
  35.             if (null !== $sortField && $this->argumentAccess->has($sortField)) {
  36.                 $field = $this->argumentAccess->get($sortField);
  37.                 $dir   = null !== $sortDir && $this->argumentAccess->has($sortDir) && strtolower($this->argumentAccess->get($sortDir)) === 'asc' ? 'asc' : 'desc';
  39.                 if (isset($event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST]) && !in_array($field, $event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST])) {
  40.                     throw new InvalidValueException(sprintf('Cannot sort by: [%s] this field is not in allow list.', $field));
  41.                 }
  43.                 $query->setSort([
  44.                     $field => ['order' => $dir],
  45.                 ]);
  46.             }
  47.         }
  48.     }
  50.     public static function getSubscribedEvents(): array
  51.     {
  52.         return [
  53.             'knp_pager.items' => ['items', 1],
  54.         ];
  55.     }
  56. }