-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathArrayReader.php
More file actions
380 lines (324 loc) · 8.59 KB
/
ArrayReader.php
File metadata and controls
380 lines (324 loc) · 8.59 KB
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
<?php
namespace Selective\ArrayReader;
use Cake\Chronos\Chronos;
use InvalidArgumentException;
/**
* A typed array reader.
*/
final class ArrayReader
{
/**
* @var array<mixed>
*/
private array $data;
/**
* The constructor.
*
* @param array<mixed> $data Data
*/
public function __construct(array $data = [])
{
$this->data = $data;
}
/**
* Crate instance from array.
*
* @param array<mixed> $data The data
*
* @return self The new instance
*/
public static function createFromArray(array $data = []): self
{
return new static($data);
}
/**
* Get value as integer.
*
* @param string $key The key
* @param int|null $default The default value
*
* @throws InvalidArgumentException
*
* @return int The value
*/
public function getInt(string $key, ?int $default = null): int
{
$value = $this->find($key, $default);
if ($this->isNullOrBlank($value)) {
throw new InvalidArgumentException(sprintf('No value found for key "%s"', $key));
}
return (int)$value;
}
/**
* Get value as integer or null.
*
* @param string $key The key
* @param int|null $default The default value
*
* @return int|null The value
*/
public function findInt(string $key, ?int $default = null): ?int
{
$value = $this->find($key, $default);
if ($this->isNullOrBlank($value)) {
return null;
}
return (int)$value;
}
/**
* Get value as string.
*
* @param string $key The key
* @param string|null $default The default value
*
* @throws InvalidArgumentException
*
* @return string The value
*/
public function getString(string $key, ?string $default = null): string
{
$value = $this->find($key, $default);
if ($value === null) {
throw new InvalidArgumentException(sprintf('No value found for key "%s"', $key));
}
return (string)$value;
}
/**
* Get value as string or null.
*
* @param string $key The key
* @param string|null $default The default value
*
* @return string|null The value
*/
public function findString(string $key, ?string $default = null): ?string
{
$value = $this->find($key, $default);
if ($value === null) {
return null;
}
return (string)$value;
}
/**
* Get value as array.
*
* @param string $key The key
* @param array<mixed>|null $default The default value
*
* @throws InvalidArgumentException
*
* @return array<mixed> The value
*/
public function getArray(string $key, ?array $default = null): array
{
$value = $this->find($key, $default);
if ($this->isNullOrBlank($value)) {
throw new InvalidArgumentException(sprintf('No value found for key "%s"', $key));
}
return (array)$value;
}
/**
* Get value as array or null.
*
* @param string $key The key
* @param array<mixed>|null $default The default value
*
* @return array<mixed>|null The value
*/
public function findArray(string $key, ?array $default = null): ?array
{
$value = $this->find($key, $default);
if ($this->isNullOrBlank($value)) {
return null;
}
return (array)$value;
}
/**
* Get value as float.
*
* @param string $key The key
* @param float|null $default The default value
*
* @throws InvalidArgumentException
*
* @return float The value
*/
public function getFloat(string $key, ?float $default = null): float
{
$value = $this->find($key, $default);
if ($this->isNullOrBlank($value)) {
throw new InvalidArgumentException(sprintf('No value found for key "%s"', $key));
}
return (float)$value;
}
/**
* Get value as float or null.
*
* @param string $key The key
* @param float|null $default The default value
*
* @return float|null The value
*/
public function findFloat(string $key, ?float $default = null): ?float
{
$value = $this->find($key, $default);
if ($this->isNullOrBlank($value)) {
return null;
}
return (float)$value;
}
/**
* Get value as boolean.
*
* @param string $key The key
* @param bool|null $default The default value
*
* @throws InvalidArgumentException
*
* @return bool The value
*/
public function getBool(string $key, ?bool $default = null): bool
{
$value = $this->find($key, $default);
if ($this->isNullOrBlank($value)) {
throw new InvalidArgumentException(sprintf('No value found for key "%s"', $key));
}
return (bool)$value;
}
/**
* Get value as boolean or null.
*
* @param string $key The key
* @param bool $default The default value
*
* @return bool|null The value
*/
public function findBool(string $key, ?bool $default = null): ?bool
{
$value = $this->find($key, $default);
if ($this->isNullOrBlank($value)) {
return null;
}
return (bool)$value;
}
/**
* Get value as Chronos.
*
* @param string $key The key
* @param Chronos|null $default The default value
*
* @throws InvalidArgumentException
*
* @return Chronos The value
*/
public function getChronos(string $key, ?Chronos $default = null): Chronos
{
$value = $this->find($key, $default);
if ($this->isNullOrBlank($value)) {
throw new InvalidArgumentException(sprintf('No value found for key "%s"', $key));
}
if ($value instanceof Chronos) {
return $value;
}
return new Chronos($value);
}
/**
* Get value as Chronos or null.
*
* @param string $key The key
* @param Chronos|null $default The default value
*
* @return Chronos|null The value
*/
public function findChronos(string $key, ?Chronos $default = null): ?Chronos
{
$value = $this->find($key, $default);
if ($this->isNullOrBlank($value)) {
return null;
}
if ($value instanceof Chronos) {
return $value;
}
return new Chronos($value);
}
/**
* Find mixed value.
*
* @param string $path The path
* @param mixed|null $default The default value
*
* @return mixed|null The value
*/
public function find(string $path, mixed $default = null): mixed
{
if (array_key_exists($path, $this->data)) {
return $this->data[$path] ?? $default;
}
if (!str_contains($path, '.')) {
return $default;
}
$pathKeys = explode('.', $path);
$arrayCopyOrValue = $this->data;
foreach ($pathKeys as $pathKey) {
if (!isset($arrayCopyOrValue[$pathKey])) {
return $default;
}
$arrayCopyOrValue = $arrayCopyOrValue[$pathKey];
}
return $arrayCopyOrValue;
}
/**
* Return all data as array.
*
* @return array<mixed> The data
*/
public function all(): array
{
return $this->data;
}
/**
* Test whether a given path exists in $data.
* This method uses the same path syntax as Hash::extract().
*
* Checking for paths that could target more than one element will
* make sure that at least one matching element exists.
*
* @param string $path The path to check for
*
* @return bool The existence of path
*/
public function exists(string $path): bool
{
$pathKeys = explode('.', $path);
$arrayCopyOrValue = $this->data;
foreach ($pathKeys as $pathKey) {
if (!array_key_exists($pathKey, $arrayCopyOrValue)) {
return false;
}
$arrayCopyOrValue = $arrayCopyOrValue[$pathKey];
}
return true;
}
/**
* Is empty.
*
* @param string $path The path
*
* @return bool Status
*/
public function isEmpty(string $path): bool
{
return empty($this->find($path));
}
/**
* Is null or blank.
*
* @param mixed $value The value
*
* @return bool The status
*/
private function isNullOrBlank(mixed $value): bool
{
return $value === null || $value === '';
}
}