| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672 |
- <?php
- namespace Illuminate\Support;
- use ArrayAccess;
- use ArrayIterator;
- use Illuminate\Contracts\Support\CanBeEscapedWhenCastToString;
- use Illuminate\Support\Traits\EnumeratesValues;
- use Illuminate\Support\Traits\Macroable;
- use stdClass;
- class Collection implements ArrayAccess, CanBeEscapedWhenCastToString, Enumerable
- {
- use EnumeratesValues, Macroable;
- /**
- * The items contained in the collection.
- *
- * @var array
- */
- protected $items = [];
- /**
- * Create a new collection.
- *
- * @param mixed $items
- * @return void
- */
- public function __construct($items = [])
- {
- $this->items = $this->getArrayableItems($items);
- }
- /**
- * Create a collection with the given range.
- *
- * @param int $from
- * @param int $to
- * @return static
- */
- public static function range($from, $to)
- {
- return new static(range($from, $to));
- }
- /**
- * Get all of the items in the collection.
- *
- * @return array
- */
- public function all()
- {
- return $this->items;
- }
- /**
- * Get a lazy collection for the items in this collection.
- *
- * @return \Illuminate\Support\LazyCollection
- */
- public function lazy()
- {
- return new LazyCollection($this->items);
- }
- /**
- * Get the average value of a given key.
- *
- * @param callable|string|null $callback
- * @return mixed
- */
- public function avg($callback = null)
- {
- $callback = $this->valueRetriever($callback);
- $items = $this->map(function ($value) use ($callback) {
- return $callback($value);
- })->filter(function ($value) {
- return ! is_null($value);
- });
- if ($count = $items->count()) {
- return $items->sum() / $count;
- }
- }
- /**
- * Get the median of a given key.
- *
- * @param string|array|null $key
- * @return mixed
- */
- public function median($key = null)
- {
- $values = (isset($key) ? $this->pluck($key) : $this)
- ->filter(function ($item) {
- return ! is_null($item);
- })->sort()->values();
- $count = $values->count();
- if ($count === 0) {
- return;
- }
- $middle = (int) ($count / 2);
- if ($count % 2) {
- return $values->get($middle);
- }
- return (new static([
- $values->get($middle - 1), $values->get($middle),
- ]))->average();
- }
- /**
- * Get the mode of a given key.
- *
- * @param string|array|null $key
- * @return array|null
- */
- public function mode($key = null)
- {
- if ($this->count() === 0) {
- return;
- }
- $collection = isset($key) ? $this->pluck($key) : $this;
- $counts = new static;
- $collection->each(function ($value) use ($counts) {
- $counts[$value] = isset($counts[$value]) ? $counts[$value] + 1 : 1;
- });
- $sorted = $counts->sort();
- $highestValue = $sorted->last();
- return $sorted->filter(function ($value) use ($highestValue) {
- return $value == $highestValue;
- })->sort()->keys()->all();
- }
- /**
- * Collapse the collection of items into a single array.
- *
- * @return static
- */
- public function collapse()
- {
- return new static(Arr::collapse($this->items));
- }
- /**
- * Determine if an item exists in the collection.
- *
- * @param mixed $key
- * @param mixed $operator
- * @param mixed $value
- * @return bool
- */
- public function contains($key, $operator = null, $value = null)
- {
- if (func_num_args() === 1) {
- if ($this->useAsCallable($key)) {
- $placeholder = new stdClass;
- return $this->first($key, $placeholder) !== $placeholder;
- }
- return in_array($key, $this->items);
- }
- return $this->contains($this->operatorForWhere(...func_get_args()));
- }
- /**
- * Determine if an item is not contained in the collection.
- *
- * @param mixed $key
- * @param mixed $operator
- * @param mixed $value
- * @return bool
- */
- public function doesntContain($key, $operator = null, $value = null)
- {
- return ! $this->contains(...func_get_args());
- }
- /**
- * Cross join with the given lists, returning all possible permutations.
- *
- * @param mixed ...$lists
- * @return static
- */
- public function crossJoin(...$lists)
- {
- return new static(Arr::crossJoin(
- $this->items, ...array_map([$this, 'getArrayableItems'], $lists)
- ));
- }
- /**
- * Get the items in the collection that are not present in the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function diff($items)
- {
- return new static(array_diff($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Get the items in the collection that are not present in the given items, using the callback.
- *
- * @param mixed $items
- * @param callable $callback
- * @return static
- */
- public function diffUsing($items, callable $callback)
- {
- return new static(array_udiff($this->items, $this->getArrayableItems($items), $callback));
- }
- /**
- * Get the items in the collection whose keys and values are not present in the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function diffAssoc($items)
- {
- return new static(array_diff_assoc($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Get the items in the collection whose keys and values are not present in the given items, using the callback.
- *
- * @param mixed $items
- * @param callable $callback
- * @return static
- */
- public function diffAssocUsing($items, callable $callback)
- {
- return new static(array_diff_uassoc($this->items, $this->getArrayableItems($items), $callback));
- }
- /**
- * Get the items in the collection whose keys are not present in the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function diffKeys($items)
- {
- return new static(array_diff_key($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Get the items in the collection whose keys are not present in the given items, using the callback.
- *
- * @param mixed $items
- * @param callable $callback
- * @return static
- */
- public function diffKeysUsing($items, callable $callback)
- {
- return new static(array_diff_ukey($this->items, $this->getArrayableItems($items), $callback));
- }
- /**
- * Retrieve duplicate items from the collection.
- *
- * @param callable|string|null $callback
- * @param bool $strict
- * @return static
- */
- public function duplicates($callback = null, $strict = false)
- {
- $items = $this->map($this->valueRetriever($callback));
- $uniqueItems = $items->unique(null, $strict);
- $compare = $this->duplicateComparator($strict);
- $duplicates = new static;
- foreach ($items as $key => $value) {
- if ($uniqueItems->isNotEmpty() && $compare($value, $uniqueItems->first())) {
- $uniqueItems->shift();
- } else {
- $duplicates[$key] = $value;
- }
- }
- return $duplicates;
- }
- /**
- * Retrieve duplicate items from the collection using strict comparison.
- *
- * @param callable|string|null $callback
- * @return static
- */
- public function duplicatesStrict($callback = null)
- {
- return $this->duplicates($callback, true);
- }
- /**
- * Get the comparison function to detect duplicates.
- *
- * @param bool $strict
- * @return \Closure
- */
- protected function duplicateComparator($strict)
- {
- if ($strict) {
- return function ($a, $b) {
- return $a === $b;
- };
- }
- return function ($a, $b) {
- return $a == $b;
- };
- }
- /**
- * Get all items except for those with the specified keys.
- *
- * @param \Illuminate\Support\Collection|mixed $keys
- * @return static
- */
- public function except($keys)
- {
- if ($keys instanceof Enumerable) {
- $keys = $keys->all();
- } elseif (! is_array($keys)) {
- $keys = func_get_args();
- }
- return new static(Arr::except($this->items, $keys));
- }
- /**
- * Run a filter over each of the items.
- *
- * @param callable|null $callback
- * @return static
- */
- public function filter(callable $callback = null)
- {
- if ($callback) {
- return new static(Arr::where($this->items, $callback));
- }
- return new static(array_filter($this->items));
- }
- /**
- * Get the first item from the collection passing the given truth test.
- *
- * @param callable|null $callback
- * @param mixed $default
- * @return mixed
- */
- public function first(callable $callback = null, $default = null)
- {
- return Arr::first($this->items, $callback, $default);
- }
- /**
- * Get a flattened array of the items in the collection.
- *
- * @param int $depth
- * @return static
- */
- public function flatten($depth = INF)
- {
- return new static(Arr::flatten($this->items, $depth));
- }
- /**
- * Flip the items in the collection.
- *
- * @return static
- */
- public function flip()
- {
- return new static(array_flip($this->items));
- }
- /**
- * Remove an item from the collection by key.
- *
- * @param string|int|array $keys
- * @return $this
- */
- public function forget($keys)
- {
- foreach ((array) $keys as $key) {
- $this->offsetUnset($key);
- }
- return $this;
- }
- /**
- * 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);
- }
- /**
- * Get an item from the collection by key or add it to collection if it does not exist.
- *
- * @param mixed $key
- * @param mixed $value
- * @return mixed
- */
- public function getOrPut($key, $value)
- {
- if (array_key_exists($key, $this->items)) {
- return $this->items[$key];
- }
- $this->offsetSet($key, $value = value($value));
- return $value;
- }
- /**
- * Group an associative array by a field or using a callback.
- *
- * @param array|callable|string $groupBy
- * @param bool $preserveKeys
- * @return static
- */
- public function groupBy($groupBy, $preserveKeys = false)
- {
- if (! $this->useAsCallable($groupBy) && is_array($groupBy)) {
- $nextGroups = $groupBy;
- $groupBy = array_shift($nextGroups);
- }
- $groupBy = $this->valueRetriever($groupBy);
- $results = [];
- foreach ($this->items as $key => $value) {
- $groupKeys = $groupBy($value, $key);
- if (! is_array($groupKeys)) {
- $groupKeys = [$groupKeys];
- }
- foreach ($groupKeys as $groupKey) {
- $groupKey = is_bool($groupKey) ? (int) $groupKey : $groupKey;
- if (! array_key_exists($groupKey, $results)) {
- $results[$groupKey] = new static;
- }
- $results[$groupKey]->offsetSet($preserveKeys ? $key : null, $value);
- }
- }
- $result = new static($results);
- if (! empty($nextGroups)) {
- return $result->map->groupBy($nextGroups, $preserveKeys);
- }
- return $result;
- }
- /**
- * Key an associative array by a field or using a callback.
- *
- * @param callable|string $keyBy
- * @return static
- */
- public function keyBy($keyBy)
- {
- $keyBy = $this->valueRetriever($keyBy);
- $results = [];
- foreach ($this->items as $key => $item) {
- $resolvedKey = $keyBy($item, $key);
- if (is_object($resolvedKey)) {
- $resolvedKey = (string) $resolvedKey;
- }
- $results[$resolvedKey] = $item;
- }
- return new static($results);
- }
- /**
- * Determine if an item exists in the collection by key.
- *
- * @param mixed $key
- * @return bool
- */
- public function has($key)
- {
- $keys = is_array($key) ? $key : func_get_args();
- foreach ($keys as $value) {
- if (! array_key_exists($value, $this->items)) {
- return false;
- }
- }
- return true;
- }
- /**
- * Determine if any of the keys exist in the collection.
- *
- * @param mixed $key
- * @return bool
- */
- public function hasAny($key)
- {
- if ($this->isEmpty()) {
- return false;
- }
- $keys = is_array($key) ? $key : func_get_args();
- foreach ($keys as $value) {
- if ($this->has($value)) {
- return true;
- }
- }
- return false;
- }
- /**
- * Concatenate values of a given key as a string.
- *
- * @param string $value
- * @param string|null $glue
- * @return string
- */
- public function implode($value, $glue = null)
- {
- $first = $this->first();
- if (is_array($first) || (is_object($first) && ! $first instanceof Stringable)) {
- return implode($glue ?? '', $this->pluck($value)->all());
- }
- return implode($value ?? '', $this->items);
- }
- /**
- * Intersect the collection with the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function intersect($items)
- {
- return new static(array_intersect($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Intersect the collection with the given items by key.
- *
- * @param mixed $items
- * @return static
- */
- public function intersectByKeys($items)
- {
- return new static(array_intersect_key(
- $this->items, $this->getArrayableItems($items)
- ));
- }
- /**
- * Determine if the collection is empty or not.
- *
- * @return bool
- */
- public function isEmpty()
- {
- return empty($this->items);
- }
- /**
- * Determine if the collection contains a single item.
- *
- * @return bool
- */
- public function containsOneItem()
- {
- return $this->count() === 1;
- }
- /**
- * Join all items from the collection using a string. The final items can use a separate glue string.
- *
- * @param string $glue
- * @param string $finalGlue
- * @return string
- */
- public function join($glue, $finalGlue = '')
- {
- if ($finalGlue === '') {
- return $this->implode($glue);
- }
- $count = $this->count();
- if ($count === 0) {
- return '';
- }
- if ($count === 1) {
- return $this->last();
- }
- $collection = new static($this->items);
- $finalItem = $collection->pop();
- return $collection->implode($glue).$finalGlue.$finalItem;
- }
- /**
- * Get the keys of the collection items.
- *
- * @return static
- */
- public function keys()
- {
- return new static(array_keys($this->items));
- }
- /**
- * Get the last item from the collection.
- *
- * @param callable|null $callback
- * @param mixed $default
- * @return mixed
- */
- public function last(callable $callback = null, $default = null)
- {
- return Arr::last($this->items, $callback, $default);
- }
- /**
- * Get the values of a given key.
- *
- * @param string|array|int|null $value
- * @param string|null $key
- * @return static
- */
- public function pluck($value, $key = null)
- {
- return new static(Arr::pluck($this->items, $value, $key));
- }
- /**
- * Run a map over each of the items.
- *
- * @param callable $callback
- * @return static
- */
- public function map(callable $callback)
- {
- $keys = array_keys($this->items);
- $items = array_map($callback, $this->items, $keys);
- return new static(array_combine($keys, $items));
- }
- /**
- * Run a dictionary map over the items.
- *
- * The callback should return an associative array with a single key/value pair.
- *
- * @param callable $callback
- * @return static
- */
- public function mapToDictionary(callable $callback)
- {
- $dictionary = [];
- foreach ($this->items as $key => $item) {
- $pair = $callback($item, $key);
- $key = key($pair);
- $value = reset($pair);
- if (! isset($dictionary[$key])) {
- $dictionary[$key] = [];
- }
- $dictionary[$key][] = $value;
- }
- return new static($dictionary);
- }
- /**
- * Run an associative map over each of the items.
- *
- * The callback should return an associative array with a single key/value pair.
- *
- * @param callable $callback
- * @return static
- */
- public function mapWithKeys(callable $callback)
- {
- $result = [];
- foreach ($this->items as $key => $value) {
- $assoc = $callback($value, $key);
- foreach ($assoc as $mapKey => $mapValue) {
- $result[$mapKey] = $mapValue;
- }
- }
- return new static($result);
- }
- /**
- * Merge the collection with the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function merge($items)
- {
- return new static(array_merge($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Recursively merge the collection with the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function mergeRecursive($items)
- {
- return new static(array_merge_recursive($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Create a collection by using this collection for keys and another for its values.
- *
- * @param mixed $values
- * @return static
- */
- public function combine($values)
- {
- return new static(array_combine($this->all(), $this->getArrayableItems($values)));
- }
- /**
- * Union the collection with the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function union($items)
- {
- return new static($this->items + $this->getArrayableItems($items));
- }
- /**
- * Create a new collection consisting of every n-th element.
- *
- * @param int $step
- * @param int $offset
- * @return static
- */
- public function nth($step, $offset = 0)
- {
- $new = [];
- $position = 0;
- foreach ($this->slice($offset)->items as $item) {
- if ($position % $step === 0) {
- $new[] = $item;
- }
- $position++;
- }
- return new static($new);
- }
- /**
- * Get the items with the specified keys.
- *
- * @param mixed $keys
- * @return static
- */
- public function only($keys)
- {
- if (is_null($keys)) {
- return new static($this->items);
- }
- if ($keys instanceof Enumerable) {
- $keys = $keys->all();
- }
- $keys = is_array($keys) ? $keys : func_get_args();
- return new static(Arr::only($this->items, $keys));
- }
- /**
- * Get and remove the last N items from the collection.
- *
- * @param int $count
- * @return mixed
- */
- public function pop($count = 1)
- {
- if ($count === 1) {
- return array_pop($this->items);
- }
- if ($this->isEmpty()) {
- return new static;
- }
- $results = [];
- $collectionCount = $this->count();
- foreach (range(1, min($count, $collectionCount)) as $item) {
- array_push($results, array_pop($this->items));
- }
- return new static($results);
- }
- /**
- * Push an item onto the beginning of the collection.
- *
- * @param mixed $value
- * @param mixed $key
- * @return $this
- */
- public function prepend($value, $key = null)
- {
- $this->items = Arr::prepend($this->items, ...func_get_args());
- return $this;
- }
- /**
- * Push one or more items onto the end of the collection.
- *
- * @param mixed $values
- * @return $this
- */
- public function push(...$values)
- {
- foreach ($values as $value) {
- $this->items[] = $value;
- }
- return $this;
- }
- /**
- * Push all of the given items onto the collection.
- *
- * @param iterable $source
- * @return static
- */
- public function concat($source)
- {
- $result = new static($this);
- foreach ($source as $item) {
- $result->push($item);
- }
- return $result;
- }
- /**
- * Get and remove an item from the collection.
- *
- * @param mixed $key
- * @param mixed $default
- * @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
- * @return $this
- */
- public function put($key, $value)
- {
- $this->offsetSet($key, $value);
- return $this;
- }
- /**
- * Get one or a specified number of items randomly from the collection.
- *
- * @param int|null $number
- * @return static|mixed
- *
- * @throws \InvalidArgumentException
- */
- public function random($number = null)
- {
- if (is_null($number)) {
- return Arr::random($this->items);
- }
- return new static(Arr::random($this->items, $number));
- }
- /**
- * Replace the collection items with the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function replace($items)
- {
- return new static(array_replace($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Recursively replace the collection items with the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function replaceRecursive($items)
- {
- return new static(array_replace_recursive($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Reverse items order.
- *
- * @return static
- */
- public function reverse()
- {
- return new static(array_reverse($this->items, true));
- }
- /**
- * Search the collection for a given value and return the corresponding key if successful.
- *
- * @param mixed $value
- * @param bool $strict
- * @return mixed
- */
- public function search($value, $strict = false)
- {
- if (! $this->useAsCallable($value)) {
- return array_search($value, $this->items, $strict);
- }
- foreach ($this->items as $key => $item) {
- if ($value($item, $key)) {
- return $key;
- }
- }
- return false;
- }
- /**
- * Get and remove the first N items from the collection.
- *
- * @param int $count
- * @return mixed
- */
- public function shift($count = 1)
- {
- if ($count === 1) {
- return array_shift($this->items);
- }
- if ($this->isEmpty()) {
- return new static;
- }
- $results = [];
- $collectionCount = $this->count();
- foreach (range(1, min($count, $collectionCount)) as $item) {
- array_push($results, array_shift($this->items));
- }
- return new static($results);
- }
- /**
- * Shuffle the items in the collection.
- *
- * @param int|null $seed
- * @return static
- */
- public function shuffle($seed = null)
- {
- return new static(Arr::shuffle($this->items, $seed));
- }
- /**
- * Create chunks representing a "sliding window" view of the items in the collection.
- *
- * @param int $size
- * @param int $step
- * @return static
- */
- public function sliding($size = 2, $step = 1)
- {
- $chunks = floor(($this->count() - $size) / $step) + 1;
- return static::times($chunks, function ($number) use ($size, $step) {
- return $this->slice(($number - 1) * $step, $size);
- });
- }
- /**
- * Skip the first {$count} items.
- *
- * @param int $count
- * @return static
- */
- public function skip($count)
- {
- return $this->slice($count);
- }
- /**
- * Skip items in the collection until the given condition is met.
- *
- * @param mixed $value
- * @return static
- */
- public function skipUntil($value)
- {
- return new static($this->lazy()->skipUntil($value)->all());
- }
- /**
- * Skip items in the collection while the given condition is met.
- *
- * @param mixed $value
- * @return static
- */
- public function skipWhile($value)
- {
- return new static($this->lazy()->skipWhile($value)->all());
- }
- /**
- * Slice the underlying collection array.
- *
- * @param int $offset
- * @param int|null $length
- * @return static
- */
- public function slice($offset, $length = null)
- {
- return new static(array_slice($this->items, $offset, $length, true));
- }
- /**
- * Split a collection into a certain number of groups.
- *
- * @param int $numberOfGroups
- * @return static
- */
- public function split($numberOfGroups)
- {
- if ($this->isEmpty()) {
- return new static;
- }
- $groups = new static;
- $groupSize = floor($this->count() / $numberOfGroups);
- $remain = $this->count() % $numberOfGroups;
- $start = 0;
- for ($i = 0; $i < $numberOfGroups; $i++) {
- $size = $groupSize;
- if ($i < $remain) {
- $size++;
- }
- if ($size) {
- $groups->push(new static(array_slice($this->items, $start, $size)));
- $start += $size;
- }
- }
- return $groups;
- }
- /**
- * Split a collection into a certain number of groups, and fill the first groups completely.
- *
- * @param int $numberOfGroups
- * @return static
- */
- public function splitIn($numberOfGroups)
- {
- return $this->chunk(ceil($this->count() / $numberOfGroups));
- }
- /**
- * Get the first item in the collection, but only if exactly one item exists. Otherwise, throw an exception.
- *
- * @param mixed $key
- * @param mixed $operator
- * @param mixed $value
- * @return mixed
- *
- * @throws \Illuminate\Support\ItemNotFoundException
- * @throws \Illuminate\Support\MultipleItemsFoundException
- */
- public function sole($key = null, $operator = null, $value = null)
- {
- $filter = func_num_args() > 1
- ? $this->operatorForWhere(...func_get_args())
- : $key;
- $items = $this->when($filter)->filter($filter);
- if ($items->isEmpty()) {
- throw new ItemNotFoundException;
- }
- if ($items->count() > 1) {
- throw new MultipleItemsFoundException;
- }
- return $items->first();
- }
- /**
- * Get the first item in the collection but throw an exception if no matching items exist.
- *
- * @param mixed $key
- * @param mixed $operator
- * @param mixed $value
- * @return mixed
- *
- * @throws \Illuminate\Support\ItemNotFoundException
- */
- public function firstOrFail($key = null, $operator = null, $value = null)
- {
- $filter = func_num_args() > 1
- ? $this->operatorForWhere(...func_get_args())
- : $key;
- $placeholder = new stdClass();
- $item = $this->first($filter, $placeholder);
- if ($item === $placeholder) {
- throw new ItemNotFoundException;
- }
- return $item;
- }
- /**
- * Chunk the collection into chunks of the given size.
- *
- * @param int $size
- * @return static
- */
- public function chunk($size)
- {
- if ($size <= 0) {
- return new static;
- }
- $chunks = [];
- foreach (array_chunk($this->items, $size, true) as $chunk) {
- $chunks[] = new static($chunk);
- }
- return new static($chunks);
- }
- /**
- * Chunk the collection into chunks with a callback.
- *
- * @param callable $callback
- * @return static
- */
- public function chunkWhile(callable $callback)
- {
- return new static(
- $this->lazy()->chunkWhile($callback)->mapInto(static::class)
- );
- }
- /**
- * Sort through each item with a callback.
- *
- * @param callable|int|null $callback
- * @return static
- */
- public function sort($callback = null)
- {
- $items = $this->items;
- $callback && is_callable($callback)
- ? uasort($items, $callback)
- : asort($items, $callback ?? SORT_REGULAR);
- return new static($items);
- }
- /**
- * Sort items in descending order.
- *
- * @param int $options
- * @return static
- */
- public function sortDesc($options = SORT_REGULAR)
- {
- $items = $this->items;
- arsort($items, $options);
- return new static($items);
- }
- /**
- * Sort the collection using the given callback.
- *
- * @param callable|array|string $callback
- * @param int $options
- * @param bool $descending
- * @return static
- */
- public function sortBy($callback, $options = SORT_REGULAR, $descending = false)
- {
- if (is_array($callback) && ! is_callable($callback)) {
- return $this->sortByMany($callback);
- }
- $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
- // grab all 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 using multiple comparisons.
- *
- * @param array $comparisons
- * @return static
- */
- protected function sortByMany(array $comparisons = [])
- {
- $items = $this->items;
- usort($items, function ($a, $b) use ($comparisons) {
- foreach ($comparisons as $comparison) {
- $comparison = Arr::wrap($comparison);
- $prop = $comparison[0];
- $ascending = Arr::get($comparison, 1, true) === true ||
- Arr::get($comparison, 1, true) === 'asc';
- $result = 0;
- if (! is_string($prop) && is_callable($prop)) {
- $result = $prop($a, $b);
- } else {
- $values = [data_get($a, $prop), data_get($b, $prop)];
- if (! $ascending) {
- $values = array_reverse($values);
- }
- $result = $values[0] <=> $values[1];
- }
- if ($result === 0) {
- continue;
- }
- return $result;
- }
- });
- return new static($items);
- }
- /**
- * Sort the collection in descending order using the given callback.
- *
- * @param callable|string $callback
- * @param int $options
- * @return static
- */
- public function sortByDesc($callback, $options = SORT_REGULAR)
- {
- return $this->sortBy($callback, $options, true);
- }
- /**
- * Sort the collection keys.
- *
- * @param int $options
- * @param bool $descending
- * @return static
- */
- public function sortKeys($options = SORT_REGULAR, $descending = false)
- {
- $items = $this->items;
- $descending ? krsort($items, $options) : ksort($items, $options);
- return new static($items);
- }
- /**
- * Sort the collection keys in descending order.
- *
- * @param int $options
- * @return static
- */
- public function sortKeysDesc($options = SORT_REGULAR)
- {
- return $this->sortKeys($options, true);
- }
- /**
- * Sort the collection keys using a callback.
- *
- * @param callable $callback
- * @return static
- */
- public function sortKeysUsing(callable $callback)
- {
- $items = $this->items;
- uksort($items, $callback);
- return new static($items);
- }
- /**
- * Splice a portion of the underlying collection array.
- *
- * @param int $offset
- * @param int|null $length
- * @param mixed $replacement
- * @return static
- */
- public function splice($offset, $length = null, $replacement = [])
- {
- if (func_num_args() === 1) {
- return new static(array_splice($this->items, $offset));
- }
- return new static(array_splice($this->items, $offset, $length, $this->getArrayableItems($replacement)));
- }
- /**
- * Take the first or last {$limit} items.
- *
- * @param int $limit
- * @return static
- */
- public function take($limit)
- {
- if ($limit < 0) {
- return $this->slice($limit, abs($limit));
- }
- return $this->slice(0, $limit);
- }
- /**
- * Take items in the collection until the given condition is met.
- *
- * @param mixed $value
- * @return static
- */
- public function takeUntil($value)
- {
- return new static($this->lazy()->takeUntil($value)->all());
- }
- /**
- * Take items in the collection while the given condition is met.
- *
- * @param mixed $value
- * @return static
- */
- public function takeWhile($value)
- {
- return new static($this->lazy()->takeWhile($value)->all());
- }
- /**
- * Transform each item in the collection using a callback.
- *
- * @param callable $callback
- * @return $this
- */
- public function transform(callable $callback)
- {
- $this->items = $this->map($callback)->all();
- return $this;
- }
- /**
- * Convert a flatten "dot" notation array into an expanded array.
- *
- * @return static
- */
- public function undot()
- {
- return new static(Arr::undot($this->all()));
- }
- /**
- * Return only unique items from the collection array.
- *
- * @param string|callable|null $key
- * @param bool $strict
- * @return static
- */
- public function unique($key = null, $strict = false)
- {
- if (is_null($key) && $strict === false) {
- return new static(array_unique($this->items, SORT_REGULAR));
- }
- $callback = $this->valueRetriever($key);
- $exists = [];
- return $this->reject(function ($item, $key) use ($callback, $strict, &$exists) {
- if (in_array($id = $callback($item, $key), $exists, $strict)) {
- return true;
- }
- $exists[] = $id;
- });
- }
- /**
- * Reset the keys on the underlying array.
- *
- * @return static
- */
- public function values()
- {
- return new static(array_values($this->items));
- }
- /**
- * Zip the collection together with one or more arrays.
- *
- * e.g. new Collection([1, 2, 3])->zip([4, 5, 6]);
- * => [[1, 4], [2, 5], [3, 6]]
- *
- * @param mixed ...$items
- * @return static
- */
- public function zip($items)
- {
- $arrayableItems = array_map(function ($items) {
- return $this->getArrayableItems($items);
- }, func_get_args());
- $params = array_merge([function () {
- return new static(func_get_args());
- }, $this->items], $arrayableItems);
- return new static(array_map(...$params));
- }
- /**
- * Pad collection to the specified length with a value.
- *
- * @param int $size
- * @param mixed $value
- * @return static
- */
- public function pad($size, $value)
- {
- return new static(array_pad($this->items, $size, $value));
- }
- /**
- * Get an iterator for the items.
- *
- * @return \ArrayIterator
- */
- #[\ReturnTypeWillChange]
- public function getIterator()
- {
- return new ArrayIterator($this->items);
- }
- /**
- * Count the number of items in the collection.
- *
- * @return int
- */
- #[\ReturnTypeWillChange]
- public function count()
- {
- return count($this->items);
- }
- /**
- * Count the number of items in the collection by a field or using a callback.
- *
- * @param callable|string $countBy
- * @return static
- */
- public function countBy($countBy = null)
- {
- return new static($this->lazy()->countBy($countBy)->all());
- }
- /**
- * Add an item to the collection.
- *
- * @param mixed $item
- * @return $this
- */
- public function add($item)
- {
- $this->items[] = $item;
- return $this;
- }
- /**
- * Get a base Support collection instance from this collection.
- *
- * @return \Illuminate\Support\Collection
- */
- public function toBase()
- {
- return new self($this);
- }
- /**
- * Determine if an item exists at an offset.
- *
- * @param mixed $key
- * @return bool
- */
- #[\ReturnTypeWillChange]
- public function offsetExists($key)
- {
- return isset($this->items[$key]);
- }
- /**
- * Get an item at a given offset.
- *
- * @param mixed $key
- * @return mixed
- */
- #[\ReturnTypeWillChange]
- public function offsetGet($key)
- {
- return $this->items[$key];
- }
- /**
- * Set the item at a given offset.
- *
- * @param mixed $key
- * @param mixed $value
- * @return void
- */
- #[\ReturnTypeWillChange]
- 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 mixed $key
- * @return void
- */
- #[\ReturnTypeWillChange]
- public function offsetUnset($key)
- {
- unset($this->items[$key]);
- }
- }
|