SortingProcessor.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\Api\SearchCriteria\CollectionProcessor;

use Magento\Framework\Api\SearchCriteria\CollectionProcessorInterface;
use Magento\Framework\Api\SearchCriteriaInterface;
use Magento\Framework\Api\SortOrder;
use Magento\Framework\Data\Collection;
use Magento\Framework\Data\Collection\AbstractDb;

class SortingProcessor implements CollectionProcessorInterface
{
    private $fieldMapping;

    private $defaultOrders;

    public function __construct(
        array $fieldMapping = [],
        array $defaultOrders = []
    ) {
        $this->fieldMapping = $fieldMapping;
        $this->defaultOrders = $defaultOrders;
    }

    public function process(SearchCriteriaInterface $searchCriteria, AbstractDb $collection)
    {
        if ($searchCriteria->getSortOrders()) {
            $this->applyOrders($searchCriteria->getSortOrders(), $collection);
        } elseif ($this->defaultOrders) {
            $this->applyDefaultOrders($collection);
        }
    }

    private function getFieldMapping($field)
    {
        return $this->fieldMapping[$field] ?? $field;
    }

    private function applyOrders(array $sortOrders, AbstractDb $collection)
    {
        foreach ($sortOrders as $sortOrder) {
            $field = $this->getFieldMapping($sortOrder->getField());
            if (null !== $field) {
                $order = $sortOrder->getDirection() == SortOrder::SORT_ASC
                    ? Collection::SORT_ORDER_ASC
                    : Collection::SORT_ORDER_DESC;
                $collection->addOrder($field, $order);
            }
        }
    }

    private function applyDefaultOrders(AbstractDb $collection)
    {
        foreach ($this->defaultOrders as $field => $direction) {
            $field = $this->getFieldMapping($field);
            if (null !== $field) {
                $order = $direction == SortOrder::SORT_ASC
                    ? Collection::SORT_ORDER_ASC
                    : Collection::SORT_ORDER_DESC;
                $collection->addOrder($field, $order);
            }
        }
    }
}