Improve PHPDoc return type for Eloquent's getOriginal methods with conditional typing (#55779)

clementbirkle · web-flow · commit 5a915b363176 · 2025-05-19T07:53:38.000-05:00
diff --git a/src/Illuminate/Database/Eloquent/Concerns/HasAttributes.php b/src/Illuminate/Database/Eloquent/Concerns/HasAttributes.php
@@ -1960,7 +1960,7 @@ public function setRawAttributes(array $attributes, $sync = false)
      *
      * @param  string|null  $key
      * @param  mixed  $default
-     * @return mixed|array
+     * @return ($key is null ? array<string, mixed> : mixed)
      */
     public function getOriginal($key = null, $default = null)
     {
@@ -1974,7 +1974,7 @@ public function getOriginal($key = null, $default = null)
      *
      * @param  string|null  $key
      * @param  mixed  $default
-     * @return mixed|array
+     * @return ($key is null ? array<string, mixed> : mixed)
      */
     protected function getOriginalWithoutRewindingModel($key = null, $default = null)
     {
@@ -1994,7 +1994,7 @@ protected function getOriginalWithoutRewindingModel($key = null, $default = null
      *
      * @param  string|null  $key
      * @param  mixed  $default
-     * @return mixed|array
+     * @return ($key is null ? array<string, mixed> : mixed)
      */
     public function getRawOriginal($key = null, $default = null)
     {

Original file line number	Diff line number	Diff line change
`@@ -1960,7 +1960,7 @@ public function setRawAttributes(array $attributes, $sync = false)`
`1960`	`1960`	`*`
`1961`	`1961`	`* @param string\|null $key`
`1962`	`1962`	`* @param mixed $default`
`1963`		`- * @return mixed\|array`
	`1963`	`+ * @return ($key is null ? array<string, mixed> : mixed)`
`1964`	`1964`	`*/`
`1965`	`1965`	`public function getOriginal($key = null, $default = null)`
`1966`	`1966`	`{`
`@@ -1974,7 +1974,7 @@ public function getOriginal($key = null, $default = null)`
`1974`	`1974`	`*`
`1975`	`1975`	`* @param string\|null $key`
`1976`	`1976`	`* @param mixed $default`
`1977`		`- * @return mixed\|array`
	`1977`	`+ * @return ($key is null ? array<string, mixed> : mixed)`
`1978`	`1978`	`*/`
`1979`	`1979`	`protected function getOriginalWithoutRewindingModel($key = null, $default = null)`
`1980`	`1980`	`{`
`@@ -1994,7 +1994,7 @@ protected function getOriginalWithoutRewindingModel($key = null, $default = null`
`1994`	`1994`	`*`
`1995`	`1995`	`* @param string\|null $key`
`1996`	`1996`	`* @param mixed $default`
`1997`		`- * @return mixed\|array`
	`1997`	`+ * @return ($key is null ? array<string, mixed> : mixed)`
`1998`	`1998`	`*/`
`1999`	`1999`	`public function getRawOriginal($key = null, $default = null)`
`2000`	`2000`	`{`