Collection.php
12.0 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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
<?php
declare(strict_types=1);
namespace Yansongda\Supports;
use ArrayAccess;
use ArrayIterator;
use Countable;
use IteratorAggregate;
use JsonSerializable;
use Yansongda\Supports\Traits\Accessable;
use Yansongda\Supports\Traits\Arrayable;
use Yansongda\Supports\Traits\Serializable;
class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSerializable
{
use Serializable;
use Accessable;
use Arrayable;
/**
* The collection data.
*/
protected array $items = [];
/**
* set data.
*
* @param mixed $items
*/
public function __construct($items = [])
{
foreach ($this->getArrayableItems($items) as $key => $value) {
$this->set($key, $value);
}
}
/**
* Wrap the given value in a collection if applicable.
*
* @param mixed $value
*/
public static function wrap($value): self
{
return $value instanceof self ? new static($value) : new static(Arr::wrap($value));
}
/**
* Get the underlying items from the given collection if applicable.
*
* @param array|static $value
*/
public static function unwrap($value): array
{
return $value instanceof self ? $value->all() : $value;
}
/**
* Return all items.
*/
public function all(): array
{
return $this->items;
}
/**
* Return specific items.
*/
public function only(array $keys): array
{
$return = [];
foreach ($keys as $key) {
$value = $this->get($key);
if (!is_null($value)) {
$return[$key] = $value;
}
}
return $return;
}
/**
* Get all items except for those with the specified keys.
*
* @param mixed $keys
*/
public function except($keys): self
{
$keys = is_array($keys) ? $keys : func_get_args();
return new static(Arr::except($this->items, $keys));
}
/**
* Run a filter over each of the items.
*/
public function filter(callable $callback = null): self
{
if ($callback) {
return new static(Arr::where($this->items, $callback));
}
return new static(array_filter($this->items));
}
/**
* Merge the collection with the given items.
*
* @param mixed $items
*/
public function merge($items): self
{
return new static(array_merge($this->items, $this->getArrayableItems($items)));
}
/**
* To determine Whether the specified element exists.
*
* @param string|int $key
*/
public function has($key): bool
{
return !is_null(Arr::get($this->items, $key));
}
/**
* Retrieve the first item.
*
* @return mixed
*/
public function first()
{
return reset($this->items);
}
/**
* Retrieve the last item.
*
* @return mixed
*/
public function last()
{
$end = end($this->items);
reset($this->items);
return $end;
}
/**
* add the item value.
*
* @param string|int|null $key
* @param mixed $value
*/
public function add($key, $value): void
{
Arr::set($this->items, $key, $value);
}
/**
* Set the item value.
*
* @param string|int|null $key
* @param mixed $value
*/
public function set($key, $value): void
{
Arr::set($this->items, $key, $value);
}
/**
* Retrieve item from Collection.
*
* @param string|int|null $key
* @param mixed $default
*
* @return mixed
*/
public function get($key = null, $default = null)
{
return Arr::get($this->items, $key, $default);
}
/**
* Remove item form Collection.
*
* @param string|int $key
*/
public function forget($key): void
{
Arr::forget($this->items, $key);
}
/**
* Get a flattened array of the items in the collection.
*
* @param float|int $depth
*/
public function flatten($depth = INF): self
{
return new static(Arr::flatten($this->items, $depth));
}
/**
* Run a map over each of the items.
*/
public function map(callable $callback): self
{
$keys = array_keys($this->items);
$items = array_map($callback, $this->items, $keys);
return new static(array_combine($keys, $items));
}
/**
* Get and remove the last item from the collection.
*
* @return mixed
*/
public function pop()
{
return array_pop($this->items);
}
/**
* Push an item onto the beginning of the collection.
*
* @param mixed|null $key
* @param mixed $value
*/
public function prepend($value, $key = null): self
{
$this->items = Arr::prepend($this->items, $value, $key);
return $this;
}
/**
* Push an item onto the end of the collection.
*
* @param mixed $value
*/
public function push($value): self
{
$this->offsetSet(null, $value);
return $this;
}
/**
* Get and remove an item from the collection.
*
* @param mixed $default
* @param mixed $key
*
* @return mixed
*/
public function pull($key, $default = null)
{
return Arr::pull($this->items, $key, $default);
}
/**
* Put an item in the collection by key.
*
* @param mixed $key
* @param mixed $value
*/
public function put($key, $value): self
{
$this->offsetSet($key, $value);
return $this;
}
/**
* Get one or a specified number of items randomly from the collection.
*
* @throws \InvalidArgumentException
*/
public function random(?int $number = null): self
{
return new static(Arr::random($this->items, $number ?? 1));
}
/**
* Reduce the collection to a single value.
*
* @param mixed|null $initial
*/
public function reduce(callable $callback, $initial = null)
{
return array_reduce($this->items, $callback, $initial);
}
/**
* Reset the keys on the underlying array.
*/
public function values(): self
{
return new static(array_values($this->items));
}
/**
* Determine if all items in the collection pass the given test.
*
* @param callable|string $key
*/
public function every($key): bool
{
$callback = $this->valueRetriever($key);
foreach ($this->items as $k => $v) {
if (!$callback($v, $k)) {
return false;
}
}
return true;
}
/**
* Chunk the underlying collection array.
*/
public function chunk(int $size): self
{
if ($size <= 0) {
return new static();
}
$chunks = [];
foreach (array_chunk($this->items, $size, true) as $chunk) {
$chunks[] = new static($chunk);
}
return new static($chunks);
}
/**
* Sort through each item with a callback.
*/
public function sort(callable $callback = null): self
{
$items = $this->items;
$callback ? uasort($items, $callback) : asort($items);
return new static($items);
}
/**
* Sort the collection using the given callback.
*
* @param callable|string $callback
*/
public function sortBy($callback, int $options = SORT_REGULAR, bool $descending = false): self
{
$results = [];
$callback = $this->valueRetriever($callback);
// First we will loop through the items and get the comparator from a callback
// function which we were given. Then, we will sort the returned values and
// and grab the corresponding values for the sorted keys from this array.
foreach ($this->items as $key => $value) {
$results[$key] = $callback($value, $key);
}
$descending ? arsort($results, $options) : asort($results, $options);
// Once we have sorted all of the keys in the array, we will loop through them
// and grab the corresponding model so we can set the underlying items list
// to the sorted version. Then we'll just return the collection instance.
foreach (array_keys($results) as $key) {
$results[$key] = $this->items[$key];
}
return new static($results);
}
/**
* Sort the collection in descending order using the given callback.
*
* @param callable|string $callback
*/
public function sortByDesc($callback, int $options = SORT_REGULAR): self
{
return $this->sortBy($callback, $options, true);
}
/**
* Sort the collection keys.
*/
public function sortKeys(int $options = SORT_REGULAR, bool $descending = false): self
{
$items = $this->items;
$descending ? krsort($items, $options) : ksort($items, $options);
return new static($items);
}
/**
* Sort the collection keys in descending order.
*/
public function sortKeysDesc(int $options = SORT_REGULAR): self
{
return $this->sortKeys($options, true);
}
public function query(int $encodingType = PHP_QUERY_RFC1738): string
{
return Arr::query($this->all(), $encodingType);
}
public function toString(string $separator = '&'): string
{
return Arr::toString($this->all(), $separator);
}
/**
* Build to array.
*/
public function toArray(): array
{
return $this->all();
}
/**
* Build to json.
*/
public function toJson(int $option = JSON_UNESCAPED_UNICODE): string
{
return json_encode($this->all(), $option);
}
/**
* (PHP 5 >= 5.0.0)<br/>
* Retrieve an external iterator.
*
* @see http://php.net/manual/en/iteratoraggregate.getiterator.php
*
* @return ArrayIterator An instance of an object implementing <b>Iterator</b> or
* <b>ArrayIterator</b>
*/
#[\ReturnTypeWillChange]
public function getIterator()
{
return new ArrayIterator($this->items);
}
/**
* (PHP 5 >= 5.1.0)<br/>
* Count elements of an object.
*
* @see http://php.net/manual/en/countable.count.php
*
* @return int The custom count as an integer.
* </p>
* <p>
* The return value is cast to an integer
*/
#[\ReturnTypeWillChange]
public function count()
{
return count($this->items);
}
/**
* (PHP 5 >= 5.0.0)<br/>
* Offset to unset.
*
* @see http://php.net/manual/en/arrayaccess.offsetunset.php
*
* @param mixed $offset <p>
* The offset to unset.
* </p>
*/
#[\ReturnTypeWillChange]
public function offsetUnset($offset)
{
if ($this->offsetExists($offset)) {
$this->forget($offset);
}
}
/**
* Determine if the given value is callable, but not a string.
*
* @param mixed $value
*/
protected function useAsCallable($value): bool
{
return !is_string($value) && is_callable($value);
}
/**
* Get a value retrieving callback.
*
* @param mixed $value
*/
protected function valueRetriever($value): callable
{
if ($this->useAsCallable($value)) {
return $value;
}
return function ($item) use ($value) {
return data_get($item, $value);
};
}
/**
* Results array of items from Collection or Arrayable.
*
* @param mixed $items
*/
protected function getArrayableItems($items): array
{
if (is_array($items)) {
return $items;
}
if ($items instanceof self) {
return $items->all();
}
if ($items instanceof JsonSerializable) {
return $items->jsonSerialize();
}
return (array) $items;
}
}