Subversion-Projekte lars-tiefland.laravel_shop

<?php

namespace Illuminate\Support;

use ArrayAccess;

use ArrayIterator;

use Illuminate\Contracts\Support\CanBeEscapedWhenCastToString;

use Illuminate\Support\Traits\EnumeratesValues;

use Illuminate\Support\Traits\Macroable;

use stdClass;

use Traversable;

/**

 * @template TKey of array-key

 * @template TValue

 *

 * @implements \ArrayAccess<TKey, TValue>

 * @implements \Illuminate\Support\Enumerable<TKey, TValue>

 */

class Collection implements ArrayAccess, CanBeEscapedWhenCastToString, Enumerable

{

    /**

     * @use \Illuminate\Support\Traits\EnumeratesValues<TKey, TValue>

     */

    use EnumeratesValues, Macroable;

    /**

     * The items contained in the collection.

     *

     * @var array<TKey, TValue>

     */

    protected $items = [];

    /**

     * Create a new collection.

     *

     * @param  \Illuminate\Contracts\Support\Arrayable<TKey, TValue>|iterable<TKey, TValue>|null  $items

     * @return void

     */

    public function __construct($items = [])

    {

        $this->items = $this->getArrayableItems($items);

    }

    /**

     * Create a collection with the given range.

     *

     * @param  int  $from

     * @param  int  $to

     * @return static<int, int>

     */

    public static function range($from, $to)

    {

        return new static(range($from, $to));

    }

    /**

     * Get all of the items in the collection.

     *

     * @return array<TKey, TValue>

     */

    public function all()

    {

        return $this->items;

    }

    /**

     * Get a lazy collection for the items in this collection.

     *

     * @return \Illuminate\Support\LazyCollection<TKey, TValue>

     */

    public function lazy()

    {

        return new LazyCollection($this->items);

    }

    /**

     * Get the average value of a given key.

     *

     * @param  (callable(TValue): float|int)|string|null  $callback

     * @return float|int|null

     */

    public function avg($callback = null)

    {

        $callback = $this->valueRetriever($callback);

        $items = $this->map(function ($value) use ($callback) {

            return $callback($value);

        })->filter(function ($value) {

            return ! is_null($value);

        });

        if ($count = $items->count()) {

            return $items->sum() / $count;

        }

    }

    /**

     * Get the median of a given key.

     *

     * @param  string|array<array-key, string>|null  $key

     * @return float|int|null

     */

    public function median($key = null)

    {

        $values = (isset($key) ? $this->pluck($key) : $this)

            ->filter(fn ($item) => ! is_null($item))

            ->sort()->values();

        $count = $values->count();

        if ($count === 0) {

            return;

        }

        $middle = (int) ($count / 2);

        if ($count % 2) {

            return $values->get($middle);

        }

        return (new static([

            $values->get($middle - 1), $values->get($middle),

        ]))->average();

    }

    /**

     * Get the mode of a given key.

     *

     * @param  string|array<array-key, string>|null  $key

     * @return array<int, float|int>|null

     */

    public function mode($key = null)

    {

        if ($this->count() === 0) {

            return;

        }

        $collection = isset($key) ? $this->pluck($key) : $this;

        $counts = new static;

        $collection->each(fn ($value) => $counts[$value] = isset($counts[$value]) ? $counts[$value] + 1 : 1);

        $sorted = $counts->sort();

        $highestValue = $sorted->last();

        return $sorted->filter(fn ($value) => $value == $highestValue)

            ->sort()->keys()->all();

    }

    /**

     * Collapse the collection of items into a single array.

     *

     * @return static<int, mixed>

     */

    public function collapse()

    {

        return new static(Arr::collapse($this->items));

    }

    /**

     * Determine if an item exists in the collection.

     *

     * @param  (callable(TValue, TKey): bool)|TValue|string  $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, using strict comparison.

     *

     * @param  (callable(TValue): bool)|TValue|array-key  $key

     * @param  TValue|null  $value

     * @return bool

     */

    public function containsStrict($key, $value = null)

    {

        if (func_num_args() === 2) {

            return $this->contains(fn ($item) => data_get($item, $key) === $value);

        }

        if ($this->useAsCallable($key)) {

            return ! is_null($this->first($key));

        }

        return in_array($key, $this->items, true);

    }

