Pass ArgumentAccess with the knp_pager.items event

This makes it possible for `knp_pager.items` event subscribers to access the pagination parameters, without having to be wired up by a dedicated `knp_pager.before` handler.
KnpLabs · Sep 24, 2024 · 6756cda · 6756cda
1 parent a1ccc00
commit 6756cda
Show file tree

Hide file tree

Showing 15 changed files with 157 additions and 162 deletions.
diff --git a/src/Knp/Component/Pager/Event/ItemsEvent.php b/src/Knp/Component/Pager/Event/ItemsEvent.php
@@ -2,6 +2,7 @@
 
 namespace Knp\Component\Pager\Event;
 
+use Knp\Component\Pager\ArgumentAccess\ArgumentAccessInterface;
 use Symfony\Contracts\EventDispatcher\Event;
 
 /**
@@ -34,7 +35,7 @@ final class ItemsEvent extends Event
      */
     private array $customPaginationParams = [];
 
-    public function __construct(private readonly int $offset, private readonly int $limit)
+    public function __construct(private readonly int $offset, private readonly int $limit, private readonly ArgumentAccessInterface $argumentAccess)
     {
     }
 
@@ -67,4 +68,9 @@ public function getOffset(): int
     {
         return $this->offset;
     }
+
+    public function getArgumentAccess(): ArgumentAccessInterface
+    {
+        return $this->argumentAccess;
+    }
 }
diff --git a/src/Knp/Component/Pager/Event/Subscriber/Filtration/Doctrine/ORM/QuerySubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Filtration/Doctrine/ORM/QuerySubscriber.php
@@ -22,16 +22,18 @@ public function items(ItemsEvent $event): void
         if (!$event->target instanceof Query) {
             return;
         }
-        if (!$this->hasQueryParameter($event->options[PaginatorInterface::FILTER_VALUE_PARAMETER_NAME])) {
+        $argumentAccess = $event->getArgumentAccess();
+
+        if (!$argumentAccess->has($event->options[PaginatorInterface::FILTER_VALUE_PARAMETER_NAME])) {
             return;
         }
-        $filterValue = $this->getQueryParameter($event->options[PaginatorInterface::FILTER_VALUE_PARAMETER_NAME]);
+        $filterValue = $argumentAccess->get($event->options[PaginatorInterface::FILTER_VALUE_PARAMETER_NAME]);
         if ((empty($filterValue) && $filterValue !== '0')) {
             return;
         }
         $filterName = null;
-        if ($this->hasQueryParameter($event->options[PaginatorInterface::FILTER_FIELD_PARAMETER_NAME])) {
-            $filterName = $this->getQueryParameter($event->options[PaginatorInterface::FILTER_FIELD_PARAMETER_NAME]);
+        if ($argumentAccess->has($event->options[PaginatorInterface::FILTER_FIELD_PARAMETER_NAME])) {
+            $filterName = $argumentAccess->get($event->options[PaginatorInterface::FILTER_FIELD_PARAMETER_NAME]);
         }
         if (!empty($filterName)) {
             $columns = $filterName;
@@ -40,7 +42,7 @@ public function items(ItemsEvent $event): void
         } else {
             return;
         }
-        $value = $this->getQueryParameter($event->options[PaginatorInterface::FILTER_VALUE_PARAMETER_NAME]);
+        $value = $argumentAccess->get($event->options[PaginatorInterface::FILTER_VALUE_PARAMETER_NAME]);
         if (str_contains($value, '*')) {
             $value = str_replace('*', '%', $value);
         }
@@ -67,14 +69,4 @@ public static function getSubscribedEvents(): array
             'knp_pager.items' => ['items', 0],
         ];
     }
-
-    private function hasQueryParameter(string $name): bool
-    {
-        return $this->argumentAccess->has($name);
-    }
-
-    private function getQueryParameter(string $name): ?string
-    {
-        return $this->argumentAccess->get($name);
-    }
 }
