[9.x] Generic Type for Illuminate\Support\Fluent (#40273)

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* Implements existing generic interfaces

Co-authored-by: Nuno Maduro <[email protected]>

Author: crynobone

src/Illuminate/Support/Fluent.php

@@ -7,19 +7,26 @@
 use Illuminate\Contracts\Support\Jsonable;
 use JsonSerializable;
 
+/**
+ * @template TKey of array-key
+ * @template TValue
+ *
+ * @implements \Illuminate\Contracts\Support\Arrayable<TKey, TValue>
+ * @implements \ArrayAccess<TKey, TValue>
+ */
 class Fluent implements Arrayable, ArrayAccess, Jsonable, JsonSerializable
 {
     /**
      * All of the attributes set on the fluent instance.
      *
-     * @var array
+     * @var array<TKey, TValue>
      */
     protected $attributes = [];
 
     /**
      * Create a new fluent instance.
      *
-     * @param  array|object  $attributes
+     * @param  iterable<TKey, TValue>  $attributes
      * @return void
      */
     public function __construct($attributes = [])
@@ -32,9 +39,11 @@ public function __construct($attributes = [])
     /**
      * Get an attribute from the fluent instance.
      *
-     * @param  string  $key
-     * @param  mixed  $default
-     * @return mixed
+     * @template TGetDefault
+     *
+     * @param  TKey  $key
+     * @param  TGetDefault|(\Closure(): TGetDefault)  $default
+     * @return TValue|TGetDefault
      */
     public function get($key, $default = null)
     {
@@ -48,7 +57,7 @@ public function get($key, $default = null)
     /**
      * Get the attributes from the fluent instance.
      *
-     * @return array
+     * @return array<TKey, TValue>
      */
     public function getAttributes()
     {
@@ -58,7 +67,7 @@ public function getAttributes()
     /**
      * Convert the fluent instance to an array.
      *
-     * @return array
+     * @return array<TKey, TValue>
      */
     public function toArray()
     {
@@ -68,7 +77,7 @@ public function toArray()
     /**
      * Convert the object into something JSON serializable.
      *
-     * @return array
+     * @return array<TKey, TValue>
      */
     #[\ReturnTypeWillChange]
     public function jsonSerialize()
@@ -90,7 +99,7 @@ public function toJson($options = 0)
     /**
      * Determine if the given offset exists.
      *
-     * @param  string  $offset
+     * @param  TKey  $offset
      * @return bool
      */
     #[\ReturnTypeWillChange]
@@ -102,8 +111,8 @@ public function offsetExists($offset)
     /**
      * Get the value for a given offset.
      *
-     * @param  string  $offset
-     * @return mixed
+     * @param  TKey  $offset
+     * @return TValue|null
      */
     #[\ReturnTypeWillChange]
     public function offsetGet($offset)
@@ -114,8 +123,8 @@ public function offsetGet($offset)
     /**
      * Set the value at the given offset.
      *
-     * @param  string  $offset
-     * @param  mixed  $value
+     * @param  TKey  $offset
+     * @param  TValue  $value
      * @return void
      */
     #[\ReturnTypeWillChange]
@@ -127,7 +136,7 @@ public function offsetSet($offset, $value)
     /**
      * Unset the value at the given offset.
      *
-     * @param  string  $offset
+     * @param  TKey  $offset
      * @return void
      */
     #[\ReturnTypeWillChange]
@@ -139,8 +148,8 @@ public function offsetUnset($offset)
     /**
      * Handle dynamic calls to the fluent instance to set attributes.
      *
-     * @param  string  $method
-     * @param  array  $parameters
+     * @param  TKey  $method
+     * @param  array{0: ?TValue}  $parameters
      * @return $this
      */
     public function __call($method, $parameters)
@@ -153,8 +162,8 @@ public function __call($method, $parameters)
     /**
      * Dynamically retrieve the value of an attribute.
      *
-     * @param  string  $key
-     * @return mixed
+     * @param  TKey  $key
+     * @return TValue|null
      */
     public function __get($key)
     {
@@ -164,8 +173,8 @@ public function __get($key)
     /**
      * Dynamically set the value of an attribute.
      *
-     * @param  string  $key
-     * @param  mixed  $value
+     * @param  TKey  $key
+     * @param  TValue  $value
      * @return void
      */
     public function __set($key, $value)
@@ -176,7 +185,7 @@ public function __set($key, $value)
     /**
      * Dynamically check if an attribute is set.
      *
-     * @param  string  $key
+     * @param  TKey  $key
      * @return bool
      */
     public function __isset($key)
@@ -187,7 +196,7 @@ public function __isset($key)
     /**
      * Dynamically unset an attribute.
      *
-     * @param  string  $key
+     * @param  TKey  $key
      * @return void
      */
     public function __unset($key)

types/Support/Fluent.php

@@ -0,0 +1,21 @@
+<?php
+
+use Illuminate\Support\Fluent;
+use function PHPStan\Testing\assertType;
+
+$fluent = new Fluent(['name' => 'Taylor', 'age' => 25, 'user' => new User]);
+
+assertType('Illuminate\Support\Fluent<string, int|string|User>', $fluent);
+assertType('Illuminate\Support\Fluent<string, string>', new Fluent(['name' => 'Taylor']));
+assertType('Illuminate\Support\Fluent<string, int>', new Fluent(['age' => 25]));
+assertType('Illuminate\Support\Fluent<string, User>', new Fluent(['user' => new User]));
+
+assertType('int|string|User|null', $fluent['name']);
+assertType('int|string|User|null', $fluent['age']);
+assertType('int|string|User|null', $fluent['age']);
+assertType('int|string|User|null', $fluent->get('name'));
+assertType('int|string|User|null', $fluent->get('foobar'));
+assertType('int|string|User', $fluent->get('foobar', 'zonda'));
+assertType('array<string, int|string|User>', $fluent->getAttributes());
+assertType('array<string, int|string|User>', $fluent->toArray());
+assertType('array<string, int|string|User>', $fluent->jsonSerialize());