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

  1. <?php
  3. namespace Knp\Component\Pager\Event\Subscriber\Sortable\Doctrine\ORM;
  5. use Doctrine\ORM\Query;
  6. use Knp\Component\Pager\ArgumentAccess\ArgumentAccessInterface;
  7. use Knp\Component\Pager\Event\ItemsEvent;
  8. use Knp\Component\Pager\Event\Subscriber\Paginate\Doctrine\ORM\Query\Helper as QueryHelper;
  9. use Knp\Component\Pager\Event\Subscriber\Sortable\Doctrine\ORM\Query\OrderByWalker;
  10. use Knp\Component\Pager\Exception\InvalidValueException;
  11. use Knp\Component\Pager\PaginatorInterface;
  12. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  14. class QuerySubscriber implements EventSubscriberInterface
  15. {
  16.     private ArgumentAccessInterface $argumentAccess;
  18.     public function __construct(ArgumentAccessInterface $argumentAccess)
  19.     {
  20.         $this->argumentAccess = $argumentAccess;
  21.     }
  23.     public function items(ItemsEvent $event): void
  24.     {
  25.         // Check if the result has already been sorted by another sort subscriber
  26.         $customPaginationParameters = $event->getCustomPaginationParameters();
  27.         if (!empty($customPaginationParameters['sorted']) ) {
  28.             return;
  29.         }
  31.         if ($event->target instanceof Query) {
  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.                 $dir = null !== $sortDir && $this->argumentAccess->has($sortDir) && strtolower($this->argumentAccess->get($sortDir)) === 'asc' ? '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.                 $sortFieldParameterNames = $this->argumentAccess->get($sortField);
  45.                 $fields = [];
  46.                 $aliases = [];
  47.                 if (!is_string($sortFieldParameterNames)) {
  48.                     throw new InvalidValueException('Cannot sort with array parameter.');
  49.                 }
  51.                 foreach (explode('+', $sortFieldParameterNames) as $sortFieldParameterName) {
  52.                     $parts = explode('.', $sortFieldParameterName, 2);
  54.                     // We have to prepend the field. Otherwise OrderByWalker will add
  55.                     // the order-by items in the wrong order
  56.                     array_unshift($fields, end($parts));
  57.                     array_unshift($aliases, 2 <= count($parts) ? reset($parts) : false);
  58.                 }
  60.                 $event->target
  61.                     ->setHint(OrderByWalker::HINT_PAGINATOR_SORT_DIRECTION, $dir)
  62.                     ->setHint(OrderByWalker::HINT_PAGINATOR_SORT_FIELD, $fields)
  63.                     ->setHint(OrderByWalker::HINT_PAGINATOR_SORT_ALIAS, $aliases)
  64.                 ;
  66.                 QueryHelper::addCustomTreeWalker($event->target, OrderByWalker::class);
  67.             }
  68.         }
  69.     }
  71.     public static function getSubscribedEvents(): array
  72.     {
  73.         return [
  74.             'knp_pager.items' => ['items', 1],
  75.         ];
  76.     }
  77. }