| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798 |
- <?php
- namespace Illuminate\Support;
- use stdClass;
- use Countable;
- use Exception;
- use ArrayAccess;
- use Traversable;
- use ArrayIterator;
- use CachingIterator;
- use JsonSerializable;
- use IteratorAggregate;
- use Illuminate\Support\Debug\Dumper;
- use Illuminate\Support\Traits\Macroable;
- use Illuminate\Contracts\Support\Jsonable;
- use Illuminate\Contracts\Support\Arrayable;
- class Collection implements ArrayAccess, Arrayable, Countable, IteratorAggregate, Jsonable, JsonSerializable
- {
- use Macroable;
- /**
- * The items contained in the collection.
- *
- * @var array
- */
- protected $items = [];
- /**
- * The methods that can be proxied.
- *
- * @var array
- */
- protected static $proxies = [
- 'average', 'avg', 'contains', 'each', 'every', 'filter', 'first', 'flatMap',
- 'keyBy', 'map', 'partition', 'reject', 'sortBy', 'sortByDesc', 'sum', 'unique',
- ];
- /**
- * Create a new collection.
- *
- * @param mixed $items
- * @return void
- */
- public function __construct($items = [])
- {
- $this->items = $this->getArrayableItems($items);
- }
- /**
- * Create a new collection instance if the value isn't one already.
- *
- * @param mixed $items
- * @return static
- */
- public static function make($items = [])
- {
- return new static($items);
- }
- /**
- * Wrap the given value in a collection if applicable.
- *
- * @param mixed $value
- * @return static
- */
- public static function wrap($value)
- {
- return $value instanceof self
- ? new static($value)
- : new static(Arr::wrap($value));
- }
- /**
- * Get the underlying items from the given collection if applicable.
- *
- * @param array|static $value
- * @return array
- */
- public static function unwrap($value)
- {
- return $value instanceof self ? $value->all() : $value;
- }
- /**
- * Create a new collection by invoking the callback a given amount of times.
- *
- * @param int $number
- * @param callable $callback
- * @return static
- */
- public static function times($number, callable $callback = null)
- {
- 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
- */
- public function all()
- {
- return $this->items;
- }
- /**
- * Get the average value of a given key.
- *
- * @param callable|string|null $callback
- * @return mixed
- */
- public function avg($callback = null)
- {
- if ($count = $this->count()) {
- return $this->sum($callback) / $count;
- }
- }
- /**
- * Alias for the "avg" method.
- *
- * @param callable|string|null $callback
- * @return mixed
- */
- public function average($callback = null)
- {
- return $this->avg($callback);
- }
- /**
- * Get the median of a given key.
- *
- * @param null $key
- * @return mixed
- */
- public function median($key = null)
- {
- $count = $this->count();
- if ($count == 0) {
- return;
- }
- $values = (isset($key) ? $this->pluck($key) : $this)
- ->sort()->values();
- $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 mixed $key
- * @return array|null
- */
- public function mode($key = null)
- {
- $count = $this->count();
- if ($count == 0) {
- return;
- }
- $collection = isset($key) ? $this->pluck($key) : $this;
- $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
- */
- public function collapse()
- {
- return new static(Arr::collapse($this->items));
- }
- /**
- * Determine if an item exists in the collection.
- *
- * @param mixed $key
- * @param mixed $operator
- * @param mixed $value
- * @return bool
- */
- public function contains($key, $operator = null, $value = null)
- {
- if (func_num_args() == 1) {
- if ($this->useAsCallable($key)) {
- $placeholder = new stdClass;
- return $this->first($key, $placeholder) !== $placeholder;
- }
- return in_array($key, $this->items);
- }
- return $this->contains($this->operatorForWhere(...func_get_args()));
- }
- /**
- * Determine if an item exists in the collection using strict comparison.
- *
- * @param mixed $key
- * @param mixed $value
- * @return bool
- */
- public function containsStrict($key, $value = null)
- {
- 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.
- *
- * @param mixed ...$lists
- * @return static
- */
- public function crossJoin(...$lists)
- {
- return new static(Arr::crossJoin(
- $this->items, ...array_map([$this, 'getArrayableItems'], $lists)
- ));
- }
- /**
- * Dump the collection and end the script.
- *
- * @return void
- */
- public function dd(...$args)
- {
- http_response_code(500);
- call_user_func_array([$this, 'dump'], $args);
- die(1);
- }
- /**
- * Dump the collection.
- *
- * @return $this
- */
- public function dump()
- {
- (new static(func_get_args()))
- ->push($this)
- ->each(function ($item) {
- (new Dumper)->dump($item);
- });
- return $this;
- }
- /**
- * Get the items in the collection that are not present in the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function diff($items)
- {
- return new static(array_diff($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Get the items in the collection whose keys and values are not present in the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function diffAssoc($items)
- {
- return new static(array_diff_assoc($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Get the items in the collection whose keys are not present in the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function diffKeys($items)
- {
- return new static(array_diff_key($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Execute a callback over each item.
- *
- * @param callable $callback
- * @return $this
- */
- public function each(callable $callback)
- {
- 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 $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 in the collection pass the given test.
- *
- * @param string|callable $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->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 \Illuminate\Support\Collection|mixed $keys
- * @return static
- */
- public function except($keys)
- {
- 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|null $callback
- * @return static
- */
- public function filter(callable $callback = null)
- {
- if ($callback) {
- return new static(Arr::where($this->items, $callback));
- }
- return new static(array_filter($this->items));
- }
- /**
- * Apply the callback if the value is truthy.
- *
- * @param bool $value
- * @param callable $callback
- * @param callable $default
- * @return mixed
- */
- public function when($value, callable $callback, callable $default = null)
- {
- if ($value) {
- return $callback($this, $value);
- } elseif ($default) {
- return $default($this, $value);
- }
- return $this;
- }
- /**
- * Apply the callback if the value is falsy.
- *
- * @param bool $value
- * @param callable $callback
- * @param callable $default
- * @return mixed
- */
- public function unless($value, callable $callback, callable $default = null)
- {
- return $this->when(! $value, $callback, $default);
- }
- /**
- * Filter items by the given key value pair.
- *
- * @param string $key
- * @param mixed $operator
- * @param mixed $value
- * @return static
- */
- public function where($key, $operator, $value = null)
- {
- return $this->filter($this->operatorForWhere(...func_get_args()));
- }
- /**
- * Get an operator checker callback.
- *
- * @param string $key
- * @param string $operator
- * @param mixed $value
- * @return \Closure
- */
- protected function operatorForWhere($key, $operator, $value = null)
- {
- 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;
- }
- };
- }
- /**
- * 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 mixed $values
- * @param bool $strict
- * @return static
- */
- public function whereIn($key, $values, $strict = false)
- {
- $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 string $key
- * @param mixed $values
- * @return static
- */
- public function whereInStrict($key, $values)
- {
- return $this->whereIn($key, $values, true);
- }
- /**
- * Filter items by the given key value pair.
- *
- * @param string $key
- * @param mixed $values
- * @param bool $strict
- * @return static
- */
- public function whereNotIn($key, $values, $strict = false)
- {
- $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 string $key
- * @param mixed $values
- * @return static
- */
- public function whereNotInStrict($key, $values)
- {
- return $this->whereNotIn($key, $values, true);
- }
- /**
- * Get the first item from the collection.
- *
- * @param callable|null $callback
- * @param mixed $default
- * @return mixed
- */
- public function first(callable $callback = null, $default = null)
- {
- return Arr::first($this->items, $callback, $default);
- }
- /**
- * Get the first item by the given key value pair.
- *
- * @param string $key
- * @param mixed $operator
- * @param mixed $value
- * @return static
- */
- public function firstWhere($key, $operator, $value = null)
- {
- return $this->first($this->operatorForWhere(...func_get_args()));
- }
- /**
- * Get a flattened array of the items in the collection.
- *
- * @param int $depth
- * @return static
- */
- public function flatten($depth = INF)
- {
- return new static(Arr::flatten($this->items, $depth));
- }
- /**
- * Flip the items in the collection.
- *
- * @return static
- */
- public function flip()
- {
- return new static(array_flip($this->items));
- }
- /**
- * Remove an item from the collection by key.
- *
- * @param string|array $keys
- * @return $this
- */
- public function forget($keys)
- {
- foreach ((array) $keys as $key) {
- $this->offsetUnset($key);
- }
- return $this;
- }
- /**
- * Get an item from the collection by key.
- *
- * @param mixed $key
- * @param mixed $default
- * @return mixed
- */
- public function get($key, $default = null)
- {
- if ($this->offsetExists($key)) {
- return $this->items[$key];
- }
- return value($default);
- }
- /**
- * Group an associative array by a field or using a callback.
- *
- * @param callable|string $groupBy
- * @param bool $preserveKeys
- * @return static
- */
- public function groupBy($groupBy, $preserveKeys = false)
- {
- 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|string $keyBy
- * @return static
- */
- public function keyBy($keyBy)
- {
- $keyBy = $this->valueRetriever($keyBy);
- $results = [];
- foreach ($this->items as $key => $item) {
- $resolvedKey = $keyBy($item, $key);
- if (is_object($resolvedKey)) {
- $resolvedKey = (string) $resolvedKey;
- }
- $results[$resolvedKey] = $item;
- }
- return new static($results);
- }
- /**
- * Determine if an item exists in the collection by key.
- *
- * @param mixed $key
- * @return bool
- */
- public function has($key)
- {
- $keys = is_array($key) ? $key : func_get_args();
- foreach ($keys as $value) {
- if (! $this->offsetExists($value)) {
- return false;
- }
- }
- return true;
- }
- /**
- * Concatenate values of a given key as a string.
- *
- * @param string $value
- * @param string $glue
- * @return string
- */
- public function implode($value, $glue = null)
- {
- $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 mixed $items
- * @return static
- */
- public function intersect($items)
- {
- return new static(array_intersect($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Intersect the collection with the given items by key.
- *
- * @param mixed $items
- * @return static
- */
- public function intersectByKeys($items)
- {
- return new static(array_intersect_key(
- $this->items, $this->getArrayableItems($items)
- ));
- }
- /**
- * Determine if the collection is empty or not.
- *
- * @return bool
- */
- public function isEmpty()
- {
- return empty($this->items);
- }
- /**
- * Determine if the collection is not empty.
- *
- * @return bool
- */
- public function isNotEmpty()
- {
- return ! $this->isEmpty();
- }
- /**
- * 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 the keys of the collection items.
- *
- * @return static
- */
- public function keys()
- {
- return new static(array_keys($this->items));
- }
- /**
- * Get the last item from the collection.
- *
- * @param callable|null $callback
- * @param mixed $default
- * @return mixed
- */
- public function last(callable $callback = null, $default = null)
- {
- return Arr::last($this->items, $callback, $default);
- }
- /**
- * Get the values of a given key.
- *
- * @param string|array $value
- * @param string|null $key
- * @return static
- */
- public function pluck($value, $key = null)
- {
- return new static(Arr::pluck($this->items, $value, $key));
- }
- /**
- * Run a map over each of the items.
- *
- * @param callable $callback
- * @return static
- */
- public function map(callable $callback)
- {
- $keys = array_keys($this->items);
- $items = array_map($callback, $this->items, $keys);
- return new static(array_combine($keys, $items));
- }
- /**
- * Run a map over each nested chunk of items.
- *
- * @param callable $callback
- * @return static
- */
- public function mapSpread(callable $callback)
- {
- 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.
- *
- * @param callable $callback
- * @return static
- */
- public function mapToDictionary(callable $callback)
- {
- $dictionary = $this->map($callback)->reduce(function ($groups, $pair) {
- $groups[key($pair)][] = reset($pair);
- return $groups;
- }, []);
- return new static($dictionary);
- }
- /**
- * Run a grouping map over the items.
- *
- * The callback should return an associative array with a single key/value pair.
- *
- * @param callable $callback
- * @return static
- */
- public function mapToGroups(callable $callback)
- {
- $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.
- *
- * @param callable $callback
- * @return static
- */
- public function mapWithKeys(callable $callback)
- {
- $result = [];
- foreach ($this->items as $key => $value) {
- $assoc = $callback($value, $key);
- foreach ($assoc as $mapKey => $mapValue) {
- $result[$mapKey] = $mapValue;
- }
- }
- return new static($result);
- }
- /**
- * Map a collection and flatten the result by a single level.
- *
- * @param callable $callback
- * @return static
- */
- public function flatMap(callable $callback)
- {
- return $this->map($callback)->collapse();
- }
- /**
- * Map the values into a new class.
- *
- * @param string $class
- * @return static
- */
- public function mapInto($class)
- {
- return $this->map(function ($value, $key) use ($class) {
- return new $class($value, $key);
- });
- }
- /**
- * Get the max value of a given key.
- *
- * @param callable|string|null $callback
- * @return mixed
- */
- 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 mixed $items
- * @return static
- */
- public function merge($items)
- {
- return new static(array_merge($this->items, $this->getArrayableItems($items)));
- }
- /**
- * Create a collection by using this collection for keys and another for its values.
- *
- * @param mixed $values
- * @return static
- */
- public function combine($values)
- {
- return new static(array_combine($this->all(), $this->getArrayableItems($values)));
- }
- /**
- * Union the collection with the given items.
- *
- * @param mixed $items
- * @return static
- */
- public function union($items)
- {
- return new static($this->items + $this->getArrayableItems($items));
- }
- /**
- * Get the min value of a given key.
- *
- * @param callable|string|null $callback
- * @return mixed
- */
- public function min($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;
- });
- }
- /**
- * Create a new collection consisting of every n-th element.
- *
- * @param int $step
- * @param int $offset
- * @return static
- */
- public function nth($step, $offset = 0)
- {
- $new = [];
- $position = 0;
- foreach ($this->items as $item) {
- if ($position % $step === $offset) {
- $new[] = $item;
- }
- $position++;
- }
- return new static($new);
- }
- /**
- * Get the items with the specified keys.
- *
- * @param mixed $keys
- * @return static
- */
- public function only($keys)
- {
- if (is_null($keys)) {
- return new static($this->items);
- }
- if ($keys instanceof 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.
- *
- * @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|string $callback
- * @return static
- */
- public function partition($callback)
- {
- $partitions = [new static, new static];
- $callback = $this->valueRetriever($callback);
- 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.
- *
- * @param callable $callback
- * @return mixed
- */
- public function pipe(callable $callback)
- {
- return $callback($this);
- }
- /**
- * Get and remove the last item from the collection.
- *
- * @return mixed
- */
- public function pop()
- {
- return array_pop($this->items);
- }
- /**
- * Push an item onto the beginning of the collection.
- *
- * @param mixed $value
- * @param mixed $key
- * @return $this
- */
- public function prepend($value, $key = null)
- {
- $this->items = Arr::prepend($this->items, $value, $key);
- return $this;
- }
- /**
- * Push an item onto the end of the collection.
- *
- * @param mixed $value
- * @return $this
- */
- public function push($value)
- {
- $this->offsetSet(null, $value);
- return $this;
- }
- /**
- * Push all of the given items onto the collection.
- *
- * @param \Traversable $source
- * @return $this
- */
- public function concat($source)
- {
- $result = new static($this);
- foreach ($source as $item) {
- $result->push($item);
- }
- return $result;
- }
- /**
- * Get and remove an item from the collection.
- *
- * @param mixed $key
- * @param mixed $default
- * @return mixed
- */
- public function pull($key, $default = null)
- {
- return Arr::pull($this->items, $key, $default);
- }
- /**
- * Put an item in the collection by key.
- *
- * @param mixed $key
- * @param mixed $value
- * @return $this
- */
- public function put($key, $value)
- {
- $this->offsetSet($key, $value);
- return $this;
- }
- /**
- * Get one or a specified number of items randomly from the collection.
- *
- * @param int|null $number
- * @return mixed
- *
- * @throws \InvalidArgumentException
- */
- public function random($number = null)
- {
- if (is_null($number)) {
- return Arr::random($this->items);
- }
- return new static(Arr::random($this->items, $number));
- }
- /**
- * Reduce the collection to a single value.
- *
- * @param callable $callback
- * @param mixed $initial
- * @return mixed
- */
- 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|mixed $callback
- * @return static
- */
- public function reject($callback)
- {
- 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
- */
- public function reverse()
- {
- return new static(array_reverse($this->items, true));
- }
- /**
- * Search the collection for a given value and return the corresponding key if successful.
- *
- * @param mixed $value
- * @param bool $strict
- * @return mixed
- */
- public function search($value, $strict = false)
- {
- if (! $this->useAsCallable($value)) {
- return array_search($value, $this->items, $strict);
- }
- foreach ($this->items as $key => $item) {
- if (call_user_func($value, $item, $key)) {
- return $key;
- }
- }
- return false;
- }
- /**
- * Get and remove the first item from the collection.
- *
- * @return mixed
- */
- public function shift()
- {
- return array_shift($this->items);
- }
- /**
- * Shuffle the items in the collection.
- *
- * @param int $seed
- * @return static
- */
- public function shuffle($seed = null)
- {
- $items = $this->items;
- if (is_null($seed)) {
- shuffle($items);
- } else {
- srand($seed);
- usort($items, function () {
- return rand(-1, 1);
- });
- }
- return new static($items);
- }
- /**
- * Slice the underlying collection array.
- *
- * @param int $offset
- * @param int $length
- * @return static
- */
- public function slice($offset, $length = null)
- {
- return new static(array_slice($this->items, $offset, $length, true));
- }
- /**
- * Split a collection into a certain number of groups.
- *
- * @param int $numberOfGroups
- * @return static
- */
- public function split($numberOfGroups)
- {
- if ($this->isEmpty()) {
- return new static;
- }
- $groupSize = ceil($this->count() / $numberOfGroups);
- return $this->chunk($groupSize);
- }
- /**
- * Chunk the underlying collection array.
- *
- * @param int $size
- * @return static
- */
- public function chunk($size)
- {
- if ($size <= 0) {
- return new static;
- }
- $chunks = [];
- foreach (array_chunk($this->items, $size, true) as $chunk) {
- $chunks[] = new static($chunk);
- }
- return new static($chunks);
- }
- /**
- * Sort through each item with a callback.
- *
- * @param callable|null $callback
- * @return static
- */
- public function sort(callable $callback = null)
- {
- $items = $this->items;
- $callback
- ? uasort($items, $callback)
- : asort($items);
- return new static($items);
- }
- /**
- * 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)
- {
- $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|string $callback
- * @param int $options
- * @return static
- */
- public function sortByDesc($callback, $options = SORT_REGULAR)
- {
- return $this->sortBy($callback, $options, true);
- }
- /**
- * Splice a portion of the underlying collection array.
- *
- * @param int $offset
- * @param int|null $length
- * @param mixed $replacement
- * @return static
- */
- public function splice($offset, $length = null, $replacement = [])
- {
- if (func_num_args() == 1) {
- return new static(array_splice($this->items, $offset));
- }
- return new static(array_splice($this->items, $offset, $length, $replacement));
- }
- /**
- * Get the sum of the given values.
- *
- * @param callable|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.
- *
- * @param int $limit
- * @return static
- */
- public function take($limit)
- {
- 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 $callback
- * @return $this
- */
- public function tap(callable $callback)
- {
- $callback(new static($this->items));
- return $this;
- }
- /**
- * Transform each item in the collection using a callback.
- *
- * @param callable $callback
- * @return $this
- */
- public function transform(callable $callback)
- {
- $this->items = $this->map($callback)->all();
- return $this;
- }
- /**
- * Return only unique items from the collection array.
- *
- * @param string|callable|null $key
- * @param bool $strict
- * @return static
- */
- public function unique($key = null, $strict = false)
- {
- if (is_null($key)) {
- return new static(array_unique($this->items, SORT_REGULAR));
- }
- $callback = $this->valueRetriever($key);
- $exists = [];
- return $this->reject(function ($item, $key) use ($callback, $strict, &$exists) {
- if (in_array($id = $callback($item, $key), $exists, $strict)) {
- return true;
- }
- $exists[] = $id;
- });
- }
- /**
- * Return only unique items from the collection array using strict comparison.
- *
- * @param string|callable|null $key
- * @return static
- */
- public function uniqueStrict($key = null)
- {
- return $this->unique($key, true);
- }
- /**
- * Reset the keys on the underlying array.
- *
- * @return static
- */
- public function values()
- {
- return new static(array_values($this->items));
- }
- /**
- * Get a value retrieving callback.
- *
- * @param string $value
- * @return callable
- */
- protected function valueRetriever($value)
- {
- if ($this->useAsCallable($value)) {
- return $value;
- }
- return function ($item) use ($value) {
- return data_get($item, $value);
- };
- }
- /**
- * Zip the collection together with one or more arrays.
- *
- * e.g. new Collection([1, 2, 3])->zip([4, 5, 6]);
- * => [[1, 4], [2, 5], [3, 6]]
- *
- * @param mixed ...$items
- * @return static
- */
- public function zip($items)
- {
- $arrayableItems = array_map(function ($items) {
- return $this->getArrayableItems($items);
- }, func_get_args());
- $params = array_merge([function () {
- return new static(func_get_args());
- }, $this->items], $arrayableItems);
- return new static(call_user_func_array('array_map', $params));
- }
- /**
- * Pad collection to the specified length with a value.
- *
- * @param int $size
- * @param mixed $value
- * @return static
- */
- public function pad($size, $value)
- {
- return new static(array_pad($this->items, $size, $value));
- }
- /**
- * Get the collection of items as a plain array.
- *
- * @return array
- */
- public function toArray()
- {
- return array_map(function ($value) {
- return $value instanceof Arrayable ? $value->toArray() : $value;
- }, $this->items);
- }
- /**
- * Convert the object into something JSON serializable.
- *
- * @return array
- */
- public function jsonSerialize()
- {
- return array_map(function ($value) {
- if ($value instanceof JsonSerializable) {
- return $value->jsonSerialize();
- } elseif ($value instanceof Jsonable) {
- return json_decode($value->toJson(), true);
- } elseif ($value instanceof Arrayable) {
- return $value->toArray();
- }
- return $value;
- }, $this->items);
- }
- /**
- * Get the collection of items as JSON.
- *
- * @param int $options
- * @return string
- */
- public function toJson($options = 0)
- {
- return json_encode($this->jsonSerialize(), $options);
- }
- /**
- * Get an iterator for the items.
- *
- * @return \ArrayIterator
- */
- public function getIterator()
- {
- return new ArrayIterator($this->items);
- }
- /**
- * Get a CachingIterator instance.
- *
- * @param int $flags
- * @return \CachingIterator
- */
- public function getCachingIterator($flags = CachingIterator::CALL_TOSTRING)
- {
- return new CachingIterator($this->getIterator(), $flags);
- }
- /**
- * Count the number of items in the collection.
- *
- * @return int
- */
- public function count()
- {
- return count($this->items);
- }
- /**
- * Get a base Support collection instance from this collection.
- *
- * @return \Illuminate\Support\Collection
- */
- public function toBase()
- {
- return new self($this);
- }
- /**
- * Determine if an item exists at an offset.
- *
- * @param mixed $key
- * @return bool
- */
- public function offsetExists($key)
- {
- return array_key_exists($key, $this->items);
- }
- /**
- * Get an item at a given offset.
- *
- * @param mixed $key
- * @return mixed
- */
- public function offsetGet($key)
- {
- return $this->items[$key];
- }
- /**
- * Set the item at a given offset.
- *
- * @param mixed $key
- * @param mixed $value
- * @return void
- */
- public function offsetSet($key, $value)
- {
- if (is_null($key)) {
- $this->items[] = $value;
- } else {
- $this->items[$key] = $value;
- }
- }
- /**
- * Unset the item at a given offset.
- *
- * @param string $key
- * @return void
- */
- public function offsetUnset($key)
- {
- unset($this->items[$key]);
- }
- /**
- * Convert the collection to its string representation.
- *
- * @return string
- */
- public function __toString()
- {
- return $this->toJson();
- }
- /**
- * Results array of items from Collection or Arrayable.
- *
- * @param mixed $items
- * @return array
- */
- protected function getArrayableItems($items)
- {
- if (is_array($items)) {
- return $items;
- } elseif ($items instanceof self) {
- return $items->all();
- } elseif ($items instanceof Arrayable) {
- return $items->toArray();
- } elseif ($items instanceof Jsonable) {
- return json_decode($items->toJson(), true);
- } elseif ($items instanceof JsonSerializable) {
- return $items->jsonSerialize();
- } elseif ($items instanceof Traversable) {
- return iterator_to_array($items);
- }
- return (array) $items;
- }
- /**
- * 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);
- }
- }
|