SortOrder.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\Api;

use Magento\Framework\Exception\InputException;
use Magento\Framework\Phrase;

class SortOrder extends AbstractSimpleObject
{
    const FIELD = 'field';
    const DIRECTION = 'direction';
    const SORT_ASC = 'ASC';
    const SORT_DESC = 'DESC';

    public function __construct(array $data = [])
    {
        parent::__construct($data);
        if (null !== $this->getDirection()) {
            $this->validateDirection($this->getDirection());
        }
        if ($this->getField() !== null) {
            $this->validateField($this->getField());
        }
    }

    public function getField()
    {
        return $this->_get(SortOrder::FIELD);
    }

    public function setField($field)
    {
        $this->validateField($field);

        return $this->setData(SortOrder::FIELD, $field);
    }

    public function getDirection()
    {
        return $this->_get(SortOrder::DIRECTION);
    }

    public function setDirection($direction)
    {
        $this->validateDirection($direction);
        return $this->setData(SortOrder::DIRECTION, $this->normalizeDirectionInput($direction));
    }

    private function validateDirection($direction): void
    {
        $this->validateDirectionIsString($direction);
        $this->validateDirectionIsAscOrDesc($direction);
    }

    private function validateDirectionIsString($direction): void
    {
        if (!is_string($direction)) {
            throw new InputException(new Phrase(
                'The sort order has to be specified as a string, got %1.',
                [gettype($direction)]
            ));
        }
    }

    private function validateDirectionIsAscOrDesc($direction): void
    {
        $normalizedDirection = $this->normalizeDirectionInput($direction);
        if (!in_array($normalizedDirection, [SortOrder::SORT_ASC, SortOrder::SORT_DESC], true)) {
            throw new InputException(new Phrase(
                'The sort order has to be specified as %1 for ascending order or %2 for descending order.',
                [SortOrder::SORT_ASC, SortOrder::SORT_DESC]
            ));
        }
    }

    private function normalizeDirectionInput($direction)
    {
        return strtoupper($direction);
    }

    private function validateField(string $field): void
    {
        if (preg_match('/[^a-z0-9\_]/i', $field)) {
            throw new InputException(
                new Phrase(
                    'Sort order field %1 contains restricted symbols',
                    [$field]
                )
            );
        }
    }
}