This repository has been archived by the owner on Jan 2, 2023. It is now read-only.
/
Parameters.php
210 lines (176 loc) · 4.34 KB
/
Parameters.php
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
<?php
/*
* This file is part of JSON-API.
*
* (c) Toby Zerner <toby.zerner@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Tobscure\JsonApi;
use Tobscure\JsonApi\Exception\InvalidParameterException;
class Parameters
{
/**
* @var array
*/
protected $input;
/**
* @param array $input
*/
public function __construct(array $input)
{
$this->input = $input;
}
/**
* Get the includes.
*
* @param array $available
*
* @throws \Tobscure\JsonApi\Exception\InvalidParameterException
*
* @return array
*/
public function getInclude(array $available = [])
{
if ($include = $this->getInput('include')) {
$relationships = explode(',', $include);
$invalid = array_diff($relationships, $available);
if (count($invalid)) {
throw new InvalidParameterException('Invalid includes ['.implode(',', $invalid).']');
}
return $relationships;
}
return [];
}
/**
* Get number of offset.
*
* @param int|null $perPage
*
* @throws \Tobscure\JsonApi\Exception\InvalidParameterException
*
* @return int
*/
public function getOffset($perPage = null)
{
if ($perPage && ($offset = $this->getOffsetFromNumber($perPage))) {
return $offset;
}
$offset = (int) $this->getPage('offset');
if ($offset < 0) {
throw new InvalidParameterException('page[offset] must be >=0');
}
return $offset;
}
/**
* Calculate the offset based on the page[number] parameter.
*
* @param int $perPage
*
* @throws \Tobscure\JsonApi\Exception\InvalidParameterException
*
* @return int
*/
protected function getOffsetFromNumber($perPage)
{
$page = (int) $this->getPage('number');
if ($page <= 1) {
return 0;
}
return ($page - 1) * $perPage;
}
/**
* Get the limit.
*
* @param int|null $max
*
* @return int|null
*/
public function getLimit($max = null)
{
$limit = $this->getPage('limit') ?: $this->getPage('size') ?: null;
if ($limit && $max) {
$limit = min($max, $limit);
}
return $limit;
}
/**
* Get the sort.
*
* @param array $available
*
* @throws \Tobscure\JsonApi\Exception\InvalidParameterException
*
* @return array
*/
public function getSort(array $available = [])
{
$sort = [];
if ($input = $this->getInput('sort')) {
$fields = explode(',', $input);
foreach ($fields as $field) {
if (substr($field, 0, 1) === '-') {
$field = substr($field, 1);
$order = 'desc';
} else {
$order = 'asc';
}
$sort[$field] = $order;
}
$invalid = array_diff(array_keys($sort), $available);
if (count($invalid)) {
throw new InvalidParameterException('Invalid sort fields ['.implode(',', $invalid).']');
}
}
return $sort;
}
/**
* Get the fields requested for inclusion.
*
* @return array
*/
public function getFields()
{
$fields = $this->getInput('fields');
if (! is_array($fields)) {
return [];
}
return array_map(function ($fields) {
return explode(',', $fields);
}, $fields);
}
/**
* Get a filter item.
*
* @return mixed
*/
public function getFilter()
{
return $this->getInput('filter');
}
/**
* Get an input item.
*
* @param string $key
* @param null $default
*
* @return mixed
*/
protected function getInput($key, $default = null)
{
return isset($this->input[$key]) ? $this->input[$key] : $default;
}
/**
* Get the page.
*
* @param string $key
*
* @return string
*/
protected function getPage($key)
{
$page = $this->getInput('page');
return isset($page[$key]) ? $page[$key] : '';
}
}