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

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