diff --git a/src/Knp/Component/Pager/Event/Subscriber/Filtration/FiltrationSubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Filtration/FiltrationSubscriber.php
@@ -23,7 +23,7 @@ public function before(BeforeEvent $event): void
         $dispatcher = $event->getEventDispatcher();
         // hook all standard filtration subscribers
         $dispatcher->addSubscriber(new Doctrine\ORM\QuerySubscriber($event->getArgumentAccess()));
-        $dispatcher->addSubscriber(new PropelQuerySubscriber($event->getArgumentAccess()));
+        $dispatcher->addSubscriber(new PropelQuerySubscriber());
 
         $this->isLoaded = true;
     }

diff --git a/src/Knp/Component/Pager/Event/Subscriber/Filtration/PropelQuerySubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Filtration/PropelQuerySubscriber.php
@@ -2,27 +2,24 @@
 
 namespace Knp\Component\Pager\Event\Subscriber\Filtration;
 
-use Knp\Component\Pager\ArgumentAccess\ArgumentAccessInterface;
 use Knp\Component\Pager\Event\ItemsEvent;
 use Knp\Component\Pager\Exception\InvalidValueException;
 use Knp\Component\Pager\PaginatorInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 class PropelQuerySubscriber implements EventSubscriberInterface
 {
-    public function __construct(private readonly ArgumentAccessInterface $argumentAccess)
-    {
-    }
-
     public function items(ItemsEvent $event): void
     {
         $query = $event->target;
+        $argumentAccess = $event->getArgumentAccess();
+
         if ($query instanceof \ModelCriteria) {
-            if (!$this->argumentAccess->has($event->options[PaginatorInterface::FILTER_VALUE_PARAMETER_NAME])) {
+            if (!$argumentAccess->has($event->options[PaginatorInterface::FILTER_VALUE_PARAMETER_NAME])) {
                 return;
             }
-            if ($this->argumentAccess->has($event->options[PaginatorInterface::FILTER_FIELD_PARAMETER_NAME])) {
-                $columns = $this->argumentAccess->get($event->options[PaginatorInterface::FILTER_FIELD_PARAMETER_NAME]);
+            if ($argumentAccess->has($event->options[PaginatorInterface::FILTER_FIELD_PARAMETER_NAME])) {
+                $columns = $argumentAccess->get($event->options[PaginatorInterface::FILTER_FIELD_PARAMETER_NAME]);
             } elseif (!empty($event->options[PaginatorInterface::DEFAULT_FILTER_FIELDS])) {
                 $columns = $event->options[PaginatorInterface::DEFAULT_FILTER_FIELDS];
             } else {
@@ -39,7 +36,7 @@ public function items(ItemsEvent $event): void
                     }
                 }
             }
-            $value = $this->argumentAccess->get($event->options[PaginatorInterface::FILTER_VALUE_PARAMETER_NAME]);
+            $value = $argumentAccess->get($event->options[PaginatorInterface::FILTER_VALUE_PARAMETER_NAME]);
             $criteria = \Criteria::EQUAL;
             if (str_contains($value, '*')) {
                 $value = str_replace('*', '%', $value);

diff --git a/src/Knp/Component/Pager/Event/Subscriber/Sortable/ArraySubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Sortable/ArraySubscriber.php
@@ -25,7 +25,7 @@ class ArraySubscriber implements EventSubscriberInterface
 
     private readonly ?PropertyAccessorInterface $propertyAccessor;
 
-    public function __construct(private readonly ArgumentAccessInterface $argumentAccess, ?PropertyAccessorInterface $accessor = null)
+    public function __construct(?PropertyAccessorInterface $accessor = null)
     {
         if (!$accessor && class_exists(PropertyAccess::class)) {
             $accessor = PropertyAccess::createPropertyAccessorBuilder()->enableMagicCall()->getPropertyAccessor();
@@ -36,24 +36,26 @@ public function __construct(private readonly ArgumentAccessInterface $argumentAc
 
     public function items(ItemsEvent $event): void
     {
+        $argumentAccess = $event->getArgumentAccess();
+
         // Check if the result has already been sorted by another sort subscriber
         $customPaginationParameters = $event->getCustomPaginationParameters();
         if (!empty($customPaginationParameters['sorted']) ) {
             return;
         }
         $sortField = $event->options[PaginatorInterface::SORT_FIELD_PARAMETER_NAME];
-        if (!is_array($event->target) || null === $sortField || !$this->argumentAccess->has($sortField)) {
+        if (!is_array($event->target) || null === $sortField || !$argumentAccess->has($sortField)) {
             return;
         }
 
         $event->setCustomPaginationParameter('sorted', true);
 
-        if (isset($event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST]) && !in_array($this->argumentAccess->get($sortField), $event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST])) {
-            throw new InvalidValueException("Cannot sort by: [{$this->argumentAccess->get($sortField)}] this field is not in allow list.");
+        if (isset($event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST]) && !in_array($argumentAccess->get($sortField), $event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST])) {
+            throw new InvalidValueException("Cannot sort by: [{$argumentAccess->get($sortField)}] this field is not in allow list.");
         }
 
         $sortFunction = $event->options['sortFunction'] ?? [$this, 'proxySortFunction'];
-        $sortField = $this->argumentAccess->get($sortField);
+        $sortField = $argumentAccess->get($sortField);
 
         // compatibility layer
         if ($sortField[0] === '.') {
@@ -63,19 +65,19 @@ public function items(ItemsEvent $event): void
         call_user_func_array($sortFunction, [
             &$event->target,
             $sortField,
-            $this->getSortDirection($event->options),
+            $this->getSortDirection($event),
         ]);
     }
 
-    /**
-     * @param array<string, mixed> $options
-     */
-    private function getSortDirection(array $options): string
+    private function getSortDirection(ItemsEvent $event): string
     {
-        if (!$this->argumentAccess->has($options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME])) {
+        $argumentAccess = $event->getArgumentAccess();
+        $options = $event->options;
+
+        if (!$argumentAccess->has($options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME])) {
             return 'desc';
         }
-        $direction = $this->argumentAccess->get($options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME]);
+        $direction = $argumentAccess->get($options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME]);
         if (strtolower($direction) === 'asc') {
             return 'asc';
         }

diff --git a/src/Knp/Component/Pager/Event/Subscriber/Sortable/Doctrine/ODM/MongoDB/QuerySubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Sortable/Doctrine/ODM/MongoDB/QuerySubscriber.php
@@ -3,20 +3,17 @@
 namespace Knp\Component\Pager\Event\Subscriber\Sortable\Doctrine\ODM\MongoDB;
 
 use Doctrine\ODM\MongoDB\Query\Query;
-use Knp\Component\Pager\ArgumentAccess\ArgumentAccessInterface;
 use Knp\Component\Pager\Event\ItemsEvent;
 use Knp\Component\Pager\Exception\InvalidValueException;
 use Knp\Component\Pager\PaginatorInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 class QuerySubscriber implements EventSubscriberInterface
 {
-    public function __construct(private readonly ArgumentAccessInterface $argumentAccess)
-    {
-    }
-
     public function items(ItemsEvent $event): void
     {
+        $argumentAccess = $event->getArgumentAccess();
+
         // Check if the result has already been sorted by another sort subscriber
         $customPaginationParameters = $event->getCustomPaginationParameters();
         if (!empty($customPaginationParameters['sorted']) ) {
@@ -27,9 +24,9 @@ public function items(ItemsEvent $event): void
             $event->setCustomPaginationParameter('sorted', true);
             $sortField = $event->options[PaginatorInterface::SORT_FIELD_PARAMETER_NAME];
             $sortDir = $event->options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME];
-            if (null !== $sortField && $this->argumentAccess->has($sortField)) {
-                $field = $this->argumentAccess->get($sortField);
-                $dir = null !== $sortDir && strtolower($this->argumentAccess->get($sortDir)) === 'asc' ? 1 : -1;
+            if (null !== $sortField && $argumentAccess->has($sortField)) {
+                $field = $argumentAccess->get($sortField);
+                $dir = null !== $sortDir && strtolower($argumentAccess->get($sortDir)) === 'asc' ? 1 : -1;
 
                 if (isset($event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST]) && (!in_array($field, $event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST]))) {
                     throw new InvalidValueException("Cannot sort by: [$field] this field is not in allow list.");

diff --git a/src/Knp/Component/Pager/Event/Subscriber/Sortable/Doctrine/ORM/QuerySubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Sortable/Doctrine/ORM/QuerySubscriber.php
@@ -3,7 +3,6 @@
 namespace Knp\Component\Pager\Event\Subscriber\Sortable\Doctrine\ORM;
 
 use Doctrine\ORM\Query;
-use Knp\Component\Pager\ArgumentAccess\ArgumentAccessInterface;
 use Knp\Component\Pager\Event\ItemsEvent;
 use Knp\Component\Pager\Event\Subscriber\Paginate\Doctrine\ORM\Query\Helper as QueryHelper;
 use Knp\Component\Pager\Event\Subscriber\Sortable\Doctrine\ORM\Query\OrderByWalker;
@@ -13,12 +12,10 @@
 
 class QuerySubscriber implements EventSubscriberInterface
 {
-    public function __construct(private readonly ArgumentAccessInterface $argumentAccess)
-    {
-    }
-
     public function items(ItemsEvent $event): void
     {
+        $argumentAccess = $event->getArgumentAccess();
+
         // Check if the result has already been sorted by another sort subscriber
         $customPaginationParameters = $event->getCustomPaginationParameters();
         if (!empty($customPaginationParameters['sorted']) ) {
@@ -29,14 +26,14 @@ public function items(ItemsEvent $event): void
             $event->setCustomPaginationParameter('sorted', true);
             $sortField = $event->options[PaginatorInterface::SORT_FIELD_PARAMETER_NAME];
             $sortDir = $event->options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME];
-            if (null !== $sortField && $this->argumentAccess->has($sortField)) {
-                $dir = null !== $sortDir && $this->argumentAccess->has($sortDir) && strtolower($this->argumentAccess->get($sortDir)) === 'asc' ? 'asc' : 'desc';
+            if (null !== $sortField && $argumentAccess->has($sortField)) {
+                $dir = null !== $sortDir && $argumentAccess->has($sortDir) && strtolower($argumentAccess->get($sortDir)) === 'asc' ? 'asc' : 'desc';
 
-                if (isset($event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST]) && !in_array($this->argumentAccess->get($sortField), $event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST])) {
-                    throw new InvalidValueException("Cannot sort by: [{$this->argumentAccess->get($sortField)}] this field is not in allow list.");
+                if (isset($event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST]) && !in_array($argumentAccess->get($sortField), $event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST])) {
+                    throw new InvalidValueException("Cannot sort by: [{$argumentAccess->get($sortField)}] this field is not in allow list.");
                 }
 
-                $sortFieldParameterNames = $this->argumentAccess->get($sortField);
+                $sortFieldParameterNames = $argumentAccess->get($sortField);
                 $fields = [];
                 $aliases = [];
                 if (!is_string($sortFieldParameterNames)) {

diff --git a/src/Knp/Component/Pager/Event/Subscriber/Sortable/ElasticaQuerySubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Sortable/ElasticaQuerySubscriber.php
@@ -4,20 +4,17 @@
 
 use Elastica\Query;
 use Elastica\SearchableInterface;
-use Knp\Component\Pager\ArgumentAccess\ArgumentAccessInterface;
 use Knp\Component\Pager\Event\ItemsEvent;
 use Knp\Component\Pager\Exception\InvalidValueException;
 use Knp\Component\Pager\PaginatorInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 class ElasticaQuerySubscriber implements EventSubscriberInterface
 {
-    public function __construct(private readonly ArgumentAccessInterface $argumentAccess)
-    {
-    }
-
     public function items(ItemsEvent $event): void
     {
+        $argumentAccess = $event->getArgumentAccess();
+
         // Check if the result has already been sorted by another sort subscriber
         $customPaginationParameters = $event->getCustomPaginationParameters();
         if (!empty($customPaginationParameters['sorted']) ) {
@@ -29,9 +26,9 @@ public function items(ItemsEvent $event): void
             $event->setCustomPaginationParameter('sorted', true);
             $sortField = $event->options[PaginatorInterface::SORT_FIELD_PARAMETER_NAME];
             $sortDir = $event->options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME];
-            if (null !== $sortField && $this->argumentAccess->has($sortField)) {
-                $field = $this->argumentAccess->get($sortField);
-                $dir   = null !== $sortDir && $this->argumentAccess->has($sortDir) && strtolower($this->argumentAccess->get($sortDir)) === 'asc' ? 'asc' : 'desc';
+            if (null !== $sortField && $argumentAccess->has($sortField)) {
+                $field = $argumentAccess->get($sortField);
+                $dir   = null !== $sortDir && $argumentAccess->has($sortDir) && strtolower($argumentAccess->get($sortDir)) === 'asc' ? 'asc' : 'desc';
 
                 if (isset($event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST]) && !in_array($field, $event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST])) {
                     throw new InvalidValueException(sprintf('Cannot sort by: [%s] this field is not in allow list.', $field));

diff --git a/src/Knp/Component/Pager/Event/Subscriber/Sortable/PropelQuerySubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Sortable/PropelQuerySubscriber.php
@@ -2,20 +2,17 @@
 
 namespace Knp\Component\Pager\Event\Subscriber\Sortable;
 
-use Knp\Component\Pager\ArgumentAccess\ArgumentAccessInterface;
 use Knp\Component\Pager\Event\ItemsEvent;
 use Knp\Component\Pager\Exception\InvalidValueException;
 use Knp\Component\Pager\PaginatorInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 class PropelQuerySubscriber implements EventSubscriberInterface
 {
-    public function __construct(private readonly ArgumentAccessInterface $argumentAccess)
-    {
-    }
-
     public function items(ItemsEvent $event): void
     {
+        $argumentAccess = $event->getArgumentAccess();
+
         // Check if the result has already been sorted by another sort subscriber
         $customPaginationParameters = $event->getCustomPaginationParameters();
         if (!empty($customPaginationParameters['sorted']) ) {
@@ -27,13 +24,13 @@ public function items(ItemsEvent $event): void
             $event->setCustomPaginationParameter('sorted', true);
             $sortField = $event->options[PaginatorInterface::SORT_FIELD_PARAMETER_NAME];
             $sortDir = $event->options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME];
-            if (null !== $sortField && $this->argumentAccess->has($sortField)) {
-                $part = $this->argumentAccess->get($sortField);
-                $direction = (null !== $sortDir && $this->argumentAccess->has($sortDir) && strtolower($this->argumentAccess->get($sortDir)) === 'asc')
+            if (null !== $sortField && $argumentAccess->has($sortField)) {
+                $part = $argumentAccess->get($sortField);
+                $direction = (null !== $sortDir && $argumentAccess->has($sortDir) && strtolower($argumentAccess->get($sortDir)) === 'asc')
                                 ? 'asc' : 'desc';
 
-                if (isset($event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST]) && !in_array($this->argumentAccess->get($sortField), $event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST])) {
-                    throw new InvalidValueException("Cannot sort by: [{$this->argumentAccess->get($sortField)}] this field is not in allow list.");
+                if (isset($event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST]) && !in_array($argumentAccess->get($sortField), $event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST])) {
+                    throw new InvalidValueException("Cannot sort by: [{$argumentAccess->get($sortField)}] this field is not in allow list.");
                 }
 
                 $query->orderBy($part, $direction);