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

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