12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835 |
- <?php
- declare(strict_types=1);
- /**
- * This file is part of Hyperf.
- *
- * @link https://www.hyperf.io
- * @document https://hyperf.wiki
- * @contact group@hyperf.io
- * @license https://github.com/hyperf/hyperf/blob/master/LICENSE
- */
- namespace Hyperf\Utils;
- use ArrayAccess;
- use ArrayIterator;
- use CachingIterator;
- use Countable;
- use Exception;
- use Hyperf\Macroable\Macroable;
- use Hyperf\Utils\Contracts\Arrayable;
- use Hyperf\Utils\Contracts\Jsonable;
- use IteratorAggregate;
- use JsonSerializable;
- use stdClass;
- use Symfony\Component\VarDumper\VarDumper;
- use Traversable;
- /**
- * Most of the methods in this file come from illuminate/support,
- * thanks Laravel Team provide such a useful class.
- *
- * @template TKey of array-key
- * @template TValue
- *
- * @implements ArrayAccess<TKey, TValue>
- * @implements Arrayable<TKey, TValue>
- * @implements IteratorAggregate<TKey, TValue>
- *
- * @property HigherOrderCollectionProxy $average
- * @property HigherOrderCollectionProxy $avg
- * @property HigherOrderCollectionProxy $contains
- * @property HigherOrderCollectionProxy $each
- * @property HigherOrderCollectionProxy $every
- * @property HigherOrderCollectionProxy $filter
- * @property HigherOrderCollectionProxy $first
- * @property HigherOrderCollectionProxy $flatMap
- * @property HigherOrderCollectionProxy $groupBy
- * @property HigherOrderCollectionProxy $keyBy
- * @property HigherOrderCollectionProxy $map
- * @property HigherOrderCollectionProxy $max
- * @property HigherOrderCollectionProxy $min
- * @property HigherOrderCollectionProxy $partition
- * @property HigherOrderCollectionProxy $reject
- * @property HigherOrderCollectionProxy $sortBy
- * @property HigherOrderCollectionProxy $sortByDesc
- * @property HigherOrderCollectionProxy $sum
- * @property HigherOrderCollectionProxy $unique
- */
- class Collection implements ArrayAccess, Arrayable, Countable, IteratorAggregate, Jsonable, JsonSerializable
- {
- use Macroable;
- /**
- * The items contained in the collection.
- *
- * @var array<TKey, TValue>
- */
- protected $items = [];
- /**
- * The methods that can be proxied.
- *
- * @var string[]
- */
- protected static $proxies
- = [
- 'average',
- 'avg',
- 'contains',
- 'each',
- 'every',
- 'filter',
- 'first',
- 'flatMap',
- 'groupBy',
- 'keyBy',
- 'map',
- 'max',
- 'min',
- 'partition',
- 'reject',
- 'sortBy',
- 'sortByDesc',
- 'sum',
- 'unique',
- ];
- /**
- * Create a new collection.
- * @param null|iterable<TKey,TValue>|Jsonable|JsonSerializable $items
- */
- public function __construct($items = [])
- {
- $this->items = $this->getArrayableItems($items);
- }
- /**
- * Convert the collection to its string representation.
- */
- public function __toString(): string
- {
- return $this->toJson();
- }
- /**
- * Dynamically access collection proxies.
- *
- * @throws \Exception
- */
- public function __get(string $key)
- {
- if (! in_array($key, static::$proxies)) {
- throw new Exception("Property [{$key}] does not exist on this collection instance.");
- }
- return new HigherOrderCollectionProxy($this, $key);
- }
- /**
- * @param null|iterable<TKey,TValue>|Jsonable|JsonSerializable $items
- * @return static<TKey, TValue>
- */
- public function fill($items = [])
- {
- $this->items = $this->getArrayableItems($items);
- return $this;
- }
- /**
- * Create a new collection instance if the value isn't one already.
- *
- * @template TMakeKey of array-key
- * @template TMakeValue
- *
- * @param null|Arrayable<TMakeKey, TMakeValue>|iterable<TMakeKey, TMakeValue>|Jsonable|JsonSerializable $items
- * @return static<TMakeKey, TMakeValue>
- */
- public static function make($items = []): self
- {
- return new static($items);
- }
- /**
- * Wrap the given value in a collection if applicable.
- *
- * @template TWrapKey of array-key
- * @template TWrapValue
- *
- * @param iterable<TWrapKey, TWrapValue> $value
- * @return static<TWrapKey, TWrapValue>
- */
- public static function wrap($value): self
- {
- return $value instanceof self ? new static($value) : new static(Arr::wrap($value));
- }
- /**
- * Get the underlying items from the given collection if applicable.
- *
- * @template TUnwrapKey of array-key
- * @template TUnwrapValue
- *
- * @param array<TUnwrapKey, TUnwrapValue>|static<TUnwrapKey, TUnwrapValue> $value
- * @return array<TUnwrapKey, TUnwrapValue>
- */
- public static function unwrap($value): array
- {
- return $value instanceof self ? $value->all() : $value;
- }
- /**
- * Create a new collection by invoking the callback a given amount of times.
- *
- * @template TTimesValue
- *
- * @param (callable(int): TTimesValue)|null $callback
- * @return static<int, TTimesValue>
- */
- public static function times(int $number, callable $callback = null): self
- {
- if ($number < 1) {
- return new static();
- }
- if (is_null($callback)) {
- return new static(range(1, $number));
- }
- return (new static(range(1, $number)))->map($callback);
- }
- /**
- * Get all of the items in the collection.
- *
- * @return array<TKey, TValue>
- */
- public function all(): array
- {
- return $this->items;
- }
- /**
- * Get the average value of a given key.
- *
- * @param (callable(TValue): float|int)|string|null $callback
- */
- 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;
- }
- }
- /**
- * Alias for the "avg" method.
- *
- * @param (callable(TValue): float|int)|string|null $callback
- * @return null|float|int
- */
- public function average($callback = null)
- {
- return $this->avg($callback);
- }
- /**
- * Get the median of a given key.
- *
- * @param null|array<array-key, string>|string $key
- */
- 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 null|array<array-key, string>|string $key
- * @return null|array<int, float|int>
- */
- public function mode($key = null)
- {
- if ($this->count() == 0) {
- return null;
- }
- $collection = isset($key) ? $this->pluck($key) : $this;
- /**
- * @template TValue of array-key
- * @var static<TValue, int> $counts
- */
- $counts = new self();
- $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<int, mixed>
- */
- public function collapse(): self
- {
- return new static(Arr::collapse($this->items));
- }
- /**
- * Determine if an item exists in the collection.
- *
- * @param null|mixed $operator
- * @param null|mixed $value
- * @param (callable(TValue): bool)|TValue|string $key
- */
- public function contains($key, $operator = null, $value = null): bool
- {
- 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 exists in the collection using strict comparison.
- *
- * @param null|TValue $value
- * @param callable|TKey|TValue $key
- */
- public function containsStrict($key, $value = null): bool
- {
- if (func_num_args() === 2) {
- return $this->contains(function ($item) use ($key, $value) {
- return data_get($item, $key) === $value;
- });
- }
- if ($this->useAsCallable($key)) {
- return ! is_null($this->first($key));
- }
- return in_array($key, $this->items, true);
- }
- /**
- * Cross join with the given lists, returning all possible permutations.
- */
- public function crossJoin(...$lists): self
- {
- return new static(Arr::crossJoin($this->items, ...array_map([$this, 'getArrayableItems'], $lists)));
- }
- /**
- * Dump the collection and end the script.
- */
- public function dd(...$args): void
- {
- call_user_func_array([$this, 'dump'], $args);
- exit(1);
- }
- /**
- * Dump the collection.
- */
- public function dump(): self
- {
- $params = (new static(func_get_args()));
- $params->push($this)->each(function ($item) {
- if (! class_exists(VarDumper::class)) {
- throw new \RuntimeException('symfony/var-dumper package required, please require the package via "composer require symfony/var-dumper"');
- }
- VarDumper::dump($item);
- });
- return $this;
- }
- /**
- * Get the items in the collection that are not present in the given items.
- *
- * @param Arrayable<array-key, TValue>|iterable<array-key, TValue> $items
- * @return static<TKey, TValue>
- */
- public function diff($items): self
- {
- return new static(array_diff($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Get the items in the collection that are not present in the given items.
- *
- * @param Arrayable<array-key, TValue>|iterable<array-key, TValue> $items
- * @param callable(TValue): int $callback
- * @return static<TKey, TValue>
- */
- public function diffUsing($items, callable $callback): self
- {
- 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 Arrayable<TKey, TValue>|iterable<TKey, TValue> $items
- * @return static<TKey, TValue>
- */
- public function diffAssoc($items): self
- {
- 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.
- *
- * @param Arrayable<TKey, TValue>|iterable<TKey, TValue> $items
- * @param callable(TKey): int $callback
- * @return static<TKey, TValue>
- */
- public function diffAssocUsing($items, callable $callback): self
- {
- 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 Arrayable<TKey, TValue>|iterable<TKey, TValue> $items
- * @return static<TKey, TValue>
- */
- public function diffKeys($items): self
- {
- 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.
- *
- * @param Arrayable<TKey, TValue>|iterable<TKey, TValue> $items
- * @param callable(TKey): int $callback
- * @return static<TKey, TValue>
- */
- public function diffKeysUsing($items, callable $callback): self
- {
- return new static(array_diff_ukey($this->items, $this->getArrayableItems($items), $callback));
- }
- /**
- * Execute a callback over each item.
- * @param callable(TValue,TKey): mixed $callback
- */
- public function each(callable $callback): self
- {
- foreach ($this->items 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<TKey, TValue>
- */
- public function eachSpread(callable $callback): self
- {
- return $this->each(function ($chunk, $key) use ($callback) {
- $chunk[] = $key;
- return $callback(...$chunk);
- });
- }
- /**
- * Determine if all items in the collection pass the given test.
- *
- * @param (callable(TValue, TKey): bool)|TValue|string $key
- * @param mixed $operator
- * @param mixed $value
- */
- public function every($key, $operator = null, $value = null): bool
- {
- if (func_num_args() === 1) {
- $callback = $this->valueRetriever($key);
- foreach ($this->items as $k => $v) {
- if (! $callback($v, $k)) {
- return false;
- }
- }
- return true;
- }
- return $this->every($this->operatorForWhere(...func_get_args()));
- }
- /**
- * Get all items except for those with the specified keys.
- *
- * @param array<array-key, TKey>|static<array-key, TKey> $keys
- * @return static<TKey, TValue>
- */
- public function except($keys): self
- {
- if ($keys instanceof self) {
- $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(TValue, TKey): bool|null $callback
- * @return static<TKey, TValue>
- */
- public function filter(callable $callback = null): self
- {
- if ($callback) {
- return new static(Arr::where($this->items, $callback));
- }
- return new static(array_filter($this->items));
- }
- /**
- * Apply the callback if the value is truthy.
- *
- * @param callable($this): $this $callback
- * @param callable($this): $this $default
- * @return $this
- */
- public function when(bool $value, callable $callback, callable $default = null): self
- {
- if ($value) {
- return $callback($this, $value);
- }
- if ($default) {
- return $default($this, $value);
- }
- return $this;
- }
- /**
- * Apply the callback if the value is falsy.
- *
- * @param callable($this): $this $callback
- * @param callable($this): $this|null $default
- * @return $this
- */
- public function unless(bool $value, callable $callback, callable $default = null): self
- {
- return $this->when(! $value, $callback, $default);
- }
- /**
- * Filter items by the given key value pair.
- *
- * @param mixed $operator
- * @param mixed $value
- * @return static<TKey, TValue>
- */
- public function where(string $key, $operator = null, $value = null): self
- {
- return $this->filter($this->operatorForWhere(...func_get_args()));
- }
- /**
- * Filter items by the given key value pair using strict comparison.
- *
- * @param mixed $value
- * @return static<TKey, TValue>
- */
- public function whereStrict(string $key, $value): self
- {
- return $this->where($key, '===', $value);
- }
- /**
- * Filter items by the given key value pair.
- *
- * @param Arrayable|iterable $values
- * @return static<TKey, TValue>
- */
- public function whereIn(string $key, $values, bool $strict = false): self
- {
- $values = $this->getArrayableItems($values);
- return $this->filter(function ($item) use ($key, $values, $strict) {
- return in_array(data_get($item, $key), $values, $strict);
- });
- }
- /**
- * Filter items by the given key value pair using strict comparison.
- *
- * @param Arrayable|iterable $values
- * @return static<TKey, TValue>
- */
- public function whereInStrict(string $key, $values): self
- {
- return $this->whereIn($key, $values, true);
- }
- /**
- * Filter items by the given key value pair.
- *
- * @param Arrayable|iterable $values
- * @return static<TKey, TValue>
- */
- public function whereNotIn(string $key, $values, bool $strict = false): self
- {
- $values = $this->getArrayableItems($values);
- return $this->reject(function ($item) use ($key, $values, $strict) {
- return in_array(data_get($item, $key), $values, $strict);
- });
- }
- /**
- * Filter items by the given key value pair using strict comparison.
- *
- * @param Arrayable|iterable $values
- * @return static<TKey, TValue>
- */
- public function whereNotInStrict(string $key, $values): self
- {
- return $this->whereNotIn($key, $values, true);
- }
- /**
- * Filter the items, removing any items that don't match the given type.
- *
- * @param class-string $type
- * @return static<TKey, TValue>
- */
- public function whereInstanceOf(string $type): self
- {
- return $this->filter(function ($value) use ($type) {
- return $value instanceof $type;
- });
- }
- /**
- * Get the first item from the collection.
- *
- * @template TFirstDefault
- *
- * @param callable(TValue, TKey): bool|null $callback
- * @param TFirstDefault|callable(): TFirstDefault $default
- * @return TFirstDefault|TValue
- */
- public function first(callable $callback = null, $default = null)
- {
- return Arr::first($this->items, $callback, $default);
- }
- /**
- * Get the first item by the given key value pair.
- *
- * @param mixed $operator
- * @param mixed $value
- * @return null|TValue
- */
- public function firstWhere(string $key, $operator, $value = null)
- {
- return $this->first($this->operatorForWhere(...func_get_args()));
- }
- /**
- * Get a flattened array of the items in the collection.
- *
- * @param float|int $depth
- * @return static<int, mixed>
- */
- public function flatten($depth = INF): self
- {
- return new static(Arr::flatten($this->items, $depth));
- }
- /**
- * Flip the items in the collection.
- *
- * @return static<TKey, TValue>
- */
- public function flip(): self
- {
- return new static(array_flip($this->items));
- }
- /**
- * Remove an item from the collection by key.
- *
- * @param array<array-key, TKey>|TKey $keys
- * @return $this
- */
- public function forget($keys): self
- {
- foreach ((array) $keys as $key) {
- $this->offsetUnset($key);
- }
- return $this;
- }
- /**
- * Get an item from the collection by key.
- *
- * @template TGetDefault
- *
- * @param TKey $key
- * @param TGetDefault|(\Closure(): TGetDefault) $default
- * @return TGetDefault|TValue
- */
- public function get($key, $default = null)
- {
- if ($this->offsetExists($key)) {
- return $this->items[$key];
- }
- return value($default);
- }
- /**
- * Group an associative array by a field or using a callback.
- * @param mixed $groupBy
- */
- public function groupBy($groupBy, bool $preserveKeys = false): self
- {
- if (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(TValue, TKey): array-key)|array|string $keyBy
- * @return static<TKey, array<TKey, TValue>>
- */
- public function keyBy($keyBy): self
- {
- $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 array<array-key, TKey>|TKey $key
- */
- public function has($key): bool
- {
- $keys = is_array($key) ? $key : func_get_args();
- foreach ($keys as $value) {
- if (! $this->offsetExists($value)) {
- return false;
- }
- }
- return true;
- }
- /**
- * Concatenate values of a given key as a string.
- */
- public function implode(string $value, string $glue = null): string
- {
- $first = $this->first();
- if (is_array($first) || is_object($first)) {
- return implode($glue, $this->pluck($value)->all());
- }
- return implode($value, $this->items);
- }
- /**
- * Intersect the collection with the given items.
- *
- * @param Arrayable<TKey, TValue>|iterable<TKey, TValue> $items
- * @return static<TKey, TValue>
- */
- public function intersect($items): self
- {
- return new static(array_intersect($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Intersect the collection with the given items by key.
- * @param Arrayable<TKey, TValue>|iterable<TKey, TValue> $items
- * @return static<TKey, TValue>
- */
- public function intersectByKeys($items): self
- {
- return new static(array_intersect_key($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Determine if the collection is empty or not.
- */
- public function isEmpty(): bool
- {
- return empty($this->items);
- }
- /**
- * Determine if the collection is not empty.
- */
- public function isNotEmpty(): bool
- {
- return ! $this->isEmpty();
- }
- /**
- * Get the keys of the collection items.
- * @return static<int, TKey>
- */
- public function keys(): self
- {
- return new static(array_keys($this->items));
- }
- /**
- * Get the last item from the collection.
- *
- * @template TLastDefault
- *
- * @param (callable(TValue, TKey): bool)|null $callback
- * @param TLastDefault|(\Closure(): TLastDefault) $default
- * @return TLastDefault|TValue
- */
- public function last(callable $callback = null, $default = null)
- {
- return Arr::last($this->items, $callback, $default);
- }
- /**
- * Get the values of a given key.
- *
- * @param array<array-key, string>|string $value
- * @return static<int, mixed>
- */
- public function pluck($value, ?string $key = null): self
- {
- return new static(Arr::pluck($this->items, $value, $key));
- }
- /**
- * Run a map over each of the items.
- *
- * @template TMapValue
- *
- * @param callable(TValue, TKey): TMapValue $callback
- * @return static<TKey, TMapValue>
- */
- public function map(callable $callback): self
- {
- $keys = array_keys($this->items);
- $items = array_map($callback, $this->items, $keys);
- return new static(array_combine($keys, $items));
- }
- /**
- * 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): self
- {
- return $this->map(function ($chunk, $key) use ($callback) {
- $chunk[] = $key;
- return $callback(...$chunk);
- });
- }
- /**
- * Run a dictionary map over the items.
- * The callback should return an associative array with a single key/value pair.
- *
- * @template TMapToDictionaryKey of array-key
- * @template TMapToDictionaryValue
- *
- * @param callable(TValue, TKey): array<TMapToDictionaryKey, TMapToDictionaryValue> $callback
- * @return static<TMapToDictionaryKey, array<int, TMapToDictionaryValue>>
- */
- public function mapToDictionary(callable $callback): self
- {
- $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 a grouping map over the items.
- * The callback should return an associative array with a single key/value pair.
- */
- public function mapToGroups(callable $callback): self
- {
- $groups = $this->mapToDictionary($callback);
- return $groups->map([$this, 'make']);
- }
- /**
- * Run an associative map over each of the items.
- * The callback should return an associative array with a single key/value pair.
- *
- * @template TMapWithKeysKey of array-key
- * @template TMapWithKeysValue
- *
- * @param callable(TValue, TKey): array<TMapWithKeysKey, TMapWithKeysValue> $callback
- * @return static<TMapWithKeysKey, TMapWithKeysValue>
- */
- public function mapWithKeys(callable $callback): self
- {
- $result = [];
- foreach ($this->items as $key => $value) {
- $assoc = $callback($value, $key);
- foreach ($assoc as $mapKey => $mapValue) {
- $result[$mapKey] = $mapValue;
- }
- }
- return new static($result);
- }
- /**
- * Map a collection and flatten the result by a single level.
- *
- * @param callable(TValue, TKey): mixed $callback
- * @return static<int, mixed>
- */
- public function flatMap(callable $callback): self
- {
- return $this->map($callback)->collapse();
- }
- /**
- * Map the values into a new class.
- *
- * @param class-string $class
- * @return static<TKey, mixed>
- */
- public function mapInto(string $class): self
- {
- return $this->map(function ($value, $key) use ($class) {
- return new $class($value, $key);
- });
- }
- /**
- * Get the max value of a given key.
- *
- * @param (callable(TValue):mixed)|string|null $callback
- * @return TValue
- */
- public function max($callback = null)
- {
- $callback = $this->valueRetriever($callback);
- return $this->filter(function ($value) {
- return ! is_null($value);
- })->reduce(function ($result, $item) use ($callback) {
- $value = $callback($item);
- return is_null($result) || $value > $result ? $value : $result;
- });
- }
- /**
- * Merge the collection with the given items.
- * @param Arrayable<TKey, TValue>|iterable<TKey, TValue> $items
- * @return static<TKey, TValue>
- */
- public function merge($items): self
- {
- return new static(array_merge($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Create a collection by using this collection for keys and another for its values.
- *
- * @template TCombineValue
- *
- * @param Arrayable<array-key, TCombineValue>|iterable<array-key, TCombineValue> $values
- * @return static<TKey, TCombineValue>
- */
- public function combine($values): self
- {
- return new static(array_combine($this->all(), $this->getArrayableItems($values)));
- }
- /**
- * Union the collection with the given items.
- *
- * @param Arrayable<TKey, TValue>|iterable<TKey, TValue> $items
- * @return static<TKey, TValue>
- */
- public function union($items): self
- {
- return new static($this->items + $this->getArrayableItems($items));
- }
- /**
- * Get the min value of a given key.
- *
- * @param (callable(TValue):mixed)|string|null $callback
- * @return TValue
- */
- public function min($callback = null)
- {
- $callback = $this->valueRetriever($callback);
- return $this->map(function ($value) use ($callback) {
- return $callback($value);
- })->filter(function ($value) {
- return ! is_null($value);
- })->reduce(function ($result, $value) {
- return is_null($result) || $value < $result ? $value : $result;
- });
- }
- /**
- * Create a new collection consisting of every n-th element.
- *
- * @return static<TKey, TValue>
- */
- public function nth(int $step, int $offset = 0): self
- {
- $new = [];
- $position = 0;
- foreach ($this->items as $item) {
- if ($position % $step === $offset) {
- $new[] = $item;
- }
- ++$position;
- }
- return new static($new);
- }
- /**
- * Get the items with the specified keys.
- *
- * @param null|array<array-key, TKey>|static<array-key, TKey>|string $keys
- * @return static<TKey, TValue>
- */
- public function only($keys): self
- {
- if (is_null($keys)) {
- return new static($this->items);
- }
- if ($keys instanceof self) {
- $keys = $keys->all();
- }
- $keys = is_array($keys) ? $keys : func_get_args();
- return new static(Arr::only($this->items, $keys));
- }
- /**
- * "Paginate" the collection by slicing it into a smaller collection.
- */
- public function forPage(int $page, int $perPage): self
- {
- $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 null|string|TValue $operator
- * @param null|TValue $value
- * @return static<int, static<TKey, TValue>>
- */
- public function partition($key, $operator = null, $value = null): self
- {
- $partitions = [new static(), new static()];
- $callback = func_num_args() === 1 ? $this->valueRetriever($key) : $this->operatorForWhere(...func_get_args());
- foreach ($this->items as $key => $item) {
- $partitions[(int) ! $callback($item, $key)][$key] = $item;
- }
- return new static($partitions);
- }
- /**
- * 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);
- }
- /**
- * Get and remove the last item from the collection.
- */
- public function pop()
- {
- return array_pop($this->items);
- }
- /**
- * Push an item onto the beginning of the collection.
- *
- * @param TValue $value
- * @param null|TKey $key
- * @return $this
- */
- public function prepend($value, $key = null): self
- {
- $this->items = Arr::prepend($this->items, $value, $key);
- return $this;
- }
- /**
- * Push an item onto the end of the collection.
- *
- * @param TValue $value
- * @return $this
- */
- public function push($value): self
- {
- $this->offsetSet(null, $value);
- return $this;
- }
- /**
- * Push all of the given items onto the collection.
- *
- * @param iterable<array-key, TValue> $source
- * @return static<TKey, TValue>
- */
- public function concat($source): self
- {
- $result = new static($this);
- foreach ($source as $item) {
- $result->push($item);
- }
- return $result;
- }
- /**
- * Get and remove an item from the collection.
- *
- * @template TPullDefault
- *
- * @param TKey $key
- * @param TPullDefault|(\Closure(): TPullDefault) $default
- * @return TPullDefault|TValue
- */
- public function pull($key, $default = null)
- {
- return Arr::pull($this->items, $key, $default);
- }
- /**
- * Put an item in the collection by key.
- *
- * @param TKey $key
- * @param TValue $value
- * @return $this
- */
- public function put($key, $value): self
- {
- $this->offsetSet($key, $value);
- return $this;
- }
- /**
- * Get one or a specified number of items randomly from the collection.
- *
- * @throws \InvalidArgumentException
- * @return static<int, TValue>|TValue
- */
- public function random(int $number = null)
- {
- if (is_null($number)) {
- return Arr::random($this->items);
- }
- return new static(Arr::random($this->items, $number));
- }
- /**
- * Reduce the collection to a single value.
- *
- * @template TReduceInitial
- * @template TReduceReturnType
- *
- * @param callable(TReduceInitial|TReduceReturnType, TValue): TReduceReturnType $callback
- * @param TReduceInitial $initial
- * @return TReduceInitial|TReduceReturnType
- */
- public function reduce(callable $callback, $initial = null)
- {
- return array_reduce($this->items, $callback, $initial);
- }
- /**
- * Create a collection of all elements that do not pass a given truth test.
- *
- * @param callable(TValue, TKey): bool|bool $callback
- * @return static<TKey, TValue>
- */
- public function reject($callback): self
- {
- if ($this->useAsCallable($callback)) {
- return $this->filter(function ($value, $key) use ($callback) {
- return ! $callback($value, $key);
- });
- }
- return $this->filter(function ($item) use ($callback) {
- return $item != $callback;
- });
- }
- /**
- * Reverse items order.
- *
- * @return static<TKey, TValue>
- */
- public function reverse(): self
- {
- return new static(array_reverse($this->items, true));
- }
- /**
- * Search the collection for a given value and return the corresponding key if successful.
- *
- * @param TValue|(callable(TValue,TKey): bool) $value
- * @return bool|TKey
- */
- public function search($value, bool $strict = false)
- {
- if (! $this->useAsCallable($value)) {
- return array_search($value, $this->items, $strict);
- }
- foreach ($this->items as $key => $item) {
- if (call_user_func($value, $item, $key)) {
- return $key;
- }
- }
- return false;
- }
- /**
- * Get and remove the first item from the collection.
- *
- * @return null|TValue
- */
- public function shift()
- {
- return array_shift($this->items);
- }
- /**
- * Shuffle the items in the collection.
- *
- * @return static<TKey, TValue>
- */
- public function shuffle(int $seed = null): self
- {
- return new static(Arr::shuffle($this->items, $seed));
- }
- /**
- * Slice the underlying collection array.
- *
- * @return static<TKey, TValue>
- */
- public function slice(int $offset, int $length = null): self
- {
- return new static(array_slice($this->items, $offset, $length, true));
- }
- /**
- * Split a collection into a certain number of groups.
- *
- * @return static<int, static<TKey, TValue>>
- */
- public function split(int $numberOfGroups): self
- {
- if ($this->isEmpty()) {
- return new static();
- }
- $groups = new static();
- $groupSize = (int) 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;
- }
- /**
- * Chunk the underlying collection array.
- *
- * @return static<int, static<TKey, TValue>>
- */
- public function chunk(int $size): self
- {
- if ($size <= 0) {
- return new static();
- }
- $chunks = [];
- foreach (array_chunk($this->items, $size, true) as $chunk) {
- $chunks[] = new static($chunk);
- }
- return new static($chunks);
- }
- /**
- * Sort through each item with a callback.
- *
- * @param callable(TValue, TValue): int $callback
- * @return static<TKey, TValue>
- */
- public function sort(callable $callback = null): self
- {
- $items = $this->items;
- $callback ? uasort($items, $callback) : asort($items);
- return new static($items);
- }
- /**
- * Sort the collection using the given callback.
- *
- * @param (callable(TValue, TKey): mixed)|string|array $callback
- * @return static<TKey, TValue>
- */
- public function sortBy($callback, int $options = SORT_REGULAR, bool $descending = false): self
- {
- 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
- // and grab the corresponding values for the sorted keys from this array.
- foreach ($this->items as $key => $value) {
- $results[$key] = $callback($value, $key);
- }
- $descending ? arsort($results, $options) : asort($results, $options);
- // Once we have sorted all of the keys in the array, we will loop through them
- // and grab the corresponding model so we can set the underlying items list
- // to the sorted version. Then we'll just return the collection instance.
- foreach (array_keys($results) as $key) {
- $results[$key] = $this->items[$key];
- }
- return new static($results);
- }
- /**
- * Sort the collection in descending order using the given callback.
- *
- * @param (callable(TValue, TKey): mixed)|string $callback
- * @return static<TKey, TValue>
- */
- public function sortByDesc($callback, int $options = SORT_REGULAR): self
- {
- return $this->sortBy($callback, $options, true);
- }
- /**
- * Sort the collection keys.
- *
- * @return static<TKey, TValue>
- */
- public function sortKeys(int $options = SORT_REGULAR, bool $descending = false): self
- {
- $items = $this->items;
- $descending ? krsort($items, $options) : ksort($items, $options);
- return new static($items);
- }
- /**
- * Sort the collection keys in descending order.
- *
- * @return static<TKey, TValue>
- */
- public function sortKeysDesc(int $options = SORT_REGULAR): self
- {
- return $this->sortKeys($options, true);
- }
- /**
- * Splice a portion of the underlying collection array.
- *
- * @param array<array-key, TValue> $replacement
- * @return static<TKey, TValue>
- */
- public function splice(int $offset, int $length = null, $replacement = []): self
- {
- if (func_num_args() === 1) {
- return new static(array_splice($this->items, $offset));
- }
- return new static(array_splice($this->items, $offset, $length, $replacement));
- }
- /**
- * Get the sum of the given values.
- *
- * @param (callable(TValue): mixed)|string|null $callback
- * @return mixed
- */
- public function sum($callback = null)
- {
- if (is_null($callback)) {
- return array_sum($this->items);
- }
- $callback = $this->valueRetriever($callback);
- return $this->reduce(function ($result, $item) use ($callback) {
- return $result + $callback($item);
- }, 0);
- }
- /**
- * Take the first or last {$limit} items.
- *
- * @return static<TKey, TValue>
- */
- public function take(int $limit): self
- {
- if ($limit < 0) {
- return $this->slice($limit, abs($limit));
- }
- return $this->slice(0, $limit);
- }
- /**
- * Pass the collection to the given callback and then return it.
- *
- * @param callable(static<TKey,TValue>): mixed $callback
- * @return $this
- */
- public function tap(callable $callback): self
- {
- $callback(new static($this->items));
- return $this;
- }
- /**
- * Transform each item in the collection using a callback.
- *
- * @param callable(TValue, TKey): TValue $callback
- * @return $this
- */
- public function transform(callable $callback): self
- {
- $this->items = $this->map($callback)->all();
- return $this;
- }
- /**
- * Return only unique items from the collection array.
- *
- * @param (callable(TValue, TKey): bool)|string|null $key
- * @return static<TKey, TValue>
- */
- public function unique($key = null, bool $strict = false): self
- {
- $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): bool)|string|null $key
- * @return static<TKey, TValue>
- */
- public function uniqueStrict($key = null): self
- {
- return $this->unique($key, true);
- }
- /**
- * Reset the keys on the underlying array.
- *
- * @return static<TKey, TValue>
- */
- public function values(): self
- {
- 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]].
- *
- * @template TZipValue
- *
- * @param Arrayable<array-key, TZipValue>|iterable<array-key, TZipValue> ...$items
- * @return static<int, static<int, TValue|TZipValue>>
- */
- public function zip($items): self
- {
- $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(call_user_func_array('array_map', $params));
- }
- /**
- * Pad collection to the specified length with a value.
- *
- * @template TPadValue
- *
- * @param TPadValue $value
- * @return static<int, TPadValue|TValue>
- */
- public function pad(int $size, $value): self
- {
- return new static(array_pad($this->items, $size, $value));
- }
- /**
- * Get the collection of items as a plain array.
- *
- * @return array<TKey, mixed>
- */
- public function toArray(): array
- {
- return array_map(function ($value) {
- return $value instanceof Arrayable ? $value->toArray() : $value;
- }, $this->items);
- }
- /**
- * Convert the object into something JSON serializable.
- *
- * @return array<TKey, mixed>
- */
- public function jsonSerialize(): array
- {
- return array_map(function ($value) {
- if ($value instanceof JsonSerializable) {
- return $value->jsonSerialize();
- }
- if ($value instanceof Jsonable) {
- return json_decode($value->__toString(), true);
- }
- if ($value instanceof Arrayable) {
- return $value->toArray();
- }
- return $value;
- }, $this->items);
- }
- /**
- * Get the collection of items as JSON.
- */
- public function toJson(int $options = 0): string
- {
- return json_encode($this->jsonSerialize(), $options);
- }
- /**
- * Get an iterator for the items.
- *
- * @return ArrayIterator<TKey, TValue>
- */
- public function getIterator(): ArrayIterator
- {
- return new ArrayIterator($this->items);
- }
- /**
- * Get a CachingIterator instance.
- */
- public function getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING): CachingIterator
- {
- return new CachingIterator($this->getIterator(), $flags);
- }
- /**
- * Count the number of items in the collection.
- */
- public function count(): int
- {
- return count($this->items);
- }
- /**
- * Get a base Support collection instance from this collection.
- *
- * @return Collection<TKey, TValue>
- */
- public function toBase()
- {
- return new self($this);
- }
- /**
- * Determine if an item exists at an offset.
- *
- * @param TKey $key
- * @return bool
- */
- public function offsetExists($key)
- {
- return array_key_exists($key, $this->items);
- }
- /**
- * Get an item at a given offset.
- *
- * @param TKey $key
- * @return TValue
- */
- public function offsetGet($key)
- {
- return $this->items[$key];
- }
- /**
- * Set the item at a given offset.
- *
- * @param null|TKey $key
- * @param TValue $value
- */
- 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 TKey $key
- */
- public function offsetUnset($key)
- {
- unset($this->items[$key]);
- }
- /**
- * Add a method to the list of proxied methods.
- */
- public static function proxy(string $method): void
- {
- static::$proxies[] = $method;
- }
- /**
- * Sort the collection using multiple 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);
- }
- /**
- * Get an operator checker callback.
- * @param mixed|string $operator
- * @param null|TValue $value
- */
- protected function operatorForWhere(string $key, $operator = null, $value = null): \Closure
- {
- if (func_num_args() === 1) {
- $value = true;
- $operator = '=';
- }
- if (func_num_args() === 2) {
- $value = $operator;
- $operator = '=';
- }
- return function ($item) use ($key, $operator, $value) {
- $retrieved = data_get($item, $key);
- $strings = array_filter([$retrieved, $value], function ($value) {
- return is_string($value) || (is_object($value) && method_exists($value, '__toString'));
- });
- 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;
- }
- };
- }
- /**
- * Determine if the given value is callable, but not a string.
- * @param mixed $value
- */
- protected function useAsCallable($value): bool
- {
- return ! is_string($value) && is_callable($value);
- }
- /**
- * Get a value retrieving callback.
- * @param mixed $value
- */
- protected function valueRetriever($value): callable
- {
- if ($this->useAsCallable($value)) {
- return $value;
- }
- return function ($item) use ($value) {
- return data_get($item, $value);
- };
- }
- /**
- * Results array of items from Collection or Arrayable.
- * @param null|Arrayable<TKey,TValue>|iterable<TKey,TValue>|Jsonable|JsonSerializable|static<TKey,TValue> $items
- * @return array<TKey,TValue>
- */
- protected function getArrayableItems($items): array
- {
- if (is_array($items)) {
- return $items;
- }
- if ($items instanceof self) {
- return $items->all();
- }
- if ($items instanceof Arrayable) {
- return $items->toArray();
- }
- if ($items instanceof Jsonable) {
- return json_decode($items->__toString(), true);
- }
- if ($items instanceof JsonSerializable) {
- return $items->jsonSerialize();
- }
- if ($items instanceof Traversable) {
- return iterator_to_array($items);
- }
- return (array) $items;
- }
- }
|