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

  1. <?php
  3. namespace Knp\Component\Pager\Event\Subscriber\Filtration\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\Filtration\Doctrine\ORM\Query\WhereWalker;
  9. use Knp\Component\Pager\Event\Subscriber\Paginate\Doctrine\ORM\Query\Helper as QueryHelper;
  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.         if (!$event->target instanceof Query) {
  26.             return;
  27.         }
  28.         if (!$this->hasQueryParameter($event->options[PaginatorInterface::FILTER_VALUE_PARAMETER_NAME])) {
  29.             return;
  30.         }
  31.         $filterValue = $this->getQueryParameter($event->options[PaginatorInterface::FILTER_VALUE_PARAMETER_NAME]);
  32.         if ((empty($filterValue) && $filterValue !== '0')) {
  33.             return;
  34.         }
  35.         $filterName = null;
  36.         if ($this->hasQueryParameter($event->options[PaginatorInterface::FILTER_FIELD_PARAMETER_NAME])) {
  37.             $filterName = $this->getQueryParameter($event->options[PaginatorInterface::FILTER_FIELD_PARAMETER_NAME]);
  38.         }
  39.         if (!empty($filterName)) {
  40.             $columns = $filterName;
  41.         } elseif (!empty($event->options[PaginatorInterface::DEFAULT_FILTER_FIELDS])) {
  42.             $columns = $event->options[PaginatorInterface::DEFAULT_FILTER_FIELDS];
  43.         } else {
  44.             return;
  45.         }
  46.         $value = $this->getQueryParameter($event->options[PaginatorInterface::FILTER_VALUE_PARAMETER_NAME]);
  47.         if (str_contains($value, '*')) {
  48.             $value = str_replace('*', '%', $value);
  49.         }
  50.         if (is_string($columns) && false !== strpos($columns, ',')) {
  51.             $columns = explode(',', $columns);
  52.         }
  53.         $columns = (array) $columns;
  54.         if (isset($event->options[PaginatorInterface::FILTER_FIELD_ALLOW_LIST])) {
  55.             foreach ($columns as $column) {
  56.                 if (!in_array($column, $event->options[PaginatorInterface::FILTER_FIELD_ALLOW_LIST])) {
  57.                     throw new InvalidValueException("Cannot filter by: [{$column}] this field is not in allow list");
  58.                 }
  59.             }
  60.         }
  61.         $event->target
  62.                 ->setHint(WhereWalker::HINT_PAGINATOR_FILTER_VALUE, $value)
  63.                 ->setHint(WhereWalker::HINT_PAGINATOR_FILTER_COLUMNS, $columns);
  64.         QueryHelper::addCustomTreeWalker($event->target, WhereWalker::class);
  65.     }
  67.     public static function getSubscribedEvents(): array
  68.     {
  69.         return [
  70.             'knp_pager.items' => ['items', 0],
  71.         ];
  72.     }
  74.     private function hasQueryParameter(string $name): bool
  75.     {
  76.         return $this->argumentAccess->has($name);
  77.     }
  79.     private function getQueryParameter(string $name): ?string
  80.     {
  81.         return $this->argumentAccess->get($name);
  82.     }
  83. }