Fix incorrect PHPDoc for KeyBy and GroupBy (#52918)

kayw-geek · web-flow · commit 465044f988f9 · 2024-09-25T11:08:32.000-04:00
diff --git a/Collection.php b/Collection.php
@@ -490,7 +490,7 @@ public function getOrPut($key, $value)
      *
      * @param  (callable(TValue, TKey): TGroupKey)|array|string  $groupBy
      * @param  bool  $preserveKeys
-     * @return static<TGroupKey, static<($preserveKeys is true ? TKey : int), TValue>>
+     * @return static<($groupBy is string ? array-key : ($groupBy is array ? array-key : TGroupKey)), static<($preserveKeys is true ? TKey : int), TValue>>
      */
     public function groupBy($groupBy, $preserveKeys = false)
     {
@@ -542,7 +542,7 @@ public function groupBy($groupBy, $preserveKeys = false)
      * @template TNewKey of array-key
      *
      * @param  (callable(TValue, TKey): TNewKey)|array|string  $keyBy
-     * @return static<TNewKey, TValue>
+     * @return static<($keyBy is string ? array-key : ($keyBy is array ? array-key : TNewKey)), TValue>
      */
     public function keyBy($keyBy)
     {
diff --git a/Enumerable.php b/Enumerable.php
@@ -522,7 +522,7 @@ public function get($key, $default = null);
      *
      * @param  (callable(TValue, TKey): TGroupKey)|array|string  $groupBy
      * @param  bool  $preserveKeys
-     * @return static<TGroupKey, static<($preserveKeys is true ? TKey : int), TValue>>
+     * @return static<($groupBy is string ? array-key : ($groupBy is array ? array-key : TGroupKey)), static<($preserveKeys is true ? TKey : int), TValue>>
      */
     public function groupBy($groupBy, $preserveKeys = false);
 
@@ -532,7 +532,7 @@ public function groupBy($groupBy, $preserveKeys = false);
      * @template TNewKey of array-key
      *
      * @param  (callable(TValue, TKey): TNewKey)|array|string  $keyBy
-     * @return static<TNewKey, TValue>
+     * @return static<($keyBy is string ? array-key : ($keyBy is array ? array-key : TNewKey)), TValue>
      */
     public function keyBy($keyBy);
 
diff --git a/LazyCollection.php b/LazyCollection.php
@@ -548,7 +548,7 @@ public function get($key, $default = null)
      *
      * @param  (callable(TValue, TKey): TGroupKey)|array|string  $groupBy
      * @param  bool  $preserveKeys
-     * @return static<TGroupKey, static<($preserveKeys is true ? TKey : int), TValue>>
+     * @return static<($groupBy is string ? array-key : ($groupBy is array ? array-key : TGroupKey)), static<($preserveKeys is true ? TKey : int), TValue>>
      */
     public function groupBy($groupBy, $preserveKeys = false)
     {
@@ -561,7 +561,7 @@ public function groupBy($groupBy, $preserveKeys = false)
      * @template TNewKey of array-key
      *
      * @param  (callable(TValue, TKey): TNewKey)|array|string  $keyBy
-     * @return static<TNewKey, TValue>
+     * @return static<($keyBy is string ? array-key : ($keyBy is array ? array-key : TNewKey)), TValue>
      */
     public function keyBy($keyBy)
     {

Original file line number	Diff line number	Diff line change
`@@ -490,7 +490,7 @@ public function getOrPut($key, $value)`
`490`	`490`	`*`
`491`	`491`	`* @param (callable(TValue, TKey): TGroupKey)\|array\|string $groupBy`
`492`	`492`	`* @param bool $preserveKeys`
`493`		`- * @return static<TGroupKey, static<($preserveKeys is true ? TKey : int), TValue>>`
	`493`	`+ * @return static<($groupBy is string ? array-key : ($groupBy is array ? array-key : TGroupKey)), static<($preserveKeys is true ? TKey : int), TValue>>`
`494`	`494`	`*/`
`495`	`495`	`public function groupBy($groupBy, $preserveKeys = false)`
`496`	`496`	`{`
`@@ -542,7 +542,7 @@ public function groupBy($groupBy, $preserveKeys = false)`
`542`	`542`	`* @template TNewKey of array-key`
`543`	`543`	`*`
`544`	`544`	`* @param (callable(TValue, TKey): TNewKey)\|array\|string $keyBy`
`545`		`- * @return static<TNewKey, TValue>`
	`545`	`+ * @return static<($keyBy is string ? array-key : ($keyBy is array ? array-key : TNewKey)), TValue>`
`546`	`546`	`*/`
`547`	`547`	`public function keyBy($keyBy)`
`548`	`548`	`{`
Original file line number	Diff line number	Diff line change
`@@ -548,7 +548,7 @@ public function get($key, $default = null)`
`548`	`548`	`*`
`549`	`549`	`* @param (callable(TValue, TKey): TGroupKey)\|array\|string $groupBy`
`550`	`550`	`* @param bool $preserveKeys`
`551`		`- * @return static<TGroupKey, static<($preserveKeys is true ? TKey : int), TValue>>`
	`551`	`+ * @return static<($groupBy is string ? array-key : ($groupBy is array ? array-key : TGroupKey)), static<($preserveKeys is true ? TKey : int), TValue>>`
`552`	`552`	`*/`
`553`	`553`	`public function groupBy($groupBy, $preserveKeys = false)`
`554`	`554`	`{`
`@@ -561,7 +561,7 @@ public function groupBy($groupBy, $preserveKeys = false)`
`561`	`561`	`* @template TNewKey of array-key`
`562`	`562`	`*`
`563`	`563`	`* @param (callable(TValue, TKey): TNewKey)\|array\|string $keyBy`
`564`		`- * @return static<TNewKey, TValue>`
	`564`	`+ * @return static<($keyBy is string ? array-key : ($keyBy is array ? array-key : TNewKey)), TValue>`
`565`	`565`	`*/`
`566`	`566`	`public function keyBy($keyBy)`
`567`	`567`	`{`