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

Open in your IDE?
  1. <?php
  3. namespace Knp\Component\Pager\Event\Subscriber\Sortable\Doctrine\ORM;
  5. use Doctrine\ORM\Query;
  6. use Knp\Component\Pager\Event\ItemsEvent;
  7. use Knp\Component\Pager\Event\Subscriber\Paginate\Doctrine\ORM\Query\Helper as QueryHelper;
  8. use Knp\Component\Pager\Event\Subscriber\Sortable\Doctrine\ORM\Query\OrderByWalker;
  9. use Knp\Component\Pager\PaginatorInterface;
  10. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  11. use Symfony\Component\HttpFoundation\Request;
  13. class QuerySubscriber implements EventSubscriberInterface
  14. {
  15.     /**
  16.      * @var Request
  17.      */
  18.     private $request;
  20.     public function __construct(Request $request)
  21.     {
  22.         $this->request = $request;
  23.     }
  25.     public function items(ItemsEvent $event): void
  26.     {
  27.         // Check if the result has already been sorted by an other sort subscriber
  28.         $customPaginationParameters = $event->getCustomPaginationParameters();
  29.         if (!empty($customPaginationParameters['sorted']) ) {
  30.             return;
  31.         }
  33.         if ($event->target instanceof Query) {
  34.             $event->setCustomPaginationParameter('sorted', true);
  35.             $sortField = $event->options[PaginatorInterface::SORT_FIELD_PARAMETER_NAME];
  36.             $sortDir = $event->options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME];
  37.             if (null !== $sortField && $this->request->query->has($sortField)) {
  38.                 $dir = null !== $sortDir && $this->request->query->has($sortDir) && strtolower($this->request->query->get($sortDir)) === 'asc' ? 'asc' : 'desc';
  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.                 $sortFieldParameterNames = $this->request->query->get($sortField);
  47.                 $fields = [];
  48.                 $aliases = [];
  49.                 if (!is_string($sortFieldParameterNames)) {
  50.                     throw new \UnexpectedValueException('Cannot sort with array parameter.');
  51.                 }
  53.                 foreach (explode('+', $sortFieldParameterNames) as $sortFieldParameterName) {
  54.                     $parts = explode('.', $sortFieldParameterName, 2);
  56.                     // We have to prepend the field. Otherwise OrderByWalker will add
  57.                     // the order-by items in the wrong order
  58.                     array_unshift($fields, end($parts));
  59.                     array_unshift($aliases, 2 <= count($parts) ? reset($parts) : false);
  60.                 }
  62.                 $event->target
  63.                     ->setHint(OrderByWalker::HINT_PAGINATOR_SORT_DIRECTION, $dir)
  64.                     ->setHint(OrderByWalker::HINT_PAGINATOR_SORT_FIELD, $fields)
  65.                     ->setHint(OrderByWalker::HINT_PAGINATOR_SORT_ALIAS, $aliases)
  66.                 ;
  68.                 QueryHelper::addCustomTreeWalker($event->target, OrderByWalker::class);
  69.             }
  70.         }
  71.     }
  73.     public static function getSubscribedEvents(): array
  74.     {
  75.         return [
  76.             'knp_pager.items' => ['items', 1],
  77.         ];
  78.     }
  79. }