Sync Laravel updates: #58565 → #58648

src/bus/src/Events/BatchCanceled.php

@@ -11,6 +11,8 @@ class BatchCanceled
 {
     /**
      * Create a new event instance.
+     *
+     * @param null|Throwable $exception the exception that caused the cancellation
      */
     public function __construct(
         public Batch $batch,

src/cache/src/Console/CacheTableCommand.php

@@ -46,7 +46,7 @@ public function handle(): int
 
         $this->components->info('Migrations created successfully.');
 
-        return 0;
+        return self::SUCCESS;
     }
 
     /**

src/cache/src/Console/PruneDbExpiredCommand.php

@@ -25,7 +25,7 @@ class PruneDbExpiredCommand extends Command
     /**
      * Execute the console command.
      */
-    public function handle(): ?int
+    public function handle(): int
     {
         $store = $this->argument('store');
         $cache = $this->hypervel->make('cache')->store($store);
@@ -42,14 +42,14 @@ public function handle(): ?int
                 $this->error("The cache store [{$store}] is not using the database driver.");
             }
 
-            return 1;
+            return self::FAILURE;
         }
 
         $deleted = $cache->getStore()->pruneExpired();
 
         $this->info("Successfully pruned {$deleted} expired cache entries.");
 
-        return 0;
+        return self::SUCCESS;
     }
 
     /**

src/cache/src/Console/PruneStaleTagsCommand.php

@@ -35,7 +35,7 @@ public function handle(): int
         if (! method_exists($store, 'flushStaleTags')) {
             $this->components->info('The selected cache store does not support pruning stale tags.');
 
-            return 0;
+            return self::SUCCESS;
         }
 
         $stats = $store->flushStaleTags();
@@ -54,7 +54,7 @@ public function handle(): int
 
         $this->components->info('Stale cache tags pruned successfully.');
 
-        return 0;
+        return self::SUCCESS;
     }
 
     /**

src/collections/src/Arr.php

@@ -111,7 +111,7 @@ public static function collapse(iterable $array): array
         $results = [];
 
         foreach ($array as $values) {
-            if ($values instanceof Collection) {
+            if ($values instanceof Enumerable) {
                 $results[] = $values->all();
             } elseif (is_array($values)) {
                 $results[] = $values;
@@ -364,7 +364,7 @@ public static function flatten(iterable $array, float $depth = INF): array
         $result = [];
 
         foreach ($array as $item) {
-            $item = $item instanceof Collection ? $item->all() : $item;
+            $item = $item instanceof Enumerable ? $item->all() : $item;
 
             if (! is_array($item)) {
                 $result[] = $item;
@@ -687,6 +687,11 @@ public static function keyBy(iterable $array, callable|array|string $keyBy): arr
 
     /**
      * Prepend the key names of an associative array.
+     *
+     * @template TValue
+     *
+     * @param array<TValue> $array
+     * @return array<array-key, TValue>
      */
     public static function prependKeysWith(array $array, string $prependWith): array
     {
@@ -834,11 +839,9 @@ public static function mapWithKeys(array $array, callable $callback): array
      * Run a map over each nested chunk of items.
      *
      * @template TKey
-     * @template TValue
      *
      * @param array<TKey, array> $array
-     * @param callable(mixed...): TValue $callback
-     * @return array<TKey, TValue>
+     * @return array<TKey, mixed>
      */
     public static function mapSpread(array $array, callable $callback): array
     {
@@ -1024,7 +1027,7 @@ public static function sole(array $array, ?callable $callback = null): mixed
      * @template TValue
      *
      * @param iterable<TKey, TValue> $array
-     * @param null|array<int, (0|1|callable(TValue, TValue): -1)|array{string, 'asc'|'desc'|SortDirection}>|callable|int|string $callback
+     * @param null|array<array-key, array{int|string, 'asc'|'desc'|bool|SortDirection}|(callable(TValue, TValue): mixed)|int|string>|(callable(TValue, TKey): mixed)|int|string $callback
      * @return array<TKey, TValue>
      */
     public static function sort(iterable $array, callable|array|int|string|null $callback = null): array
@@ -1045,7 +1048,7 @@ public static function sort(iterable $array, callable|array|int|string|null $cal
      * @template TValue
      *
      * @param iterable<TKey, TValue> $array
-     * @param null|array<int, (0|1|callable(TValue, TValue): -1)|array{string, 'asc'|'desc'|SortDirection}>|callable|int|string $callback
+     * @param null|array<array-key, array{int|string, 'asc'|'desc'|bool|SortDirection}|(callable(TValue, TValue): mixed)|int|string>|(callable(TValue, TKey): mixed)|int|string $callback
      * @return array<TKey, TValue>
      */
     public static function sortDesc(iterable $array, callable|array|int|string|null $callback = null): array
@@ -1128,8 +1131,7 @@ public static function string(ArrayAccess|array $array, string|int|null $key, ?s
     /**
      * Conditionally compile classes from an array into a CSS class list.
      *
-     * @param array<int, int|string>|array<string, bool>|string $array
-     * @return ($array is array<string, false> ? '' : ($array is '' ? '' : ($array is array{} ? '' : non-empty-string)))
+     * @param array<array-key, mixed>|string $array
      */
     public static function toCssClasses(array|string $array): string
     {
@@ -1151,8 +1153,7 @@ public static function toCssClasses(array|string $array): string
     /**
      * Conditionally compile styles from an array into a style list.
      *
-     * @param array<int, int|string>|array<string, bool>|string $array
-     * @return ($array is array<string, false> ? '' : ($array is '' ? '' : ($array is array{} ? '' : non-empty-string)))
+     * @param array<array-key, mixed>|string $array
      */
     public static function toCssStyles(array|string $array): string
     {

src/collections/src/Collection.php

@@ -179,7 +179,7 @@ public function collapseWithKeys(): static
         $results = [];
 
         foreach ($this->items as $key => $values) {
-            if ($values instanceof Collection) {
+            if ($values instanceof Enumerable) {
                 $values = $values->all();
             } elseif (! is_array($values)) {
                 continue;
@@ -511,15 +511,17 @@ public function getOrPut(mixed $key, mixed $value): mixed
      * @template TGroupKey of array-key|bool|null|UnitEnum|BaseStringable
      *
      * @param array|(callable(TValue, TKey): (array<array-key, TGroupKey>|TGroupKey))|string $groupBy
-     * @return static<
-     *  ($groupBy is (array|string)
-     *      ? array-key
-     *      : (TGroupKey is array-key ? TGroupKey : (TGroupKey is bool ? int : (TGroupKey is (BaseStringable|null) ? string : array-key)))),
-     *  static<($preserveKeys is true ? TKey : int), ($groupBy is array ? mixed : TValue)>
-     * >
+     * @return ($groupBy is array
+     *  ? Collection<array-key, Collection<array-key, mixed>>|static<array-key, Collection<array-key, mixed>>
+     *  : static<
+     *      ($groupBy is string
+     *          ? array-key
+     *          : (TGroupKey is array-key ? TGroupKey : (TGroupKey is bool ? int : (TGroupKey is (BaseStringable|null) ? string : array-key)))),
+     *      static<($preserveKeys is true ? TKey : int), TValue>
+     *  >)
      */
     #[Override]
-    public function groupBy(callable|array|string $groupBy, bool $preserveKeys = false): static
+    public function groupBy(callable|array|string $groupBy, bool $preserveKeys = false): Collection|static
     {
         if (! $this->useAsCallable($groupBy) && is_array($groupBy)) {
             $nextGroups = $groupBy;
@@ -558,7 +560,6 @@ public function groupBy(callable|array|string $groupBy, bool $preserveKeys = fal
         $result = $this->newInstance($results);
 
         if (! empty($nextGroups)) {
-            // @phpstan-ignore return.type (recursive groupBy returns Enumerable, PHPStan can't verify it matches static)
             return $result->map->groupBy($nextGroups, $preserveKeys);
         }
 
@@ -1244,11 +1245,11 @@ public function shuffle(): static
      *
      * @param positive-int $size
      * @param positive-int $step
-     * @return static<int, static>
+     * @return Collection<int, static>|static<int, static>
      *
      * @throws InvalidArgumentException
      */
-    public function sliding(int $size = 2, int $step = 1): static
+    public function sliding(int $size = 2, int $step = 1): Collection|static
     {
         if ($size < 1) {
             throw new InvalidArgumentException('Size value must be at least 1.');
@@ -1508,7 +1509,7 @@ public function sortDesc(int $options = SORT_REGULAR): static
     /**
      * Sort the collection using the given callback.
      *
-     * @param array<array-key, array{int|string, 'asc'|'desc'|SortDirection}|(callable(TValue, TKey): mixed)|(callable(TValue, TValue): mixed)|int|string>|(callable(TValue, TKey): mixed)|int|string $callback
+     * @param array<array-key, array{int|string, 'asc'|'desc'|bool|SortDirection}|(callable(TValue, TValue): mixed)|int|string>|(callable(TValue, TKey): mixed)|int|string $callback
      */
     public function sortBy(callable|array|int|string $callback, int $options = SORT_REGULAR, SortDirection|bool $descending = false): static
     {
@@ -1545,7 +1546,7 @@ public function sortBy(callable|array|int|string $callback, int $options = SORT_
     /**
      * Sort the collection using multiple comparisons.
      *
-     * @param array<array-key, array{int|string, 'asc'|'desc'|SortDirection}|(callable(TValue, TKey): mixed)|(callable(TValue, TValue): mixed)|int|string> $comparisons
+     * @param array<array-key, array{int|string, 'asc'|'desc'|bool|SortDirection}|(callable(TValue, TValue): mixed)|int|string> $comparisons
      */
     protected function sortByMany(array $comparisons = [], int $options = SORT_REGULAR): static
     {
@@ -1603,7 +1604,7 @@ protected function sortByMany(array $comparisons = [], int $options = SORT_REGUL
     /**
      * Sort the collection in descending order using the given callback.
      *
-     * @param array<array-key, array{int|string, 'asc'|'desc'|SortDirection}|(callable(TValue, TKey): mixed)|(callable(TValue, TValue): mixed)|int|string>|(callable(TValue, TKey): mixed)|int|string $callback
+     * @param array<array-key, array{int|string, 'asc'|'desc'|bool|SortDirection}|(callable(TValue, TValue): mixed)|int|string>|(callable(TValue, TKey): mixed)|int|string $callback
      */
     public function sortByDesc(callable|array|int|string $callback, int $options = SORT_REGULAR): static
     {

src/collections/src/Enumerable.php

@@ -50,9 +50,9 @@ public static function make(Arrayable|iterable|null $items = []): static;
      * @template TTimesValue
      *
      * @param null|(callable(int): TTimesValue) $callback
-     * @return ($callback is null ? static<int, int> : static<int, TTimesValue>)
+     * @return ($callback is null ? static<int, int> : Collection<int, TTimesValue>|static<int, TTimesValue>)
      */
-    public static function times(int $number, ?callable $callback = null): static;
+    public static function times(int $number, ?callable $callback = null): Collection|static;
 
     /**
      * Create a collection with the given range.
@@ -440,14 +440,16 @@ public function get(mixed $key, mixed $default = null): mixed;
      * @template TGroupKey of array-key|bool|null|UnitEnum|BaseStringable
      *
      * @param array|(callable(TValue, TKey): (array<array-key, TGroupKey>|TGroupKey))|string $groupBy
-     * @return static<
-     *  ($groupBy is (array|string)
-     *      ? array-key
-     *      : (TGroupKey is array-key ? TGroupKey : (TGroupKey is bool ? int : (TGroupKey is (BaseStringable|null) ? string : array-key)))),
-     *  Collection<($preserveKeys is true ? TKey : int), ($groupBy is array ? mixed : TValue)>
-     * >
+     * @return ($groupBy is array
+     *  ? Collection<array-key, Collection<array-key, mixed>>|static<array-key, Collection<array-key, mixed>>
+     *  : static<
+     *      ($groupBy is string
+     *          ? array-key
+     *          : (TGroupKey is array-key ? TGroupKey : (TGroupKey is bool ? int : (TGroupKey is (BaseStringable|null) ? string : array-key)))),
+     *      Collection<($preserveKeys is true ? TKey : int), TValue>
+     *  >)
      */
-    public function groupBy(callable|array|string $groupBy, bool $preserveKeys = false): static;
+    public function groupBy(callable|array|string $groupBy, bool $preserveKeys = false): Collection|static;
 
     /**
      * Key an associative array by a field or using a callback.
@@ -576,8 +578,10 @@ public function map(callable $callback): Collection|static;
 
     /**
      * Run a map over each nested chunk of items.
+     *
+     * @return Collection<TKey, mixed>|static<TKey, mixed>
      */
-    public function mapSpread(callable $callback): static;
+    public function mapSpread(callable $callback): Collection|static;
 
     /**
      * Run a dictionary map over the items.
@@ -601,9 +605,9 @@ public function mapToDictionary(callable $callback): static;
      * @template TMapToGroupsValue
      *
      * @param callable(TValue, TKey): array<TMapToGroupsKey, TMapToGroupsValue> $callback
-     * @return static<TMapToGroupsKey, static<int, TMapToGroupsValue>>
+     * @return Collection<TMapToGroupsKey, static<int, TMapToGroupsValue>>|static<TMapToGroupsKey, static<int, TMapToGroupsValue>>
      */
-    public function mapToGroups(callable $callback): static;
+    public function mapToGroups(callable $callback): Collection|static;
 
     /**
      * Run an associative map over each of the items.
@@ -624,7 +628,7 @@ public function mapWithKeys(callable $callback): Collection|static;
      * @template TFlatMapKey of array-key
      * @template TFlatMapValue
      *
-     * @param callable(TValue, TKey): (array<TFlatMapKey, TFlatMapValue>|Collection<TFlatMapKey, TFlatMapValue>) $callback
+     * @param callable(TValue, TKey): (array<TFlatMapKey, TFlatMapValue>|Enumerable<TFlatMapKey, TFlatMapValue>) $callback
      * @return static<TFlatMapKey, TFlatMapValue>
      */
     public function flatMap(callable $callback): Collection|static;
@@ -823,9 +827,9 @@ public function shuffle(): static;
     /**
      * Create chunks representing a "sliding window" view of the items in the collection.
      *
-     * @return static<int, static>
+     * @return Collection<int, static>|static<int, static>
      */
-    public function sliding(int $size = 2, int $step = 1): static;
+    public function sliding(int $size = 2, int $step = 1): Collection|static;
 
     /**
      * Skip the first {$count} items.
@@ -894,6 +898,14 @@ public function chunk(int $size): static;
      */
     public function chunkWhile(callable $callback): static;
 
+    /**
+     * Chunk the collection into chunks by comparing adjacent values using the given key or callback.
+     *
+     * @param (callable(TValue, TKey): mixed)|string $key
+     * @return static<int, static<TKey, TValue>>
+     */
+    public function chunkBy(callable|string $key): static;
+
     /**
      * Split a collection into a certain number of groups, and fill the first groups completely.
      *
@@ -918,15 +930,15 @@ public function sortDesc(int $options = SORT_REGULAR): static;
     /**
      * Sort the collection using the given callback.
      *
-     * @param array<array-key, array{int|string, 'asc'|'desc'|SortDirection}|(callable(TValue, TKey): mixed)|(callable(TValue, TValue): mixed)|int|string>|(callable(TValue, TKey): mixed)|int|string $callback
+     * @param array<array-key, array{int|string, 'asc'|'desc'|bool|SortDirection}|(callable(TValue, TValue): mixed)|int|string>|(callable(TValue, TKey): mixed)|int|string $callback
      * @param int-mask-of<SORT_FLAG_CASE|SORT_LOCALE_STRING|SORT_NATURAL|SORT_NUMERIC|SORT_REGULAR|SORT_STRING> $options
      */
     public function sortBy(array|callable|int|string $callback, int $options = SORT_REGULAR, SortDirection|bool $descending = false): static;
 
     /**
      * Sort the collection in descending order using the given callback.
      *
-     * @param array<array-key, array{int|string, 'asc'|'desc'|SortDirection}|(callable(TValue, TKey): mixed)|(callable(TValue, TValue): mixed)|int|string>|(callable(TValue, TKey): mixed)|int|string $callback
+     * @param array<array-key, array{int|string, 'asc'|'desc'|bool|SortDirection}|(callable(TValue, TValue): mixed)|int|string>|(callable(TValue, TKey): mixed)|int|string $callback
      * @param int-mask-of<SORT_FLAG_CASE|SORT_LOCALE_STRING|SORT_NATURAL|SORT_NUMERIC|SORT_REGULAR|SORT_STRING> $options
      */
     public function sortByDesc(array|callable|int|string $callback, int $options = SORT_REGULAR): static;
@@ -984,7 +996,7 @@ public function takeWhile(mixed $value): static;
     /**
      * Pass the collection to the given callback and then return it.
      *
-     * @param callable(TValue): mixed $callback
+     * @param callable($this): mixed $callback
      */
     public function tap(callable $callback): static;
 

src/collections/src/HigherOrderCollectionProxy.php

@@ -5,19 +5,19 @@
 namespace Hypervel\Support;
 
 /**
- * @template TKey of array-key
+ * @template TMethod of string
+ * @template TValue
+ * @template TCollection of Enumerable<array-key, TValue>
  *
- * @template-covariant TValue
- *
- * @mixin \Hypervel\Support\Enumerable<TKey, TValue>
  * @mixin TValue
  */
 class HigherOrderCollectionProxy
 {
     /**
      * Create a new proxy instance.
      *
-     * @param \Hypervel\Support\Enumerable<TKey, TValue> $collection
+     * @param TCollection $collection
+     * @param TMethod $method
      */
     public function __construct(
         protected Enumerable $collection,