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

Open in your IDE?
  1. <?php
  3. namespace Knp\Component\Pager\Event\Subscriber\Filtration\Doctrine\ORM;
  5. use Doctrine\ORM\Query;
  6. use Knp\Component\Pager\Event\ItemsEvent;
  7. use Knp\Component\Pager\Event\Subscriber\Filtration\Doctrine\ORM\Query\WhereWalker;
  8. use Knp\Component\Pager\Event\Subscriber\Paginate\Doctrine\ORM\Query\Helper as QueryHelper;
  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.     private Request $request;
  17.     public function __construct(?Request $request)
  18.     {
  19.         $this->request = $request ?? Request::createFromGlobals();
  20.     }
  22.     public function items(ItemsEvent $event): void
  23.     {
  24.         if ($event->target instanceof Query) {
  25.             $filterValue = $this->getQueryParameter($event->options[PaginatorInterface::FILTER_VALUE_PARAMETER_NAME]);
  26.             if (null === $filterValue || (empty($filterValue) && $filterValue !== '0')) {
  27.                 return;
  28.             }
  29.             $filterName = $this->getQueryParameter($event->options[PaginatorInterface::FILTER_FIELD_PARAMETER_NAME]);
  30.             if (!empty($filterName)) {
  31.                 $columns = $filterName;
  32.             } elseif (!empty($event->options[PaginatorInterface::DEFAULT_FILTER_FIELDS])) {
  33.                 $columns = $event->options[PaginatorInterface::DEFAULT_FILTER_FIELDS];
  34.             } else {
  35.                 return;
  36.             }
  37.             $value = $this->getQueryParameter($event->options[PaginatorInterface::FILTER_VALUE_PARAMETER_NAME]);
  38.             if (false !== strpos($value, '*')) {
  39.                 $value = str_replace('*', '%', $value);
  40.             }
  41.             if (is_string($columns) && false !== strpos($columns, ',')) {
  42.                 $columns = explode(',', $columns);
  43.             }
  44.             $columns = (array) $columns;
  45.             if (isset($event->options[PaginatorInterface::FILTER_FIELD_ALLOW_LIST])) {
  46.                 foreach ($columns as $column) {
  47.                     if (!in_array($column, $event->options[PaginatorInterface::FILTER_FIELD_ALLOW_LIST])) {
  48.                         throw new \UnexpectedValueException("Cannot filter by: [{$column}] this field is not in allow list");
  49.                     }
  50.                 }
  51.             }
  52.             $event->target
  53.                     ->setHint(WhereWalker::HINT_PAGINATOR_FILTER_VALUE, $value)
  54.                     ->setHint(WhereWalker::HINT_PAGINATOR_FILTER_COLUMNS, $columns);
  55.             QueryHelper::addCustomTreeWalker($event->target, WhereWalker::class);
  56.         }
  57.     }
  59.     public static function getSubscribedEvents(): array
  60.     {
  61.         return [
  62.             'knp_pager.items' => ['items', 0],
  63.         ];
  64.     }
  66.     private function getQueryParameter(string $name): ?string
  67.     {
  68.         return $this->request->query->get($name);
  69.     }
  70. }