    /**

     * Determine if an item is not contained in the collection.

     *

     * @param  mixed  $key

     * @param  mixed  $operator

     * @param  mixed  $value

     * @return bool

     */

    public function doesntContain($key, $operator = null, $value = null)

    {

        return ! $this->contains(...func_get_args());

    }

    /**

     * Cross join with the given lists, returning all possible permutations.

     *

     * @template TCrossJoinKey

     * @template TCrossJoinValue

     *

     * @param  \Illuminate\Contracts\Support\Arrayable<TCrossJoinKey, TCrossJoinValue>|iterable<TCrossJoinKey, TCrossJoinValue>  ...$lists

     * @return static<int, array<int, TValue|TCrossJoinValue>>

     */

    public function crossJoin(...$lists)

    {

        return new static(Arr::crossJoin(

            $this->items, ...array_map([$this, 'getArrayableItems'], $lists)

        ));

    }

    /**

     * Get the items in the collection that are not present in the given items.

     *

     * @param  \Illuminate\Contracts\Support\Arrayable<array-key, TValue>|iterable<array-key, TValue>  $items

     * @return static

     */

    public function diff($items)

    {

        return new static(array_diff($this->items, $this->getArrayableItems($items)));

    }

    /**

     * Get the items in the collection that are not present in the given items, using the callback.

     *

     * @param  \Illuminate\Contracts\Support\Arrayable<array-key, TValue>|iterable<array-key, TValue>  $items

     * @param  callable(TValue, TValue): int  $callback

     * @return static

     */

    public function diffUsing($items, callable $callback)

    {

        return new static(array_udiff($this->items, $this->getArrayableItems($items), $callback));

    }

    /**

     * Get the items in the collection whose keys and values are not present in the given items.

     *

     * @param  \Illuminate\Contracts\Support\Arrayable<TKey, TValue>|iterable<TKey, TValue>  $items

     * @return static

     */

    public function diffAssoc($items)

    {

        return new static(array_diff_assoc($this->items, $this->getArrayableItems($items)));

    }

    /**

     * Get the items in the collection whose keys and values are not present in the given items, using the callback.

     *

     * @param  \Illuminate\Contracts\Support\Arrayable<TKey, TValue>|iterable<TKey, TValue>  $items

     * @param  callable(TKey, TKey): int  $callback

     * @return static

     */

    public function diffAssocUsing($items, callable $callback)

    {

        return new static(array_diff_uassoc($this->items, $this->getArrayableItems($items), $callback));

    }

    /**

     * Get the items in the collection whose keys are not present in the given items.

     *

     * @param  \Illuminate\Contracts\Support\Arrayable<TKey, TValue>|iterable<TKey, TValue>  $items

     * @return static

     */

    public function diffKeys($items)

    {

        return new static(array_diff_key($this->items, $this->getArrayableItems($items)));

    }

    /**

     * Get the items in the collection whose keys are not present in the given items, using the callback.

     *

     * @param  \Illuminate\Contracts\Support\Arrayable<TKey, TValue>|iterable<TKey, TValue>  $items

     * @param  callable(TKey, TKey): int  $callback

     * @return static

     */

    public function diffKeysUsing($items, callable $callback)

    {

        return new static(array_diff_ukey($this->items, $this->getArrayableItems($items), $callback));

    }

    /**

     * Retrieve duplicate items from the collection.

     *

     * @param  (callable(TValue): bool)|string|null  $callback

     * @param  bool  $strict

     * @return static

     */

    public function duplicates($callback = null, $strict = false)

    {

        $items = $this->map($this->valueRetriever($callback));

        $uniqueItems = $items->unique(null, $strict);

        $compare = $this->duplicateComparator($strict);

        $duplicates = new static;

        foreach ($items as $key => $value) {

            if ($uniqueItems->isNotEmpty() && $compare($value, $uniqueItems->first())) {

                $uniqueItems->shift();

            } else {

                $duplicates[$key] = $value;

            }

        }

        return $duplicates;

    }

