SortOrder Class Reference

Inheritance diagram for SortOrder:

Public Member Functions
	__construct (array $data=[])
	getField ()
	setField ($field)
	getDirection ()
	setDirection ($direction)
Public Member Functions inherited from AbstractSimpleObject
	__construct (array $data=[])
	setData ($key, $value)
	__toArray ()

Data Fields
const	FIELD = 'field'
const	DIRECTION = 'direction'
const	SORT_ASC = 'ASC'
const	SORT_DESC = 'DESC'

Additional Inherited Members
Protected Member Functions inherited from AbstractSimpleObject
	_get ($key)
Protected Attributes inherited from AbstractSimpleObject
	$_data

Detailed Description

Data object for sort order.

@api

Definition at line 17 of file SortOrder.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$data = []

)

Initialize object and validate sort direction

Parameters

array

$data

Exceptions

InputException

Definition at line 30 of file SortOrder.php.

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

Member Function Documentation

getDirection()

getDirection

(

)

Get sorting direction.

Returns

string

Definition at line 71 of file SortOrder.php.

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

getField()

getField

(

)

Get sorting field.

Returns

string

Definition at line 46 of file SortOrder.php.

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

setDirection()

setDirection

(

$direction

)

Set sorting direction.

Parameters

string

$direction

Exceptions

InputException

Returns

$this

Definition at line 84 of file SortOrder.php.

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

setField()

setField

(

$field

)

Set sorting field.

Parameters

string

$field

Exceptions

InputException

Returns

$this

Definition at line 59 of file SortOrder.php.

    {
        $this->validateField($field);

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

Field Documentation

DIRECTION

const DIRECTION = 'direction'

Definition at line 20 of file SortOrder.php.

FIELD

const FIELD = 'field'

Definition at line 19 of file SortOrder.php.

SORT_ASC

const SORT_ASC = 'ASC'

Definition at line 21 of file SortOrder.php.

SORT_DESC

const SORT_DESC = 'DESC'

Definition at line 22 of file SortOrder.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Api/SortOrder.php