| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213 |
- <?php
- namespace Illuminate\Support\Traits;
- use BackedEnum;
- use CachingIterator;
- use Closure;
- use Exception;
- use Illuminate\Contracts\Support\Arrayable;
- use Illuminate\Contracts\Support\Jsonable;
- use Illuminate\Support\Arr;
- use Illuminate\Support\Collection;
- use Illuminate\Support\Enumerable;
- use Illuminate\Support\HigherOrderCollectionProxy;
- use JsonSerializable;
- use UnexpectedValueException;
- use UnitEnum;
- use function Illuminate\Support\enum_value;
- /**
- * @template TKey of array-key
- *
- * @template-covariant TValue
- *
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $average
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $avg
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $contains
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $doesntContain
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $each
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $every
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $filter
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $first
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $flatMap
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $groupBy
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $hasMany
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $hasSole
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $keyBy
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $last
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $map
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $max
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $min
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $partition
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $percentage
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $reject
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $skipUntil
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $skipWhile
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $some
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $sortBy
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $sortByDesc
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $sum
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $takeUntil
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $takeWhile
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $unique
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $unless
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $until
- * @property-read HigherOrderCollectionProxy<TKey, TValue> $when
- */
- trait EnumeratesValues
- {
- use Conditionable;
- /**
- * Indicates that the object's string representation should be escaped when __toString is invoked.
- *
- * @var bool
- */
- protected $escapeWhenCastingToString = false;
- /**
- * The methods that can be proxied.
- *
- * @var array<int, string>
- */
- protected static $proxies = [
- 'average',
- 'avg',
- 'contains',
- 'doesntContain',
- 'each',
- 'every',
- 'filter',
- 'first',
- 'flatMap',
- 'groupBy',
- 'hasMany',
- 'hasSole',
- 'keyBy',
- 'last',
- 'map',
- 'max',
- 'min',
- 'partition',
- 'percentage',
- 'reject',
- 'skipUntil',
- 'skipWhile',
- 'some',
- 'sortBy',
- 'sortByDesc',
- 'sum',
- 'takeUntil',
- 'takeWhile',
- 'unique',
- 'unless',
- 'until',
- 'when',
- ];
- /**
- * Create a new collection instance if the value isn't one already.
- *
- * @template TMakeKey of array-key
- * @template TMakeValue
- *
- * @param \Illuminate\Contracts\Support\Arrayable<TMakeKey, TMakeValue>|iterable<TMakeKey, TMakeValue>|null $items
- * @return static<TMakeKey, TMakeValue>
- */
- public static function make($items = [])
- {
- return new static($items);
- }
- /**
- * Wrap the given value in a collection if applicable.
- *
- * @template TWrapValue
- *
- * @param iterable<array-key, TWrapValue>|TWrapValue $value
- * @return static<array-key, TWrapValue>
- */
- public static function wrap($value)
- {
- return $value instanceof Enumerable
- ? new static($value)
- : new static(Arr::wrap($value));
- }
- /**
- * Get the underlying items from the given collection if applicable.
- *
- * @template TUnwrapKey of array-key
- * @template TUnwrapValue
- *
- * @param array<TUnwrapKey, TUnwrapValue>|static<TUnwrapKey, TUnwrapValue> $value
- * @return array<TUnwrapKey, TUnwrapValue>
- */
- public static function unwrap($value)
- {
- return $value instanceof Enumerable ? $value->all() : $value;
- }
- /**
- * Create a new instance with no items.
- *
- * @return static
- */
- public static function empty()
- {
- return new static([]);
- }
- /**
- * Create a new collection by invoking the callback a given amount of times.
- *
- * @template TTimesValue
- *
- * @param int $number
- * @param (callable(int): TTimesValue)|null $callback
- * @return static<int, TTimesValue>
- */
- public static function times($number, ?callable $callback = null)
- {
- if ($number < 1) {
- return new static;
- }
- return static::range(1, $number)
- ->unless($callback == null)
- ->map($callback);
- }
- /**
- * Create a new collection by decoding a JSON string.
- *
- * @param string $json
- * @param int $depth
- * @param int $flags
- * @return static<TKey, TValue>
- */
- public static function fromJson($json, $depth = 512, $flags = 0)
- {
- return new static(json_decode($json, true, $depth, $flags));
- }
- /**
- * Get the average value of a given key.
- *
- * @param (callable(TValue): float|int)|string|null $callback
- * @return float|int|null
- */
- public function avg($callback = null)
- {
- $callback = $this->valueRetriever($callback);
- $reduced = $this->reduce(static function (&$reduce, $value) use ($callback) {
- if (! is_null($resolved = $callback($value))) {
- $reduce[0] += $resolved;
- $reduce[1]++;
- }
- return $reduce;
- }, [0, 0]);
- return $reduced[1] ? $reduced[0] / $reduced[1] : null;
- }
- /**
- * Alias for the "avg" method.
- *
- * @param (callable(TValue): float|int)|string|null $callback
- * @return float|int|null
- */
- public function average($callback = null)
- {
- return $this->avg($callback);
- }
- /**
- * Alias for the "contains" method.
- *
- * @param (callable(TValue, TKey): bool)|TValue|string $key
- * @param mixed $operator
- * @param mixed $value
- * @return bool
- */
- public function some($key, $operator = null, $value = null)
- {
- return $this->contains(...func_get_args());
- }
- /**
- * Dump the given arguments and terminate execution.
- *
- * @param mixed ...$args
- * @return never
- */
- public function dd(...$args)
- {
- dd($this->all(), ...$args);
- }
- /**
- * Dump the items.
- *
- * @param mixed ...$args
- * @return $this
- */
- public function dump(...$args)
- {
- dump($this->all(), ...$args);
- return $this;
- }
- /**
- * Execute a callback over each item.
- *
- * @param callable(TValue, TKey): mixed $callback
- * @return $this
- */
- public function each(callable $callback)
- {
- foreach ($this as $key => $item) {
- if ($callback($item, $key) === false) {
- break;
- }
- }
- return $this;
- }
- /**
- * Execute a callback over each nested chunk of items.
- *
- * @param callable(...mixed): mixed $callback
- * @return static
- */
- public function eachSpread(callable $callback)
- {
- return $this->each(function ($chunk, $key) use ($callback) {
- $chunk[] = $key;
- return $callback(...$chunk);
- });
- }
- /**
- * Determine if all items pass the given truth test.
- *
- * @param (callable(TValue, TKey): bool)|TValue|string $key
- * @param mixed $operator
- * @param mixed $value
- * @return bool
- */
- public function every($key, $operator = null, $value = null)
- {
- if (func_num_args() === 1) {
- $callback = $this->valueRetriever($key);
- foreach ($this as $k => $v) {
- if (! $callback($v, $k)) {
- return false;
- }
- }
- return true;
- }
- return $this->every($this->operatorForWhere(...func_get_args()));
- }
- /**
- * Get the first item by the given key value pair.
- *
- * @param callable|string $key
- * @param mixed $operator
- * @param mixed $value
- * @return TValue|null
- */
- public function firstWhere($key, $operator = null, $value = null)
- {
- return $this->first($this->operatorForWhere(...func_get_args()));
- }
- /**
- * Determine if the collection contains multiple items, optionally matching the given criteria.
- *
- * @param (callable(TValue, TKey): bool)|string|null $key
- * @param mixed $operator
- * @param mixed $value
- * @return bool
- */
- public function hasMany($key = null, $operator = null, $value = null): bool
- {
- $filter = func_num_args() > 1
- ? $this->operatorForWhere(...func_get_args())
- : $key;
- return $this
- ->unless($filter == null)
- ->filter($filter)
- ->take(2)
- ->count() === 2;
- }
- /**
- * Get a single key's value from the first matching item in the collection.
- *
- * @template TValueDefault
- *
- * @param string $key
- * @param TValueDefault|(\Closure(): TValueDefault) $default
- * @return TValue|TValueDefault
- */
- public function value($key, $default = null)
- {
- $value = $this->first(function ($target) use ($key) {
- return data_has($target, $key);
- });
- return data_get($value, $key, $default);
- }
- /**
- * Ensure that every item in the collection is of the expected type.
- *
- * @template TEnsureOfType
- *
- * @param class-string<TEnsureOfType>|array<array-key, class-string<TEnsureOfType>>|'string'|'int'|'float'|'bool'|'array'|'null' $type
- * @return static<TKey, TEnsureOfType>
- *
- * @throws \UnexpectedValueException
- */
- public function ensure($type)
- {
- $allowedTypes = is_array($type) ? $type : [$type];
- return $this->each(function ($item, $index) use ($allowedTypes) {
- $itemType = get_debug_type($item);
- foreach ($allowedTypes as $allowedType) {
- if ($itemType === $allowedType || $item instanceof $allowedType) {
- return true;
- }
- }
- throw new UnexpectedValueException(
- sprintf("Collection should only include [%s] items, but '%s' found at position %d.", implode(', ', $allowedTypes), $itemType, $index)
- );
- });
- }
- /**
- * Determine if the collection is not empty.
- *
- * @phpstan-assert-if-true TValue $this->first()
- * @phpstan-assert-if-true TValue $this->last()
- *
- * @phpstan-assert-if-false null $this->first()
- * @phpstan-assert-if-false null $this->last()
- *
- * @return bool
- */
- public function isNotEmpty()
- {
- return ! $this->isEmpty();
- }
- /**
- * Run a map over each nested chunk of items.
- *
- * @template TMapSpreadValue
- *
- * @param callable(mixed...): TMapSpreadValue $callback
- * @return static<TKey, TMapSpreadValue>
- */
- public function mapSpread(callable $callback)
- {
- return $this->map(function ($chunk, $key) use ($callback) {
- $chunk[] = $key;
- return $callback(...$chunk);
- });
- }
- /**
- * Run a grouping map over the items.
- *
- * The callback should return an associative array with a single key/value pair.
- *
- * @template TMapToGroupsKey of array-key
- * @template TMapToGroupsValue
- *
- * @param callable(TValue, TKey): array<TMapToGroupsKey, TMapToGroupsValue> $callback
- * @return static<TMapToGroupsKey, static<int, TMapToGroupsValue>>
- */
- public function mapToGroups(callable $callback)
- {
- $groups = $this->mapToDictionary($callback);
- return $groups->map($this->make(...));
- }
- /**
- * Map a collection and flatten the result by a single level.
- *
- * @template TFlatMapKey of array-key
- * @template TFlatMapValue
- *
- * @param callable(TValue, TKey): (\Illuminate\Support\Collection<TFlatMapKey, TFlatMapValue>|array<TFlatMapKey, TFlatMapValue>) $callback
- * @return static<TFlatMapKey, TFlatMapValue>
- */
- public function flatMap(callable $callback)
- {
- return $this->map($callback)->collapse();
- }
- /**
- * Map the values into a new class.
- *
- * @template TMapIntoValue
- *
- * @param class-string<TMapIntoValue> $class
- * @return static<TKey, TMapIntoValue>
- */
- public function mapInto($class)
- {
- if (is_subclass_of($class, BackedEnum::class)) {
- return $this->map(fn ($value, $key) => $class::from($value));
- }
- return $this->map(fn ($value, $key) => new $class($value, $key));
- }
- /**
- * Get the min value of a given key.
- *
- * @param (callable(TValue):mixed)|string|null $callback
- * @return mixed
- */
- public function min($callback = null)
- {
- $callback = $this->valueRetriever($callback);
- return $this->map(fn ($value) => $callback($value))
- ->reject(fn ($value) => is_null($value))
- ->reduce(fn ($result, $value) => is_null($result) || $value < $result ? $value : $result);
- }
- /**
- * Get the max value of a given key.
- *
- * @param (callable(TValue):mixed)|string|null $callback
- * @return mixed
- */
- public function max($callback = null)
- {
- $callback = $this->valueRetriever($callback);
- return $this->reject(fn ($value) => is_null($value))->reduce(function ($result, $item) use ($callback) {
- $value = $callback($item);
- return is_null($result) || $value > $result ? $value : $result;
- });
- }
- /**
- * "Paginate" the collection by slicing it into a smaller collection.
- *
- * @param int $page
- * @param int $perPage
- * @return static
- */
- public function forPage($page, $perPage)
- {
- $offset = max(0, ($page - 1) * $perPage);
- return $this->slice($offset, $perPage);
- }
- /**
- * Partition the collection into two arrays using the given callback or key.
- *
- * @param (callable(TValue, TKey): bool)|TValue|string $key
- * @param mixed $operator
- * @param mixed $value
- * @return static<int<0, 1>, static<TKey, TValue>>
- */
- public function partition($key, $operator = null, $value = null)
- {
- $callback = func_num_args() === 1
- ? $this->valueRetriever($key)
- : $this->operatorForWhere(...func_get_args());
- [$passed, $failed] = Arr::partition($this->getIterator(), $callback);
- return new static([new static($passed), new static($failed)]);
- }
- /**
- * Calculate the percentage of items that pass a given truth test.
- *
- * @param (callable(TValue, TKey): bool) $callback
- * @param int $precision
- * @return float|null
- */
- public function percentage(callable $callback, int $precision = 2)
- {
- if ($this->isEmpty()) {
- return null;
- }
- return round(
- $this->filter($callback)->count() / $this->count() * 100,
- $precision
- );
- }
- /**
- * Get the sum of the given values.
- *
- * @template TReturnType
- *
- * @param (callable(TValue): TReturnType)|string|null $callback
- * @return ($callback is callable ? TReturnType : mixed)
- */
- public function sum($callback = null)
- {
- $callback = is_null($callback)
- ? $this->identity()
- : $this->valueRetriever($callback);
- return $this->reduce(fn ($result, $item) => $result + $callback($item), 0);
- }
- /**
- * Apply the callback if the collection is empty.
- *
- * @template TWhenEmptyReturnType
- *
- * @param (callable($this): TWhenEmptyReturnType) $callback
- * @param (callable($this): TWhenEmptyReturnType)|null $default
- * @return $this|TWhenEmptyReturnType
- */
- public function whenEmpty(callable $callback, ?callable $default = null)
- {
- return $this->when($this->isEmpty(), $callback, $default);
- }
- /**
- * Apply the callback if the collection is not empty.
- *
- * @template TWhenNotEmptyReturnType
- *
- * @param callable($this): TWhenNotEmptyReturnType $callback
- * @param (callable($this): TWhenNotEmptyReturnType)|null $default
- * @return $this|TWhenNotEmptyReturnType
- */
- public function whenNotEmpty(callable $callback, ?callable $default = null)
- {
- return $this->when($this->isNotEmpty(), $callback, $default);
- }
- /**
- * Apply the callback unless the collection is empty.
- *
- * @template TUnlessEmptyReturnType
- *
- * @param callable($this): TUnlessEmptyReturnType $callback
- * @param (callable($this): TUnlessEmptyReturnType)|null $default
- * @return $this|TUnlessEmptyReturnType
- */
- public function unlessEmpty(callable $callback, ?callable $default = null)
- {
- return $this->whenNotEmpty($callback, $default);
- }
- /**
- * Apply the callback unless the collection is not empty.
- *
- * @template TUnlessNotEmptyReturnType
- *
- * @param callable($this): TUnlessNotEmptyReturnType $callback
- * @param (callable($this): TUnlessNotEmptyReturnType)|null $default
- * @return $this|TUnlessNotEmptyReturnType
- */
- public function unlessNotEmpty(callable $callback, ?callable $default = null)
- {
- return $this->whenEmpty($callback, $default);
- }
- /**
- * Filter items by the given key value pair.
- *
- * @param callable|string $key
- * @param mixed $operator
- * @param mixed $value
- * @return static
- */
- public function where($key, $operator = null, $value = null)
- {
- return $this->filter($this->operatorForWhere(...func_get_args()));
- }
- /**
- * Filter items where the value for the given key is null.
- *
- * @param string|null $key
- * @return static
- */
- public function whereNull($key = null)
- {
- return $this->whereStrict($key, null);
- }
- /**
- * Filter items where the value for the given key is not null.
- *
- * @param string|null $key
- * @return static
- */
- public function whereNotNull($key = null)
- {
- return $this->where($key, '!==', null);
- }
- /**
- * Filter items by the given key value pair using strict comparison.
- *
- * @param string $key
- * @param mixed $value
- * @return static
- */
- public function whereStrict($key, $value)
- {
- return $this->where($key, '===', $value);
- }
- /**
- * Filter items by the given key value pair.
- *
- * @param string $key
- * @param \Illuminate\Contracts\Support\Arrayable|iterable $values
- * @param bool $strict
- * @return static
- */
- public function whereIn($key, $values, $strict = false)
- {
- $values = $this->getArrayableItems($values);
- return $this->filter(fn ($item) => in_array(data_get($item, $key), $values, $strict));
- }
- /**
- * Filter items by the given key value pair using strict comparison.
- *
- * @param string $key
- * @param \Illuminate\Contracts\Support\Arrayable|iterable $values
- * @return static
- */
- public function whereInStrict($key, $values)
- {
- return $this->whereIn($key, $values, true);
- }
- /**
- * Filter items such that the value of the given key is between the given values.
- *
- * @param string $key
- * @param \Illuminate\Contracts\Support\Arrayable|iterable $values
- * @return static
- */
- public function whereBetween($key, $values)
- {
- return $this->where($key, '>=', reset($values))->where($key, '<=', end($values));
- }
- /**
- * Filter items such that the value of the given key is not between the given values.
- *
- * @param string $key
- * @param \Illuminate\Contracts\Support\Arrayable|iterable $values
- * @return static
- */
- public function whereNotBetween($key, $values)
- {
- return $this->filter(
- fn ($item) => data_get($item, $key) < reset($values) || data_get($item, $key) > end($values)
- );
- }
- /**
- * Filter items by the given key value pair.
- *
- * @param string $key
- * @param \Illuminate\Contracts\Support\Arrayable|iterable $values
- * @param bool $strict
- * @return static
- */
- public function whereNotIn($key, $values, $strict = false)
- {
- $values = $this->getArrayableItems($values);
- return $this->reject(fn ($item) => in_array(data_get($item, $key), $values, $strict));
- }
- /**
- * Filter items by the given key value pair using strict comparison.
- *
- * @param string $key
- * @param \Illuminate\Contracts\Support\Arrayable|iterable $values
- * @return static
- */
- public function whereNotInStrict($key, $values)
- {
- return $this->whereNotIn($key, $values, true);
- }
- /**
- * Filter the items, removing any items that don't match the given type(s).
- *
- * @template TWhereInstanceOf
- *
- * @param class-string<TWhereInstanceOf>|array<array-key, class-string<TWhereInstanceOf>> $type
- * @return static<TKey, TWhereInstanceOf>
- */
- public function whereInstanceOf($type)
- {
- return $this->filter(function ($value) use ($type) {
- if (is_array($type)) {
- foreach ($type as $classType) {
- if ($value instanceof $classType) {
- return true;
- }
- }
- return false;
- }
- return $value instanceof $type;
- });
- }
- /**
- * Pass the collection to the given callback and return the result.
- *
- * @template TPipeReturnType
- *
- * @param callable($this): TPipeReturnType $callback
- * @return TPipeReturnType
- */
- public function pipe(callable $callback)
- {
- return $callback($this);
- }
- /**
- * Pass the collection into a new class.
- *
- * @template TPipeIntoValue
- *
- * @param class-string<TPipeIntoValue> $class
- * @return TPipeIntoValue
- */
- public function pipeInto($class)
- {
- return new $class($this);
- }
- /**
- * Pass the collection through a series of callable pipes and return the result.
- *
- * @param array<callable> $callbacks
- * @return mixed
- */
- public function pipeThrough($callbacks)
- {
- return (new Collection($callbacks))->reduce(
- fn ($carry, $callback) => $callback($carry),
- $this,
- );
- }
- /**
- * Reduce the collection to a single value.
- *
- * @template TReduceInitial
- * @template TReduceReturnType
- *
- * @param callable(TReduceInitial|TReduceReturnType, TValue, TKey): TReduceReturnType $callback
- * @param TReduceInitial $initial
- * @return TReduceReturnType
- */
- public function reduce(callable $callback, $initial = null)
- {
- $result = $initial;
- foreach ($this as $key => $value) {
- $result = $callback($result, $value, $key);
- }
- return $result;
- }
- /**
- * Reduce the collection to multiple aggregate values.
- *
- * @param callable $callback
- * @param mixed ...$initial
- * @return array
- *
- * @throws \UnexpectedValueException
- */
- public function reduceSpread(callable $callback, ...$initial)
- {
- $result = $initial;
- foreach ($this as $key => $value) {
- $result = call_user_func_array($callback, array_merge($result, [$value, $key]));
- if (! is_array($result)) {
- throw new UnexpectedValueException(sprintf(
- "%s::reduceSpread expects reducer to return an array, but got a '%s' instead.",
- class_basename(static::class), gettype($result)
- ));
- }
- }
- return $result;
- }
- /**
- * Reduce an associative collection to a single value.
- *
- * @template TReduceWithKeysInitial
- * @template TReduceWithKeysReturnType
- *
- * @param callable(TReduceWithKeysInitial|TReduceWithKeysReturnType, TValue, TKey): TReduceWithKeysReturnType $callback
- * @param TReduceWithKeysInitial $initial
- * @return TReduceWithKeysReturnType
- */
- public function reduceWithKeys(callable $callback, $initial = null)
- {
- return $this->reduce($callback, $initial);
- }
- /**
- * Create a collection of all elements that do not pass a given truth test.
- *
- * @param (callable(TValue, TKey): bool)|bool|TValue $callback
- * @return static
- */
- public function reject($callback = true)
- {
- $useAsCallable = $this->useAsCallable($callback);
- return $this->filter(function ($value, $key) use ($callback, $useAsCallable) {
- return $useAsCallable
- ? ! $callback($value, $key)
- : $value != $callback;
- });
- }
- /**
- * Pass the collection to the given callback and then return it.
- *
- * @param callable($this): mixed $callback
- * @return $this
- */
- public function tap(callable $callback)
- {
- $callback($this);
- return $this;
- }
- /**
- * Return only unique items from the collection array.
- *
- * @param (callable(TValue, TKey): mixed)|string|null $key
- * @param bool $strict
- * @return static
- */
- public function unique($key = null, $strict = false)
- {
- $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;
- });
- }
- /**
- * Return only unique items from the collection array using strict comparison.
- *
- * @param (callable(TValue, TKey): mixed)|string|null $key
- * @return static
- */
- public function uniqueStrict($key = null)
- {
- return $this->unique($key, true);
- }
- /**
- * Collect the values into a collection.
- *
- * @return \Illuminate\Support\Collection<TKey, TValue>
- */
- public function collect()
- {
- return new Collection($this->all());
- }
- /**
- * Get the collection of items as a plain array.
- *
- * @return array<TKey, mixed>
- */
- public function toArray()
- {
- return $this->map(fn ($value) => $value instanceof Arrayable ? $value->toArray() : $value)->all();
- }
- /**
- * Convert the object into something JSON serializable.
- *
- * @return array<TKey, mixed>
- */
- public function jsonSerialize(): array
- {
- return array_map(function ($value) {
- return match (true) {
- $value instanceof JsonSerializable => $value->jsonSerialize(),
- $value instanceof Jsonable => json_decode($value->toJson(), true),
- $value instanceof Arrayable => $value->toArray(),
- default => $value,
- };
- }, $this->all());
- }
- /**
- * Get the collection of items as JSON.
- *
- * @param int $options
- * @return string
- */
- public function toJson($options = 0)
- {
- return json_encode($this->jsonSerialize(), $options);
- }
- /**
- * Get the collection of items as pretty print formatted JSON.
- *
- * @param int $options
- * @return string
- */
- public function toPrettyJson(int $options = 0)
- {
- return $this->toJson(JSON_PRETTY_PRINT | $options);
- }
- /**
- * Get a CachingIterator instance.
- *
- * @param int $flags
- * @return \CachingIterator
- */
- public function getCachingIterator($flags = CachingIterator::CALL_TOSTRING)
- {
- return new CachingIterator($this->getIterator(), $flags);
- }
- /**
- * Convert the collection to its string representation.
- *
- * @return string
- */
- public function __toString()
- {
- return $this->escapeWhenCastingToString
- ? e($this->toJson())
- : $this->toJson();
- }
- /**
- * Indicate that the model's string representation should be escaped when __toString is invoked.
- *
- * @param bool $escape
- * @return $this
- */
- public function escapeWhenCastingToString($escape = true)
- {
- $this->escapeWhenCastingToString = $escape;
- return $this;
- }
- /**
- * Add a method to the list of proxied methods.
- *
- * @param string $method
- * @return void
- */
- public static function proxy($method)
- {
- static::$proxies[] = $method;
- }
- /**
- * Dynamically access collection proxies.
- *
- * @param string $key
- * @return mixed
- *
- * @throws \Exception
- */
- public function __get($key)
- {
- if (! in_array($key, static::$proxies)) {
- throw new Exception("Property [{$key}] does not exist on this collection instance.");
- }
- return new HigherOrderCollectionProxy($this, $key);
- }
- /**
- * Results array of items from Collection or Arrayable.
- *
- * @param mixed $items
- * @return array<TKey, TValue>
- */
- protected function getArrayableItems($items)
- {
- return is_null($items) || is_scalar($items) || $items instanceof UnitEnum
- ? Arr::wrap($items)
- : Arr::from($items);
- }
- /**
- * Get an operator checker callback.
- *
- * @param callable|string $key
- * @param string|null $operator
- * @param mixed $value
- * @return \Closure
- */
- protected function operatorForWhere($key, $operator = null, $value = null)
- {
- if ($this->useAsCallable($key)) {
- return $key;
- }
- if (func_num_args() === 1) {
- $value = true;
- $operator = '=';
- }
- if (func_num_args() === 2) {
- $value = $operator;
- $operator = '=';
- }
- return function ($item) use ($key, $operator, $value) {
- $retrieved = enum_value(data_get($item, $key));
- $value = enum_value($value);
- $strings = array_filter([$retrieved, $value], function ($value) {
- return match (true) {
- is_string($value) => true,
- $value instanceof \Stringable => true,
- default => false,
- };
- });
- if (count($strings) < 2 && count(array_filter([$retrieved, $value], 'is_object')) == 1) {
- return in_array($operator, ['!=', '<>', '!==']);
- }
- switch ($operator) {
- default:
- case '=':
- case '==': return $retrieved == $value;
- case '!=':
- case '<>': return $retrieved != $value;
- case '<': return $retrieved < $value;
- case '>': return $retrieved > $value;
- case '<=': return $retrieved <= $value;
- case '>=': return $retrieved >= $value;
- case '===': return $retrieved === $value;
- case '!==': return $retrieved !== $value;
- case '<=>': return $retrieved <=> $value;
- }
- };
- }
- /**
- * Determine if the given value is callable, but not a string.
- *
- * @param mixed $value
- * @return bool
- */
- protected function useAsCallable($value)
- {
- return ! is_string($value) && is_callable($value);
- }
- /**
- * Get a value retrieving callback.
- *
- * @param callable|string|null $value
- * @return callable
- */
- protected function valueRetriever($value)
- {
- if ($this->useAsCallable($value)) {
- return $value;
- }
- return fn ($item) => data_get($item, $value);
- }
- /**
- * Make a function to check an item's equality.
- *
- * @param mixed $value
- * @return \Closure(mixed): bool
- */
- protected function equality($value)
- {
- return fn ($item) => $item === $value;
- }
- /**
- * Make a function using another function, by negating its result.
- *
- * @param \Closure $callback
- * @return \Closure
- */
- protected function negate(Closure $callback)
- {
- return fn (...$params) => ! $callback(...$params);
- }
- /**
- * Make a function that returns what's passed to it.
- *
- * @return \Closure(TValue): TValue
- */
- protected function identity()
- {
- return fn ($value) => $value;
- }
- }
|