    /**

     * Retrieve duplicate items from the collection using strict comparison.

     *

     * @param  (callable(TValue): bool)|string|null  $callback

     * @return static

     */

    public function duplicatesStrict($callback = null)

    {

        return $this->duplicates($callback, true);

    }

    /**

     * Get the comparison function to detect duplicates.

     *

     * @param  bool  $strict

     * @return callable(TValue, TValue): bool

     */

    protected function duplicateComparator($strict)

    {

        if ($strict) {

            return function ($a, $b) {

                return $a === $b;

            };

        }

        return function ($a, $b) {

            return $a == $b;

        };

    }

    /**

     * Get all items except for those with the specified keys.

     *

     * @param  \Illuminate\Support\Enumerable<array-key, TKey>|array<array-key, TKey>  $keys

     * @return static

     */

    public function except($keys)

    {

        if ($keys instanceof Enumerable) {

            $keys = $keys->all();

        } elseif (! is_array($keys)) {

            $keys = func_get_args();

        }

        return new static(Arr::except($this->items, $keys));

    }

    /**

     * Run a filter over each of the items.

     *

     * @param (callable(TValue, TKey): bool)|null  $callback

     * @return static

     */

    public function filter(callable $callback = null)

    {

        if ($callback) {

            return new static(Arr::where($this->items, $callback));

        }

        return new static(array_filter($this->items));

    }

    /**

     * Get the first item from the collection passing the given truth test.

     *

     * @template TFirstDefault

     *

     * @param  (callable(TValue, TKey): bool)|null  $callback

     * @param  TFirstDefault|(\Closure(): TFirstDefault)  $default

     * @return TValue|TFirstDefault

     */

    public function first(callable $callback = null, $default = null)

    {

        return Arr::first($this->items, $callback, $default);

    }

    /**

     * Get a flattened array of the items in the collection.

     *

     * @param  int  $depth

     * @return static<int, mixed>

     */

    public function flatten($depth = INF)

    {

        return new static(Arr::flatten($this->items, $depth));

    }

    /**

     * Flip the items in the collection.

     *

     * @return static<TValue, TKey>

     */

    public function flip()

    {

        return new static(array_flip($this->items));

    }

    /**

     * Remove an item from the collection by key.

     *

     * @param  TKey|array<array-key, TKey>  $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.

     *

     * @template TGetDefault

     *

     * @param  TKey  $key

     * @param  TGetDefault|(\Closure(): TGetDefault)  $default

     * @return TValue|TGetDefault

     */

    public function get($key, $default = null)

    {

        if (array_key_exists($key, $this->items)) {

            return $this->items[$key];

        }

        return value($default);

    }

    /**

     * Get an item from the collection by key or add it to collection if it does not exist.

     *

     * @param  mixed  $key

     * @param  mixed  $value

     * @return mixed

     */

    public function getOrPut($key, $value)

    {

        if (array_key_exists($key, $this->items)) {

            return $this->items[$key];

        }

        $this->offsetSet($key, $value = value($value));

        return $value;

    }

    /**

     * Group an associative array by a field or using a callback.

     *

     * @param  (callable(TValue, TKey): array-key)|array|string  $groupBy

     * @param  bool  $preserveKeys

     * @return static<array-key, static<array-key, TValue>>

     */

    public function groupBy($groupBy, $preserveKeys = false)

