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

  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. class PropelQuerySubscriber implements EventSubscriberInterface
  12. {
  13.     private ArgumentAccessInterface $argumentAccess;
  15.     public function __construct(ArgumentAccessInterface $argumentAccess)
  16.     {
  17.         $this->argumentAccess = $argumentAccess;
  18.     }
  20.     public function items(ItemsEvent $event): void
  21.     {
  22.         // Check if the result has already been sorted by another sort subscriber
  23.         $customPaginationParameters = $event->getCustomPaginationParameters();
  24.         if (!empty($customPaginationParameters['sorted']) ) {
  25.             return;
  26.         }
  28.         $query = $event->target;
  29.         if ($query instanceof \ModelCriteria) {
  30.             $event->setCustomPaginationParameter('sorted', true);
  31.             $sortField = $event->options[PaginatorInterface::SORT_FIELD_PARAMETER_NAME];
  32.             $sortDir = $event->options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME];
  33.             if (null !== $sortField && $this->argumentAccess->has($sortField)) {
  34.                 $part = $this->argumentAccess->get($sortField);
  35.                 $direction = (null !== $sortDir && $this->argumentAccess->has($sortDir) && strtolower($this->argumentAccess->get($sortDir)) === 'asc')
  36.                                 ? 'asc' : 'desc';
  38.                 if (isset($event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST])) {
  39.                     if (!in_array($this->argumentAccess->get($sortField), $event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST])) {
  40.                         throw new InvalidValueException("Cannot sort by: [{$this->argumentAccess->get($sortField)}] this field is not in allow list.");
  41.                     }
  42.                 }
  44.                 $query->orderBy($part, $direction);
  45.             }
  46.         }
  47.     }
  49.     public static function getSubscribedEvents(): array
  50.     {
  51.         return [
  52.             'knp_pager.items' => ['items', 1],
  53.         ];
  54.     }
  55. }