1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Api;
use Magento\Framework\Exception\InputException;
use Magento\Framework\Phrase;
/**
* Data object for sort order.
*
* @api
* @since 100.0.2
*/
class SortOrder extends AbstractSimpleObject
{
const FIELD = 'field';
const DIRECTION = 'direction';
const SORT_ASC = 'ASC';
const SORT_DESC = 'DESC';
/**
* Initialize object and validate sort direction
*
* @param array $data
* @throws InputException
*/
public function __construct(array $data = [])
{
parent::__construct($data);
if (null !== $this->getDirection()) {
$this->validateDirection($this->getDirection());
}
if ($this->getField() !== null) {
$this->validateField($this->getField());
}
}
/**
* Get sorting field.
*
* @return string
*/
public function getField()
{
return $this->_get(SortOrder::FIELD);
}
/**
* Set sorting field.
*
* @param string $field
* @throws InputException
*
* @return $this
*/
public function setField($field)
{
$this->validateField($field);
return $this->setData(SortOrder::FIELD, $field);
}
/**
* Get sorting direction.
*
* @return string
*/
public function getDirection()
{
return $this->_get(SortOrder::DIRECTION);
}
/**
* Set sorting direction.
*
* @param string $direction
* @throws InputException
*
* @return $this
*/
public function setDirection($direction)
{
$this->validateDirection($direction);
return $this->setData(SortOrder::DIRECTION, $this->normalizeDirectionInput($direction));
}
/**
* Validate direction argument ASC or DESC
*
* @param mixed $direction
* @return void
* @throws InputException
*/
private function validateDirection($direction): void
{
$this->validateDirectionIsString($direction);
$this->validateDirectionIsAscOrDesc($direction);
}
/**
* @param string $direction
* @throws InputException
* @return void
*/
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)]
));
}
}
/**
* @param string $direction
* @throws InputException
* @return void
*/
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]
));
}
}
/**
* @param string $direction
* @return string
*/
private function normalizeDirectionInput($direction)
{
return strtoupper($direction);
}
/**
* Check if given value can be used as sorting field.
*
* @param string $field
* @return void
* @throws InputException
*/
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]
)
);
}
}
}