    {

        if (! $this->useAsCallable($groupBy) && is_array($groupBy)) {

            $nextGroups = $groupBy;

            $groupBy = array_shift($nextGroups);

        }

        $groupBy = $this->valueRetriever($groupBy);

        $results = [];

        foreach ($this->items as $key => $value) {

            $groupKeys = $groupBy($value, $key);

            if (! is_array($groupKeys)) {

                $groupKeys = [$groupKeys];

            }

            foreach ($groupKeys as $groupKey) {

                $groupKey = match (true) {

                    is_bool($groupKey) => (int) $groupKey,

                    $groupKey instanceof \Stringable => (string) $groupKey,

                    default => $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<array-key, TValue>

     */

    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  TKey|array<array-key, TKey>  $key

     * @return bool

     */

    public function has($key)

    {

        $keys = is_array($key) ? $key : func_get_args();

        foreach ($keys as $value) {

            if (! array_key_exists($value, $this->items)) {

                return false;

            }

        }

        return true;

    }

    /**

     * Determine if any of the keys exist in the collection.

     *

     * @param  mixed  $key

     * @return bool

     */

    public function hasAny($key)

    {

        if ($this->isEmpty()) {

            return false;

        }

        $keys = is_array($key) ? $key : func_get_args();

        foreach ($keys as $value) {

            if ($this->has($value)) {

                return true;

            }

        }

        return false;

    }

    /**

     * Concatenate values of a given key as a string.

     *

     * @param  callable|string  $value

     * @param  string|null  $glue

     * @return string

     */

    public function implode($value, $glue = null)

    {

        if ($this->useAsCallable($value)) {

            return implode($glue ?? '', $this->map($value)->all());

        }

        $first = $this->first();

        if (is_array($first) || (is_object($first) && ! $first instanceof Stringable)) {

            return implode($glue ?? '', $this->pluck($value)->all());

        }

        return implode($value ?? '', $this->items);

    }

    /**

     * Intersect the collection with the given items.

     *

     * @param  \Illuminate\Contracts\Support\Arrayable<TKey, TValue>|iterable<TKey, TValue>  $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  \Illuminate\Contracts\Support\Arrayable<TKey, TValue>|iterable<TKey, TValue>  $items

     * @return static

     */

    public function intersectByKeys($items)

    {

        return new static(array_intersect_key(

            $this->items, $this->getArrayableItems($items)

        ));

    }

    /**

     * Determine if the collection is empty or not.

     *

     * @return bool

     */

    public function isEmpty()

    {

        return empty($this->items);

    }

    /**

     * Determine if the collection contains a single item.

     *

     * @return bool

     */

    public function containsOneItem()

    {

        return $this->count() === 1;

    }

    /**

     * Join all items from the collection using a string. The final items can use a separate glue string.

     *

     * @param  string  $glue

     * @param  string  $finalGlue

     * @return string

     */

    public function join($glue, $finalGlue = '')

    {

        if ($finalGlue === '') {

            return $this->implode($glue);

        }

        $count = $this->count();

        if ($count === 0) {

            return '';

        }

        if ($count === 1) {

            return $this->last();

        }

        $collection = new static($this->items);

        $finalItem = $collection->pop();

        return $collection->implode($glue).$finalGlue.$finalItem;

    }

    /**

     * Get the keys of the collection items.

     *

     * @return static<int, TKey>

     */

    public function keys()

    {

        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 TValue|TLastDefault

     */

    public function last(callable $callback = null, $default = null)

    {

        return Arr::last($this->items, $callback, $default);

    }

    /**

     * Get the values of a given key.

     *

     * @param  string|int|array<array-key, string>  $value

     * @param  string|null  $key

     * @return static<array-key, mixed>

     */

    public function pluck($value, $key = null)

    {

        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)

    {

        return new static(Arr::map($this->items, $callback));

    }

    /**

     * 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)

    {

        $dictionary = [];

        foreach ($this->items as $key => $item) {

            $pair = $callback($item, $key);

            $key = key($pair);

            $value = reset($pair);

            if (! isset($dictionary[$key])) {

                $dictionary[$key] = [];

            }

            $dictionary[$key][] = $value;

        }

        return new static($dictionary);

    }

    /**

     * Run an associative map over each of the items.

     *

     * The callback should return an associative array with a single key/value pair.

     *

     * @template TMapWithKeysKey of array-key

     * @template TMapWithKeysValue

     *

     * @param  callable(TValue, TKey): array<TMapWithKeysKey, TMapWithKeysValue>  $callback

     * @return static<TMapWithKeysKey, TMapWithKeysValue>

     */

    public function mapWithKeys(callable $callback)

    {

        $result = [];

        foreach ($this->items as $key => $value) {

            $assoc = $callback($value, $key);

            foreach ($assoc as $mapKey => $mapValue) {

                $result[$mapKey] = $mapValue;

            }

        }

        return new static($result);

    }

    /**

     * Merge the collection with the given items.

     *

     * @param  \Illuminate\Contracts\Support\Arrayable<TKey, TValue>|iterable<TKey, TValue>  $items

     * @return static

     */

    public function merge($items)

    {

        return new static(array_merge($this->items, $this->getArrayableItems($items)));

    }

    /**

     * Recursively merge the collection with the given items.

     *

     * @template TMergeRecursiveValue

     *

     * @param  \Illuminate\Contracts\Support\Arrayable<TKey, TMergeRecursiveValue>|iterable<TKey, TMergeRecursiveValue>  $items

     * @return static<TKey, TValue|TMergeRecursiveValue>

     */

    public function mergeRecursive($items)

    {

        return new static(array_merge_recursive($this->items, $this->getArrayableItems($items)));

    }

    /**

     * Create a collection by using this collection for keys and another for its values.

     *

     * @template TCombineValue

     *

     * @param  \Illuminate\Contracts\Support\Arrayable<array-key, TCombineValue>|iterable<array-key, TCombineValue>  $values

     * @return static<TValue, TCombineValue>

     */

    public function combine($values)

    {

        return new static(array_combine($this->all(), $this->getArrayableItems($values)));

    }

    /**

     * Union the collection with the given items.

     *

     * @param  \Illuminate\Contracts\Support\Arrayable<TKey, TValue>|iterable<TKey, TValue>  $items

     * @return static

     */

    public function union($items)

    {

        return new static($this->items + $this->getArrayableItems($items));

    }

    /**

     * Create a new collection consisting of every n-th element.

     *

     * @param  int  $step

     * @param  int  $offset

     * @return static

     */

    public function nth($step, $offset = 0)

    {

        $new = [];

        $position = 0;

        foreach ($this->slice($offset)->items as $item) {

            if ($position % $step === 0) {

                $new[] = $item;

            }

            $position++;

        }

        return new static($new);

    }

    /**

     * Get the items with the specified keys.

     *

     * @param  \Illuminate\Support\Enumerable<array-key, TKey>|array<array-key, TKey>|string  $keys

     * @return static

     */

    public function only($keys)

    {

        if (is_null($keys)) {

            return new static($this->items);

        }

        if ($keys instanceof Enumerable) {

            $keys = $keys->all();

        }

        $keys = is_array($keys) ? $keys : func_get_args();

        return new static(Arr::only($this->items, $keys));

    }

    /**

     * Get and remove the last N items from the collection.

     *

     * @param  int  $count

     * @return static<int, TValue>|TValue|null

     */

    public function pop($count = 1)

    {

        if ($count === 1) {

            return array_pop($this->items);

        }

        if ($this->isEmpty()) {

            return new static;

        }

        $results = [];

        $collectionCount = $this->count();

        foreach (range(1, min($count, $collectionCount)) as $item) {

            array_push($results, array_pop($this->items));

        }

        return new static($results);

    }

    /**

     * Push an item onto the beginning of the collection.

     *

     * @param  TValue  $value

     * @param  TKey  $key

     * @return $this

     */

    public function prepend($value, $key = null)

    {

        $this->items = Arr::prepend($this->items, ...func_get_args());

        return $this;

    }

    /**

     * Push one or more items onto the end of the collection.

     *

     * @param  TValue  ...$values

     * @return $this

     */

    public function push(...$values)

    {

        foreach ($values as $value) {

            $this->items[] = $value;

        }

        return $this;

    }

    /**

     * Push all of the given items onto the collection.

     *

     * @param  iterable<array-key, TValue>  $source

     * @return static

     */

    public function concat($source)

    {

        $result = new static($this);

        foreach ($source as $item) {

            $result->push($item);

        }

        return $result;

    }

    /**

     * Get and remove an item from the collection.

     *

     * @template TPullDefault

     *

     * @param  TKey  $key

     * @param  TPullDefault|(\Closure(): TPullDefault)  $default

     * @return TValue|TPullDefault

     */

    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)

    {

        $this->offsetSet($key, $value);

        return $this;

    }

    /**

     * Get one or a specified number of items randomly from the collection.

     *

     * @param  (callable(self<TKey, TValue>): int)|int|null  $number

     * @return static<int, TValue>|TValue

     *

     * @throws \InvalidArgumentException

     */

    public function random($number = null)

    {