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
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
|
<?php namespace Illuminate\Support;
use Closure; use Countable; use ArrayAccess; use ArrayIterator; use CachingIterator; use IteratorAggregate; use Illuminate\Support\Contracts\JsonableInterface; use Illuminate\Support\Contracts\ArrayableInterface;
class Collection implements ArrayAccess, ArrayableInterface, Countable, IteratorAggregate, JsonableInterface {
/** * The items contained in the collection. * * @var array */ protected $items = array();
/** * Create a new collection. * * @param array $items * @return void */ public function __construct(array $items = array()) { $this->items = $items; }
/** * Create a new collection instance if the value isn't one already. * * @param mixed $items * @return \Illuminate\Support\Collection */ public static function make($items) { if (is_null($items)) return new static;
if ($items instanceof Collection) return $items;
return new static(is_array($items) ? $items : array($items)); }
/** * Get all of the items in the collection. * * @return array */ public function all() { return $this->items; }
/** * Collapse the collection items into a single array. * * @return \Illuminate\Support\Collection */ public function collapse() { $results = array();
foreach ($this->items as $values) { $results = array_merge($results, $values); }
return new static($results); }
/** * Diff the collection with the given items. * * @param \Illuminate\Support\Collection|\Illuminate\Support\Contracts\ArrayableInterface|array $items * @return \Illuminate\Support\Collection */ public function diff($items) { return new static(array_diff($this->items, $this->getArrayableItems($items))); }
/** * Execute a callback over each item. * * @param Closure $callback * @return \Illuminate\Support\Collection */ public function each(Closure $callback) { array_map($callback, $this->items);
return $this; }
/** * Fetch a nested element of the collection. * * @param string $key * @return \Illuminate\Support\Collection */ public function fetch($key) { return new static(array_fetch($this->items, $key)); }
/** * Run a filter over each of the items. * * @param Closure $callback * @return \Illuminate\Support\Collection */ public function filter(Closure $callback) { return new static(array_filter($this->items, $callback)); }
/** * Get the first item from the collection. * * @param \Closure $callback * @param mixed $default * @return mixed|null */ public function first(Closure $callback = null, $default = null) { if (is_null($callback)) { return count($this->items) > 0 ? reset($this->items) : null; } else { return array_first($this->items, $callback, $default); } }
/** * Get a flattened array of the items in the collection. * * @return array */ public function flatten() { return new static(array_flatten($this->items)); }
/** * Remove an item from the collection by key. * * @param mixed $key * @return void */ public function forget($key) { unset($this->items[$key]); }
/** * Get an item from the collection by key. * * @param mixed $key * @param mixed $default * @return mixed */ public function get($key, $default = null) { if (array_key_exists($key, $this->items)) { return $this->items[$key]; }
return value($default); }
/** * Group an associative array by a field or Closure value. * * @param callable|string $groupBy * @return \Illuminate\Support\Collection */ public function groupBy($groupBy) { $results = array();
foreach ($this->items as $key => $value) { $key = is_callable($groupBy) ? $groupBy($value, $key) : data_get($value, $groupBy);
$results[$key][] = $value; }
return new static($results); }
/** * Determine if an item exists in the collection by key. * * @param mixed $key * @return bool */ public function has($key) { return array_key_exists($key, $this->items); }
/** * Concatenate values of a given key as a string. * * @param string $value * @param string $glue * @return string */ public function implode($value, $glue = null) { if (is_null($glue)) return implode($this->lists($value));
return implode($glue, $this->lists($value)); }
/** * Intersect the collection with the given items. * * @param \Illuminate\Support\Collection|\Illuminate\Support\Contracts\ArrayableInterface|array $items * @return \Illuminate\Support\Collection */ public function intersect($items) { return new static(array_intersect($this->items, $this->getArrayableItems($items))); }
/** * Determine if the collection is empty or not. * * @return bool */ public function isEmpty() { return empty($this->items); }
/** * Get the last item from the collection. * * @return mixed|null */ public function last() { return count($this->items) > 0 ? end($this->items) : null; }
/** * Get an array with the values of a given key. * * @param string $value * @param string $key * @return array */ public function lists($value, $key = null) { return array_pluck($this->items, $value, $key); }
/** * Run a map over each of the items. * * @param Closure $callback * @return \Illuminate\Support\Collection */ public function map(Closure $callback) { return new static(array_map($callback, $this->items, array_keys($this->items))); }
/** * Merge the collection with the given items. * * @param \Illuminate\Support\Collection|\Illuminate\Support\Contracts\ArrayableInterface|array $items * @return \Illuminate\Support\Collection */ public function merge($items) { return new static(array_merge($this->items, $this->getArrayableItems($items))); }
/** * Get and remove the last item from the collection. * * @return mixed|null */ public function pop() { return array_pop($this->items); }
/** * Push an item onto the beginning of the collection. * * @param mixed $value * @return void */ public function prepend($value) { array_unshift($this->items, $value); }
/** * Push an item onto the end of the collection. * * @param mixed $value * @return void */ public function push($value) { $this->items[] = $value; }
/** * Pulls an item from the collection. * * @param mixed $key * @param mixed $default * @return mixed */ public function pull($key, $default = null) { return array_pull($this->items, $key, $default); }
/** * Put an item in the collection by key. * * @param mixed $key * @param mixed $value * @return void */ public function put($key, $value) { $this->items[$key] = $value; }
/** * Reduce the collection to a single value. * * @param callable $callback * @param mixed $initial * @return mixed */ public function reduce($callback, $initial = null) { return array_reduce($this->items, $callback, $initial); }
/** * Get one or more items randomly from the collection. * * @param int $amount * @return mixed */ public function random($amount = 1) { $keys = array_rand($this->items, $amount);
return is_array($keys) ? array_intersect_key($this->items, array_flip($keys)) : $this->items[$keys]; }
/** * Reverse items order. * * @return \Illuminate\Support\Collection */ public function reverse() { return new static(array_reverse($this->items)); }
/** * Get and remove the first item from the collection. * * @return mixed|null */ public function shift() { return array_shift($this->items); }
/** * Slice the underlying collection array. * * @param int $offset * @param int $length * @param bool $preserveKeys * @return \Illuminate\Support\Collection */ public function slice($offset, $length = null, $preserveKeys = false) { return new static(array_slice($this->items, $offset, $length, $preserveKeys)); }
/** * Chunk the underlying collection array. * * @param int $size * @param bool $preserveKeys * @return \Illuminate\Support\Collection */ public function chunk($size, $preserveKeys = false) { $chunks = new static;
foreach (array_chunk($this->items, $size, $preserveKeys) as $chunk) { $chunks->push(new static($chunk)); }
return $chunks; }
/** * Sort through each item with a callback. * * @param Closure $callback * @return \Illuminate\Support\Collection */ public function sort(Closure $callback) { uasort($this->items, $callback);
return $this; }
/** * Sort the collection using the given Closure. * * @param \Closure|string $callback * @param int $options * @param bool $descending * @return \Illuminate\Support\Collection */ public function sortBy($callback, $options = SORT_REGULAR, $descending = false) { $results = array();
if (is_string($callback)) $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); }
$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]; }
$this->items = $results;
return $this; }
/** * Sort the collection in descending order using the given Closure. * * @param \Closure|string $callback * @param int $options * @return \Illuminate\Support\Collection */ public function sortByDesc($callback, $options = SORT_REGULAR) { return $this->sortBy($callback, $options, true); }
/** * Splice portion of the underlying collection array. * * @param int $offset * @param int $length * @param mixed $replacement * @return \Illuminate\Support\Collection */ public function splice($offset, $length = 0, $replacement = array()) { return new static(array_splice($this->items, $offset, $length, $replacement)); }
/** * Get the sum of the given values. * * @param \Closure $callback * @param string $callback * @return mixed */ public function sum($callback) { if (is_string($callback)) { $callback = $this->valueRetriever($callback); }
return $this->reduce(function($result, $item) use ($callback) { return $result += $callback($item);
}, 0); }
/** * Take the first or last {$limit} items. * * @param int $limit * @return \Illuminate\Support\Collection */ public function take($limit = null) { if ($limit < 0) return $this->slice($limit, abs($limit));
return $this->slice(0, $limit); }
/** * Transform each item in the collection using a callback. * * @param Closure $callback * @return \Illuminate\Support\Collection */ public function transform(Closure $callback) { $this->items = array_map($callback, $this->items);
return $this; }
/** * Return only unique items from the collection array. * * @return \Illuminate\Support\Collection */ public function unique() { return new static(array_unique($this->items)); }
/** * Reset the keys on the underlying array. * * @return \Illuminate\Support\Collection */ public function values() { $this->items = array_values($this->items);
return $this; }
/** * Get a value retrieving callback. * * @param string $value * @return \Closure */ protected function valueRetriever($value) { return function($item) use ($value) { return data_get($item, $value); }; }
/** * Get the collection of items as a plain array. * * @return array */ public function toArray() { return array_map(function($value) { return $value instanceof ArrayableInterface ? $value->toArray() : $value;
}, $this->items); }
/** * Get the collection of items as JSON. * * @param int $options * @return string */ public function toJson($options = 0) { return json_encode($this->toArray(), $options); }
/** * Get an iterator for the items. * * @return ArrayIterator */ public function getIterator() { return new ArrayIterator($this->items); }
/** * Get a CachingIterator instance. * * @return \CachingIterator */ public function getCachingIterator($flags = CachingIterator::CALL_TOSTRING) { return new CachingIterator($this->getIterator(), $flags); }
/** * Count the number of items in the collection. * * @return int */ public function count() { return count($this->items); }
/** * Determine if an item exists at an offset. * * @param mixed $key * @return bool */ public function offsetExists($key) { return array_key_exists($key, $this->items); }
/** * Get an item at a given offset. * * @param mixed $key * @return mixed */ public function offsetGet($key) { return $this->items[$key]; }
/** * Set the item at a given offset. * * @param mixed $key * @param mixed $value * @return void */ public function offsetSet($key, $value) { if (is_null($key)) { $this->items[] = $value; } else { $this->items[$key] = $value; } }
/** * Unset the item at a given offset. * * @param string $key * @return void */ public function offsetUnset($key) { unset($this->items[$key]); }
/** * Convert the collection to its string representation. * * @return string */ public function __toString() { return $this->toJson(); }
/** * Results array of items from Collection or ArrayableInterface. * * @param \Illuminate\Support\Collection|\Illuminate\Support\Contracts\ArrayableInterface|array $items * @return array */ private function getArrayableItems($items) { if ($items instanceof Collection) { $items = $items->all(); } elseif ($items instanceof ArrayableInterface) { $items = $items->toArray(); }
return $items; }
}
|