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

Open in your IDE?
  1. <?php
  3. namespace Knp\Component\Pager\Event\Subscriber\Sortable;
  5. use Knp\Component\Pager\Event\ItemsEvent;
  6. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  7. use Symfony\Component\PropertyAccess\Exception\UnexpectedTypeException;
  8. use Symfony\Component\PropertyAccess\PropertyAccess;
  9. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  10. use Knp\Component\Pager\PaginatorInterface;
  12. class ArraySubscriber implements EventSubscriberInterface
  13. {
  14.     /**
  15.      * @var string the field used to sort current object array list
  16.      */
  17.     private $currentSortingField;
  19.     /**
  20.      * @var string the sorting direction
  21.      */
  22.     private $sortDirection;
  24.     /**
  25.      * @var PropertyAccessorInterface
  26.      */
  27.     private $propertyAccessor;
  29.     public function __construct(PropertyAccessorInterface $accessor = null)
  30.     {
  31.         if (!$accessor && class_exists('Symfony\Component\PropertyAccess\PropertyAccess')) {
  32.             $accessor = PropertyAccess::createPropertyAccessorBuilder()->enableMagicCall()->getPropertyAccessor();
  33.         }
  35.         $this->propertyAccessor = $accessor;
  36.     }
  38.     public function items(ItemsEvent $event)
  39.     {
  40.         // Check if the result has already been sorted by an other sort subscriber
  41.         $customPaginationParameters = $event->getCustomPaginationParameters();
  42.         if (!empty($customPaginationParameters['sorted']) ) {
  43.             return;
  44.         }
  46.         if (!is_array($event->target) || empty($_GET[$event->options[PaginatorInterface::SORT_FIELD_PARAMETER_NAME]])) {
  47.             return;
  48.         }
  50.         $event->setCustomPaginationParameter('sorted', true);
  52.         if (isset($event->options[PaginatorInterface::SORT_FIELD_WHITELIST]) && !in_array($_GET[$event->options[PaginatorInterface::SORT_FIELD_PARAMETER_NAME]], $event->options[PaginatorInterface::SORT_FIELD_WHITELIST])) {
  53.             throw new \UnexpectedValueException("Cannot sort by: [{$_GET[$event->options[PaginatorInterface::SORT_FIELD_PARAMETER_NAME]]}] this field is not in whitelist");
  54.         }
  56.         $sortFunction = isset($event->options['sortFunction']) ? $event->options['sortFunction'] : array($this, 'proxySortFunction');
  57.         $sortField = $_GET[$event->options[PaginatorInterface::SORT_FIELD_PARAMETER_NAME]];
  59.         // compatibility layer
  60.         if ($sortField[0] === '.') {
  61.             $sortField = substr($sortField, 1);
  62.         }
  64.         call_user_func_array($sortFunction, array(
  65.             &$event->target,
  66.             $sortField,
  67.             isset($_GET[$event->options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME]]) && strtolower($_GET[$event->options[PaginatorInterface::SORT_DIRECTION_PARAMETER_NAME]]) === 'asc' ? 'asc' : 'desc'
  68.         ));
  69.     }
  71.     private function proxySortFunction(&$target, $sortField, $sortDirection) {
  72.         $this->currentSortingField = $sortField;
  73.         $this->sortDirection = $sortDirection;
  75.         return usort($target, array($this, 'sortFunction'));
  76.     }
  78.     /**
  79.      * @param mixed $object1 first object to compare
  80.      * @param mixed $object2 second object to compare
  81.      *
  82.      * @return int
  83.      */
  84.     private function sortFunction($object1, $object2)
  85.     {
  86.         if (!$this->propertyAccessor) {
  87.             throw new \UnexpectedValueException('You need symfony/property-access component to use this sorting function');
  88.         }
  90.         try {
  91.             $fieldValue1 = $this->propertyAccessor->getValue($object1, $this->currentSortingField);
  92.         } catch (UnexpectedTypeException $e) {
  93.             return -1 * $this->getSortCoefficient();
  94.         }
  96.         try {
  97.             $fieldValue2 = $this->propertyAccessor->getValue($object2, $this->currentSortingField);
  98.         } catch (UnexpectedTypeException $e) {
  99.             return 1 * $this->getSortCoefficient();
  100.         }
  102.         if (is_string($fieldValue1)) {
  103.             $fieldValue1 = mb_strtolower($fieldValue1);
  104.         }
  106.         if (is_string($fieldValue2)) {
  107.             $fieldValue2 = mb_strtolower($fieldValue2);
  108.         }
  110.         if ($fieldValue1 === $fieldValue2) {
  111.             return 0;
  112.         }
  114.         return ($fieldValue1 > $fieldValue2 ? 1 : -1) * $this->getSortCoefficient();
  115.     }
  117.     private function getSortCoefficient()
  118.     {
  119.         return $this->sortDirection === 'asc' ? 1 : -1;
  120.     }
  122.     public static function getSubscribedEvents()
  123.     {
  124.         return array(
  125.             'knp_pager.items' => array('items', 1)
  126.         );
  127.     }
  128. }