| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585 |
- <?php
- namespace Illuminate\Support;
- use ArrayIterator;
- use Closure;
- use DateTimeInterface;
- use Illuminate\Contracts\Support\CanBeEscapedWhenCastToString;
- use Illuminate\Support\Traits\EnumeratesValues;
- use Illuminate\Support\Traits\Macroable;
- use IteratorAggregate;
- use stdClass;
- class LazyCollection implements CanBeEscapedWhenCastToString, Enumerable
- {
- use EnumeratesValues, Macroable;
- /**
- * The source from which to generate items.
- *
- * @var callable|static
- */
- public $source;
- /**
- * Create a new lazy collection instance.
- *
- * @param mixed $source
- * @return void
- */
- public function __construct($source = null)
- {
- if ($source instanceof Closure || $source instanceof self) {
- $this->source = $source;
- } elseif (is_null($source)) {
- $this->source = static::empty();
- } else {
- $this->source = $this->getArrayableItems($source);
- }
- }
- /**
- * Create a collection with the given range.
- *
- * @param int $from
- * @param int $to
- * @return static
- */
- public static function range($from, $to)
- {
- return new static(function () use ($from, $to) {
- if ($from <= $to) {
- for (; $from <= $to; $from++) {
- yield $from;
- }
- } else {
- for (; $from >= $to; $from--) {
- yield $from;
- }
- }
- });
- }
- /**
- * Get all items in the enumerable.
- *
- * @return array
- */
- public function all()
- {
- if (is_array($this->source)) {
- return $this->source;
- }
- return iterator_to_array($this->getIterator());
- }
- /**
- * Eager load all items into a new lazy collection backed by an array.
- *
- * @return static
- */
- public function eager()
- {
- return new static($this->all());
- }
- /**
- * Cache values as they're enumerated.
- *
- * @return static
- */
- public function remember()
- {
- $iterator = $this->getIterator();
- $iteratorIndex = 0;
- $cache = [];
- return new static(function () use ($iterator, &$iteratorIndex, &$cache) {
- for ($index = 0; true; $index++) {
- if (array_key_exists($index, $cache)) {
- yield $cache[$index][0] => $cache[$index][1];
- continue;
- }
- if ($iteratorIndex < $index) {
- $iterator->next();
- $iteratorIndex++;
- }
- if (! $iterator->valid()) {
- break;
- }
- $cache[$index] = [$iterator->key(), $iterator->current()];
- yield $cache[$index][0] => $cache[$index][1];
- }
- });
- }
- /**
- * Get the average value of a given key.
- *
- * @param callable|string|null $callback
- * @return mixed
- */
- public function avg($callback = null)
- {
- return $this->collect()->avg($callback);
- }
- /**
- * Get the median of a given key.
- *
- * @param string|array|null $key
- * @return mixed
- */
- public function median($key = null)
- {
- return $this->collect()->median($key);
- }
- /**
- * Get the mode of a given key.
- *
- * @param string|array|null $key
- * @return array|null
- */
- public function mode($key = null)
- {
- return $this->collect()->mode($key);
- }
- /**
- * Collapse the collection of items into a single array.
- *
- * @return static
- */
- public function collapse()
- {
- return new static(function () {
- foreach ($this as $values) {
- if (is_array($values) || $values instanceof Enumerable) {
- foreach ($values as $value) {
- yield $value;
- }
- }
- }
- });
- }
- /**
- * Determine if an item exists in the enumerable.
- *
- * @param mixed $key
- * @param mixed $operator
- * @param mixed $value
- * @return bool
- */
- public function contains($key, $operator = null, $value = null)
- {
- if (func_num_args() === 1 && $this->useAsCallable($key)) {
- $placeholder = new stdClass;
- return $this->first($key, $placeholder) !== $placeholder;
- }
- if (func_num_args() === 1) {
- $needle = $key;
- foreach ($this as $value) {
- if ($value == $needle) {
- return true;
- }
- }
- return false;
- }
- return $this->contains($this->operatorForWhere(...func_get_args()));
- }
- /**
- * Determine if an item is not contained in the enumerable.
- *
- * @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 the given iterables, returning all possible permutations.
- *
- * @param array ...$arrays
- * @return static
- */
- public function crossJoin(...$arrays)
- {
- return $this->passthru('crossJoin', func_get_args());
- }
- /**
- * 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)
- {
- $countBy = is_null($countBy)
- ? $this->identity()
- : $this->valueRetriever($countBy);
- return new static(function () use ($countBy) {
- $counts = [];
- foreach ($this as $key => $value) {
- $group = $countBy($value, $key);
- if (empty($counts[$group])) {
- $counts[$group] = 0;
- }
- $counts[$group]++;
- }
- yield from $counts;
- });
- }
- /**
- * Get the items that are not present in the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function diff($items)
- {
- return $this->passthru('diff', func_get_args());
- }
- /**
- * Get the items 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 $this->passthru('diffUsing', func_get_args());
- }
- /**
- * Get the items whose keys and values are not present in the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function diffAssoc($items)
- {
- return $this->passthru('diffAssoc', func_get_args());
- }
- /**
- * Get the items 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 $this->passthru('diffAssocUsing', func_get_args());
- }
- /**
- * Get the items whose keys are not present in the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function diffKeys($items)
- {
- return $this->passthru('diffKeys', func_get_args());
- }
- /**
- * Get the items 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 $this->passthru('diffKeysUsing', func_get_args());
- }
- /**
- * Retrieve duplicate items.
- *
- * @param callable|string|null $callback
- * @param bool $strict
- * @return static
- */
- public function duplicates($callback = null, $strict = false)
- {
- return $this->passthru('duplicates', func_get_args());
- }
- /**
- * Retrieve duplicate items using strict comparison.
- *
- * @param callable|string|null $callback
- * @return static
- */
- public function duplicatesStrict($callback = null)
- {
- return $this->passthru('duplicatesStrict', func_get_args());
- }
- /**
- * Get all items except for those with the specified keys.
- *
- * @param mixed $keys
- * @return static
- */
- public function except($keys)
- {
- return $this->passthru('except', func_get_args());
- }
- /**
- * Run a filter over each of the items.
- *
- * @param callable|null $callback
- * @return static
- */
- public function filter(callable $callback = null)
- {
- if (is_null($callback)) {
- $callback = function ($value) {
- return (bool) $value;
- };
- }
- return new static(function () use ($callback) {
- foreach ($this as $key => $value) {
- if ($callback($value, $key)) {
- yield $key => $value;
- }
- }
- });
- }
- /**
- * Get the first item from the enumerable passing the given truth test.
- *
- * @param callable|null $callback
- * @param mixed $default
- * @return mixed
- */
- public function first(callable $callback = null, $default = null)
- {
- $iterator = $this->getIterator();
- if (is_null($callback)) {
- if (! $iterator->valid()) {
- return value($default);
- }
- return $iterator->current();
- }
- foreach ($iterator as $key => $value) {
- if ($callback($value, $key)) {
- return $value;
- }
- }
- return value($default);
- }
- /**
- * Get a flattened list of the items in the collection.
- *
- * @param int $depth
- * @return static
- */
- public function flatten($depth = INF)
- {
- $instance = new static(function () use ($depth) {
- foreach ($this as $item) {
- if (! is_array($item) && ! $item instanceof Enumerable) {
- yield $item;
- } elseif ($depth === 1) {
- yield from $item;
- } else {
- yield from (new static($item))->flatten($depth - 1);
- }
- }
- });
- return $instance->values();
- }
- /**
- * Flip the items in the collection.
- *
- * @return static
- */
- public function flip()
- {
- return new static(function () {
- foreach ($this as $key => $value) {
- yield $value => $key;
- }
- });
- }
- /**
- * Get an item by key.
- *
- * @param mixed $key
- * @param mixed $default
- * @return mixed
- */
- public function get($key, $default = null)
- {
- if (is_null($key)) {
- return;
- }
- foreach ($this as $outerKey => $outerValue) {
- if ($outerKey == $key) {
- return $outerValue;
- }
- }
- return value($default);
- }
- /**
- * 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)
- {
- return $this->passthru('groupBy', func_get_args());
- }
- /**
- * Key an associative array by a field or using a callback.
- *
- * @param callable|string $keyBy
- * @return static
- */
- public function keyBy($keyBy)
- {
- return new static(function () use ($keyBy) {
- $keyBy = $this->valueRetriever($keyBy);
- foreach ($this as $key => $item) {
- $resolvedKey = $keyBy($item, $key);
- if (is_object($resolvedKey)) {
- $resolvedKey = (string) $resolvedKey;
- }
- yield $resolvedKey => $item;
- }
- });
- }
- /**
- * Determine if an item exists in the collection by key.
- *
- * @param mixed $key
- * @return bool
- */
- public function has($key)
- {
- $keys = array_flip(is_array($key) ? $key : func_get_args());
- $count = count($keys);
- foreach ($this as $key => $value) {
- if (array_key_exists($key, $keys) && --$count == 0) {
- return true;
- }
- }
- return false;
- }
- /**
- * Determine if any of the keys exist in the collection.
- *
- * @param mixed $key
- * @return bool
- */
- public function hasAny($key)
- {
- $keys = array_flip(is_array($key) ? $key : func_get_args());
- foreach ($this as $key => $value) {
- if (array_key_exists($key, $keys)) {
- 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)
- {
- return $this->collect()->implode(...func_get_args());
- }
- /**
- * Intersect the collection with the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function intersect($items)
- {
- return $this->passthru('intersect', func_get_args());
- }
- /**
- * Intersect the collection with the given items by key.
- *
- * @param mixed $items
- * @return static
- */
- public function intersectByKeys($items)
- {
- return $this->passthru('intersectByKeys', func_get_args());
- }
- /**
- * Determine if the items are empty or not.
- *
- * @return bool
- */
- public function isEmpty()
- {
- return ! $this->getIterator()->valid();
- }
- /**
- * Determine if the collection contains a single item.
- *
- * @return bool
- */
- public function containsOneItem()
- {
- return $this->take(2)->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 = '')
- {
- return $this->collect()->join(...func_get_args());
- }
- /**
- * Get the keys of the collection items.
- *
- * @return static
- */
- public function keys()
- {
- return new static(function () {
- foreach ($this as $key => $value) {
- yield $key;
- }
- });
- }
- /**
- * Get the last item from the collection.
- *
- * @param callable|null $callback
- * @param mixed $default
- * @return mixed
- */
- public function last(callable $callback = null, $default = null)
- {
- $needle = $placeholder = new stdClass;
- foreach ($this as $key => $value) {
- if (is_null($callback) || $callback($value, $key)) {
- $needle = $value;
- }
- }
- return $needle === $placeholder ? value($default) : $needle;
- }
- /**
- * Get the values of a given key.
- *
- * @param string|array $value
- * @param string|null $key
- * @return static
- */
- public function pluck($value, $key = null)
- {
- return new static(function () use ($value, $key) {
- [$value, $key] = $this->explodePluckParameters($value, $key);
- foreach ($this as $item) {
- $itemValue = data_get($item, $value);
- if (is_null($key)) {
- yield $itemValue;
- } else {
- $itemKey = data_get($item, $key);
- if (is_object($itemKey) && method_exists($itemKey, '__toString')) {
- $itemKey = (string) $itemKey;
- }
- yield $itemKey => $itemValue;
- }
- }
- });
- }
- /**
- * Run a map over each of the items.
- *
- * @param callable $callback
- * @return static
- */
- public function map(callable $callback)
- {
- return new static(function () use ($callback) {
- foreach ($this as $key => $value) {
- yield $key => $callback($value, $key);
- }
- });
- }
- /**
- * 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)
- {
- return $this->passthru('mapToDictionary', func_get_args());
- }
- /**
- * 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)
- {
- return new static(function () use ($callback) {
- foreach ($this as $key => $value) {
- yield from $callback($value, $key);
- }
- });
- }
- /**
- * Merge the collection with the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function merge($items)
- {
- return $this->passthru('merge', func_get_args());
- }
- /**
- * Recursively merge the collection with the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function mergeRecursive($items)
- {
- return $this->passthru('mergeRecursive', func_get_args());
- }
- /**
- * 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(function () use ($values) {
- $values = $this->makeIterator($values);
- $errorMessage = 'Both parameters should have an equal number of elements';
- foreach ($this as $key) {
- if (! $values->valid()) {
- trigger_error($errorMessage, E_USER_WARNING);
- break;
- }
- yield $key => $values->current();
- $values->next();
- }
- if ($values->valid()) {
- trigger_error($errorMessage, E_USER_WARNING);
- }
- });
- }
- /**
- * Union the collection with the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function union($items)
- {
- return $this->passthru('union', func_get_args());
- }
- /**
- * Create a new collection consisting of every n-th element.
- *
- * @param int $step
- * @param int $offset
- * @return static
- */
- public function nth($step, $offset = 0)
- {
- return new static(function () use ($step, $offset) {
- $position = 0;
- foreach ($this->slice($offset) as $item) {
- if ($position % $step === 0) {
- yield $item;
- }
- $position++;
- }
- });
- }
- /**
- * Get the items with the specified keys.
- *
- * @param mixed $keys
- * @return static
- */
- public function only($keys)
- {
- if ($keys instanceof Enumerable) {
- $keys = $keys->all();
- } elseif (! is_null($keys)) {
- $keys = is_array($keys) ? $keys : func_get_args();
- }
- return new static(function () use ($keys) {
- if (is_null($keys)) {
- yield from $this;
- } else {
- $keys = array_flip($keys);
- foreach ($this as $key => $value) {
- if (array_key_exists($key, $keys)) {
- yield $key => $value;
- unset($keys[$key]);
- if (empty($keys)) {
- break;
- }
- }
- }
- }
- });
- }
- /**
- * Push all of the given items onto the collection.
- *
- * @param iterable $source
- * @return static
- */
- public function concat($source)
- {
- return (new static(function () use ($source) {
- yield from $this;
- yield from $source;
- }))->values();
- }
- /**
- * 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)
- {
- $result = $this->collect()->random(...func_get_args());
- return is_null($number) ? $result : new static($result);
- }
- /**
- * Replace the collection items with the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function replace($items)
- {
- return new static(function () use ($items) {
- $items = $this->getArrayableItems($items);
- foreach ($this as $key => $value) {
- if (array_key_exists($key, $items)) {
- yield $key => $items[$key];
- unset($items[$key]);
- } else {
- yield $key => $value;
- }
- }
- foreach ($items as $key => $value) {
- yield $key => $value;
- }
- });
- }
- /**
- * Recursively replace the collection items with the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function replaceRecursive($items)
- {
- return $this->passthru('replaceRecursive', func_get_args());
- }
- /**
- * Reverse items order.
- *
- * @return static
- */
- public function reverse()
- {
- return $this->passthru('reverse', func_get_args());
- }
- /**
- * 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)
- {
- $predicate = $this->useAsCallable($value)
- ? $value
- : function ($item) use ($value, $strict) {
- return $strict ? $item === $value : $item == $value;
- };
- foreach ($this as $key => $item) {
- if ($predicate($item, $key)) {
- return $key;
- }
- }
- return false;
- }
- /**
- * Shuffle the items in the collection.
- *
- * @param int|null $seed
- * @return static
- */
- public function shuffle($seed = null)
- {
- return $this->passthru('shuffle', func_get_args());
- }
- /**
- * 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)
- {
- return new static(function () use ($size, $step) {
- $iterator = $this->getIterator();
- $chunk = [];
- while ($iterator->valid()) {
- $chunk[$iterator->key()] = $iterator->current();
- if (count($chunk) == $size) {
- yield tap(new static($chunk), function () use (&$chunk, $step) {
- $chunk = array_slice($chunk, $step, null, true);
- });
- // If the $step between chunks is bigger than each chunk's $size
- // we will skip the extra items (which should never be in any
- // chunk) before we continue to the next chunk in the loop.
- if ($step > $size) {
- $skip = $step - $size;
- for ($i = 0; $i < $skip && $iterator->valid(); $i++) {
- $iterator->next();
- }
- }
- }
- $iterator->next();
- }
- });
- }
- /**
- * Skip the first {$count} items.
- *
- * @param int $count
- * @return static
- */
- public function skip($count)
- {
- return new static(function () use ($count) {
- $iterator = $this->getIterator();
- while ($iterator->valid() && $count--) {
- $iterator->next();
- }
- while ($iterator->valid()) {
- yield $iterator->key() => $iterator->current();
- $iterator->next();
- }
- });
- }
- /**
- * Skip items in the collection until the given condition is met.
- *
- * @param mixed $value
- * @return static
- */
- public function skipUntil($value)
- {
- $callback = $this->useAsCallable($value) ? $value : $this->equality($value);
- return $this->skipWhile($this->negate($callback));
- }
- /**
- * Skip items in the collection while the given condition is met.
- *
- * @param mixed $value
- * @return static
- */
- public function skipWhile($value)
- {
- $callback = $this->useAsCallable($value) ? $value : $this->equality($value);
- return new static(function () use ($callback) {
- $iterator = $this->getIterator();
- while ($iterator->valid() && $callback($iterator->current(), $iterator->key())) {
- $iterator->next();
- }
- while ($iterator->valid()) {
- yield $iterator->key() => $iterator->current();
- $iterator->next();
- }
- });
- }
- /**
- * Get a slice of items from the enumerable.
- *
- * @param int $offset
- * @param int|null $length
- * @return static
- */
- public function slice($offset, $length = null)
- {
- if ($offset < 0 || $length < 0) {
- return $this->passthru('slice', func_get_args());
- }
- $instance = $this->skip($offset);
- return is_null($length) ? $instance : $instance->take($length);
- }
- /**
- * Split a collection into a certain number of groups.
- *
- * @param int $numberOfGroups
- * @return static
- */
- public function split($numberOfGroups)
- {
- return $this->passthru('split', func_get_args());
- }
- /**
- * 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;
- return $this
- ->when($filter)
- ->filter($filter)
- ->take(2)
- ->collect()
- ->sole();
- }
- /**
- * 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;
- return $this
- ->when($filter)
- ->filter($filter)
- ->take(1)
- ->collect()
- ->firstOrFail();
- }
- /**
- * Chunk the collection into chunks of the given size.
- *
- * @param int $size
- * @return static
- */
- public function chunk($size)
- {
- if ($size <= 0) {
- return static::empty();
- }
- return new static(function () use ($size) {
- $iterator = $this->getIterator();
- while ($iterator->valid()) {
- $chunk = [];
- while (true) {
- $chunk[$iterator->key()] = $iterator->current();
- if (count($chunk) < $size) {
- $iterator->next();
- if (! $iterator->valid()) {
- break;
- }
- } else {
- break;
- }
- }
- yield new static($chunk);
- $iterator->next();
- }
- });
- }
- /**
- * 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));
- }
- /**
- * Chunk the collection into chunks with a callback.
- *
- * @param callable $callback
- * @return static
- */
- public function chunkWhile(callable $callback)
- {
- return new static(function () use ($callback) {
- $iterator = $this->getIterator();
- $chunk = new Collection;
- if ($iterator->valid()) {
- $chunk[$iterator->key()] = $iterator->current();
- $iterator->next();
- }
- while ($iterator->valid()) {
- if (! $callback($iterator->current(), $iterator->key(), $chunk)) {
- yield new static($chunk);
- $chunk = new Collection;
- }
- $chunk[$iterator->key()] = $iterator->current();
- $iterator->next();
- }
- if ($chunk->isNotEmpty()) {
- yield new static($chunk);
- }
- });
- }
- /**
- * Sort through each item with a callback.
- *
- * @param callable|null|int $callback
- * @return static
- */
- public function sort($callback = null)
- {
- return $this->passthru('sort', func_get_args());
- }
- /**
- * Sort items in descending order.
- *
- * @param int $options
- * @return static
- */
- public function sortDesc($options = SORT_REGULAR)
- {
- return $this->passthru('sortDesc', func_get_args());
- }
- /**
- * Sort the collection using the given callback.
- *
- * @param callable|string $callback
- * @param int $options
- * @param bool $descending
- * @return static
- */
- public function sortBy($callback, $options = SORT_REGULAR, $descending = false)
- {
- return $this->passthru('sortBy', func_get_args());
- }
- /**
- * 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->passthru('sortByDesc', func_get_args());
- }
- /**
- * Sort the collection keys.
- *
- * @param int $options
- * @param bool $descending
- * @return static
- */
- public function sortKeys($options = SORT_REGULAR, $descending = false)
- {
- return $this->passthru('sortKeys', func_get_args());
- }
- /**
- * Sort the collection keys in descending order.
- *
- * @param int $options
- * @return static
- */
- public function sortKeysDesc($options = SORT_REGULAR)
- {
- return $this->passthru('sortKeysDesc', func_get_args());
- }
- /**
- * Sort the collection keys using a callback.
- *
- * @param callable $callback
- * @return static
- */
- public function sortKeysUsing(callable $callback)
- {
- return $this->passthru('sortKeysUsing', func_get_args());
- }
- /**
- * Take the first or last {$limit} items.
- *
- * @param int $limit
- * @return static
- */
- public function take($limit)
- {
- if ($limit < 0) {
- return $this->passthru('take', func_get_args());
- }
- return new static(function () use ($limit) {
- $iterator = $this->getIterator();
- while ($limit--) {
- if (! $iterator->valid()) {
- break;
- }
- yield $iterator->key() => $iterator->current();
- if ($limit) {
- $iterator->next();
- }
- }
- });
- }
- /**
- * Take items in the collection until the given condition is met.
- *
- * @param mixed $value
- * @return static
- */
- public function takeUntil($value)
- {
- $callback = $this->useAsCallable($value) ? $value : $this->equality($value);
- return new static(function () use ($callback) {
- foreach ($this as $key => $item) {
- if ($callback($item, $key)) {
- break;
- }
- yield $key => $item;
- }
- });
- }
- /**
- * Take items in the collection until a given point in time.
- *
- * @param \DateTimeInterface $timeout
- * @return static
- */
- public function takeUntilTimeout(DateTimeInterface $timeout)
- {
- $timeout = $timeout->getTimestamp();
- return $this->takeWhile(function () use ($timeout) {
- return $this->now() < $timeout;
- });
- }
- /**
- * Take items in the collection while the given condition is met.
- *
- * @param mixed $value
- * @return static
- */
- public function takeWhile($value)
- {
- $callback = $this->useAsCallable($value) ? $value : $this->equality($value);
- return $this->takeUntil(function ($item, $key) use ($callback) {
- return ! $callback($item, $key);
- });
- }
- /**
- * Pass each item in the collection to the given callback, lazily.
- *
- * @param callable $callback
- * @return static
- */
- public function tapEach(callable $callback)
- {
- return new static(function () use ($callback) {
- foreach ($this as $key => $value) {
- $callback($value, $key);
- yield $key => $value;
- }
- });
- }
- /**
- * Convert a flatten "dot" notation array into an expanded array.
- *
- * @return static
- */
- public function undot()
- {
- return $this->passthru('undot', []);
- }
- /**
- * 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)
- {
- $callback = $this->valueRetriever($key);
- return new static(function () use ($callback, $strict) {
- $exists = [];
- foreach ($this as $key => $item) {
- if (! in_array($id = $callback($item, $key), $exists, $strict)) {
- yield $key => $item;
- $exists[] = $id;
- }
- }
- });
- }
- /**
- * Reset the keys on the underlying array.
- *
- * @return static
- */
- public function values()
- {
- return new static(function () {
- foreach ($this as $item) {
- yield $item;
- }
- });
- }
- /**
- * Zip the collection together with one or more arrays.
- *
- * e.g. new LazyCollection([1, 2, 3])->zip([4, 5, 6]);
- * => [[1, 4], [2, 5], [3, 6]]
- *
- * @param mixed ...$items
- * @return static
- */
- public function zip($items)
- {
- $iterables = func_get_args();
- return new static(function () use ($iterables) {
- $iterators = Collection::make($iterables)->map(function ($iterable) {
- return $this->makeIterator($iterable);
- })->prepend($this->getIterator());
- while ($iterators->contains->valid()) {
- yield new static($iterators->map->current());
- $iterators->each->next();
- }
- });
- }
- /**
- * Pad collection to the specified length with a value.
- *
- * @param int $size
- * @param mixed $value
- * @return static
- */
- public function pad($size, $value)
- {
- if ($size < 0) {
- return $this->passthru('pad', func_get_args());
- }
- return new static(function () use ($size, $value) {
- $yielded = 0;
- foreach ($this as $index => $item) {
- yield $index => $item;
- $yielded++;
- }
- while ($yielded++ < $size) {
- yield $value;
- }
- });
- }
- /**
- * Get the values iterator.
- *
- * @return \Traversable
- */
- #[\ReturnTypeWillChange]
- public function getIterator()
- {
- return $this->makeIterator($this->source);
- }
- /**
- * Count the number of items in the collection.
- *
- * @return int
- */
- #[\ReturnTypeWillChange]
- public function count()
- {
- if (is_array($this->source)) {
- return count($this->source);
- }
- return iterator_count($this->getIterator());
- }
- /**
- * Make an iterator from the given source.
- *
- * @param mixed $source
- * @return \Traversable
- */
- protected function makeIterator($source)
- {
- if ($source instanceof IteratorAggregate) {
- return $source->getIterator();
- }
- if (is_array($source)) {
- return new ArrayIterator($source);
- }
- return $source();
- }
- /**
- * Explode the "value" and "key" arguments passed to "pluck".
- *
- * @param string|array $value
- * @param string|array|null $key
- * @return array
- */
- protected function explodePluckParameters($value, $key)
- {
- $value = is_string($value) ? explode('.', $value) : $value;
- $key = is_null($key) || is_array($key) ? $key : explode('.', $key);
- return [$value, $key];
- }
- /**
- * Pass this lazy collection through a method on the collection class.
- *
- * @param string $method
- * @param array $params
- * @return static
- */
- protected function passthru($method, array $params)
- {
- return new static(function () use ($method, $params) {
- yield from $this->collect()->$method(...$params);
- });
- }
- /**
- * Get the current time.
- *
- * @return int
- */
- protected function now()
- {
- return time();
- }
- }
|