vendor/knplabs/knp-components/src/Knp/Component/Pager/Event/Subscriber/Sortable/ArraySubscriber.php line 40

  1. <?php
  3. namespace Knp\Component\Pager\Event\Subscriber\Sortable;
  5. use Knp\Component\Pager\ArgumentAccess\ArgumentAccessInterface;
  6. use Knp\Component\Pager\Event\ItemsEvent;
  7. use Knp\Component\Pager\Exception\InvalidValueException;
  8. use Knp\Component\Pager\PaginatorInterface;
  9. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  10. use Symfony\Component\PropertyAccess\Exception\UnexpectedTypeException;
  11. use Symfony\Component\PropertyAccess\PropertyAccess;
  12. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  14. class ArraySubscriber implements EventSubscriberInterface
  15. {
  16.     /**
  17.      * @var string the field used to sort current object array list
  18.      */
  19.     private string $currentSortingField;
  21.     /**
  22.      * @var string the sorting direction
  23.      */
  24.     private string $sortDirection;
  26.     private ?PropertyAccessorInterface $propertyAccessor;
  28.     private ArgumentAccessInterface $argumentAccess;
  30.     public function __construct(ArgumentAccessInterface $argumentAccess, PropertyAccessorInterface $accessor = null)
  31.     {
  32.         if (!$accessor && class_exists(PropertyAccess::class)) {
  33.             $accessor = PropertyAccess::createPropertyAccessorBuilder()->enableMagicCall()->getPropertyAccessor();
  34.         }
  36.         $this->propertyAccessor = $accessor;
  37.         $this->argumentAccess = $argumentAccess;
  38.     }
  40.     public function items(ItemsEvent $event): void
  41.     {
  42.         // Check if the result has already been sorted by another sort subscriber
  43.         $customPaginationParameters = $event->getCustomPaginationParameters();
  44.         if (!empty($customPaginationParameters['sorted']) ) {
  45.             return;
  46.         }
  47.         $sortField = $event->options[PaginatorInterface::SORT_FIELD_PARAMETER_NAME];
  48.         if (!is_array($event->target) || null === $sortField || !$this->argumentAccess->has($sortField)) {
  49.             return;
  50.         }
  52.         $event->setCustomPaginationParameter('sorted', true);
  54.         if (isset($event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST]) && !in_array($this->argumentAccess->get($sortField), $event->options[PaginatorInterface::SORT_FIELD_ALLOW_LIST])) {
  55.             throw new InvalidValueException("Cannot sort by: [{$this->argumentAccess->get($sortField)}] this field is not in allow list.");
  56.         }
  58.         $sortFunction = $event->options['sortFunction'] ?? [$this, 'proxySortFunction'];
  59.         $sortField = $this->argumentAccess->get($sortField);
  61.         // compatibility layer
  62.         if ($sortField[0] === '.') {
  63.             $sortField = substr($sortField, 1);
  64.         }
  66.         call_user_func_array($sortFunction, [
  67.             &$event->target,
  68.             $sortField,
  69.             $this->getSortDirection($event->options),
  70.         ]);
  71.     }
  73.     /**
  74.      * @param array<string, mixed> $options
  75.      */
  76.     private function getSortDirection(array $options): string
  77.     {
  78.         if (!$this->argumentAccess->has($options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME])) {
  79.             return 'desc';
  80.         }
  81.         $direction = $this->argumentAccess->get($options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME]);
  82.         if (strtolower($direction) === 'asc') {
  83.             return 'asc';
  84.         }
  86.         return 'desc';
  87.     }
  89.     private function proxySortFunction(mixed &$target, string $sortField, string $sortDirection): bool
  90.     {
  91.         $this->currentSortingField = $sortField;
  92.         $this->sortDirection = $sortDirection;
  94.         return usort($target, [$this, 'sortFunction']);
  95.     }
  97.     private function sortFunction(object|array $object1, object|array $object2): int
  98.     {
  99.         if (null === $this->propertyAccessor) {
  100.             throw new \UnexpectedValueException('You need symfony/property-access component to use this sorting function');
  101.         }
  103.         if (!$this->propertyAccessor->isReadable($object1, $this->currentSortingField) || !$this->propertyAccessor->isReadable($object2, $this->currentSortingField)) {
  104.             return 0;
  105.         }
  107.         try {
  108.             $fieldValue1 = $this->propertyAccessor->getValue($object1, $this->currentSortingField);
  109.         } catch (UnexpectedTypeException) {
  110.             return -1 * $this->getSortCoefficient();
  111.         }
  113.         try {
  114.             $fieldValue2 = $this->propertyAccessor->getValue($object2, $this->currentSortingField);
  115.         } catch (UnexpectedTypeException) {
  116.             return $this->getSortCoefficient();
  117.         }
  119.         if (is_string($fieldValue1)) {
  120.             $fieldValue1 = mb_strtolower($fieldValue1);
  121.         }
  123.         if (is_string($fieldValue2)) {
  124.             $fieldValue2 = mb_strtolower($fieldValue2);
  125.         }
  127.         if ($fieldValue1 === $fieldValue2) {
  128.             return 0;
  129.         }
  131.         return ($fieldValue1 > $fieldValue2 ? 1 : -1) * $this->getSortCoefficient();
  132.     }
  134.     private function getSortCoefficient(): int
  135.     {
  136.         return $this->sortDirection === 'asc' ? 1 : -1;
  137.     }
  139.     public static function getSubscribedEvents(): array
  140.     {
  141.         return [
  142.             'knp_pager.items' => ['items', 1],
  143.         ];
  144.     }
  145. }