Add InteractsWithData trait and enhance Fluent class (#7476)

Author: huangdijia

src/Fluent.php

@@ -15,13 +15,18 @@
 use ArrayAccess;
 use ArrayIterator;
 use Closure;
+use Hyperf\Collection\Arr;
 use Hyperf\Contract\Arrayable;
 use Hyperf\Contract\Jsonable;
 use Hyperf\Macroable\Macroable;
+use Hyperf\Support\Traits\InteractsWithData;
 use IteratorAggregate;
 use JsonSerializable;
 use Traversable;
 
+use function Hyperf\Collection\data_get;
+use function Hyperf\Collection\data_set;
+
 /**
  * Most of the methods in this file come from illuminate/support,
  * thanks Laravel Team provide such a useful class.
@@ -34,6 +39,7 @@
  */
 class Fluent implements ArrayAccess, Arrayable, IteratorAggregate, Jsonable, JsonSerializable
 {
+    use InteractsWithData;
     use Macroable{
         __call as macroCall;
     }
@@ -52,9 +58,7 @@ class Fluent implements ArrayAccess, Arrayable, IteratorAggregate, Jsonable, Jso
      */
     public function __construct($attributes = [])
     {
-        foreach ($attributes as $key => $value) {
-            $this->attributes[$key] = $value;
-        }
+        $this->fill($attributes);
     }
 
     /**
@@ -123,6 +127,29 @@ public function __toString(): string
         return $this->toJson();
     }
 
+    /**
+     * Get all of the attributes from the fluent instance.
+     *
+     * @param null|array|mixed $keys
+     * @return array
+     */
+    public function all($keys = null)
+    {
+        $data = $this->data();
+
+        if (! $keys) {
+            return $data;
+        }
+
+        $results = [];
+
+        foreach (is_array($keys) ? $keys : func_get_args() as $key) {
+            Arr::set($results, $key, Arr::get($data, $key));
+        }
+
+        return $results;
+    }
+
     /**
      * Get an attribute from the fluent instance.
      *
@@ -133,6 +160,47 @@ public function __toString(): string
      * @return TGetDefault|TValue
      */
     public function get($key, $default = null)
+    {
+        return data_get($this->attributes, $key, $default);
+    }
+
+    /**
+     * Set an attribute on the fluent instance using "dot" notation.
+     *
+     * @param TKey $key
+     * @param TValue $value
+     * @return $this
+     */
+    public function set($key, $value)
+    {
+        data_set($this->attributes, $key, $value);
+
+        return $this;
+    }
+
+    /**
+     * Fill the fluent instance with an array of attributes.
+     *
+     * @param iterable<TKey, TValue> $attributes
+     * @return $this
+     */
+    public function fill($attributes)
+    {
+        foreach ($attributes as $key => $value) {
+            $this->attributes[$key] = $value;
+        }
+
+        return $this;
+    }
+
+    /**
+     * Get an attribute from the fluent instance.
+     *
+     * @param string $key
+     * @param mixed $default
+     * @return mixed
+     */
+    public function value($key, $default = null)
     {
         if (array_key_exists($key, $this->attributes)) {
             return $this->attributes[$key];
@@ -141,6 +209,20 @@ public function get($key, $default = null)
         return value($default);
     }
 
+    /**
+     * Get the value of the given key as a new Fluent instance.
+     *
+     * @param string $key
+     * @param mixed $default
+     * @return static
+     */
+    public function scope($key, $default = null)
+    {
+        return new static(
+            (array) $this->get($key, $default)
+        );
+    }
+
     /**
      * Get the attributes from the fluent instance.
      *
@@ -253,4 +335,16 @@ public function getIterator(): Traversable
     {
         return new ArrayIterator($this->attributes);
     }
+
+    /**
+     * Get data from the fluent instance.
+     *
+     * @param string $key
+     * @param mixed $default
+     * @return mixed
+     */
+    protected function data($key = null, $default = null)
+    {
+        return $this->get($key, $default);
+    }
 }

src/Functions.php

@@ -12,6 +12,7 @@
 
 namespace Hyperf\Support;
 
+use BackedEnum;
 use Carbon\Carbon;
 use Closure;
 use DateTimeZone;
@@ -21,6 +22,7 @@
 use Hyperf\Stringable\StrCache;
 use Hyperf\Support\Backoff\ArrayBackoff;
 use Throwable;
+use UnitEnum;
 
 /**
  * Return the default value of the given value.
@@ -312,3 +314,25 @@ function today($tz = null)
 {
     return Carbon::today($tz);
 }
+
+/**
+ * Return a scalar value for the given value that might be an enum.
+ *
+ * @internal
+ *
+ * @template TValue
+ * @template TDefault
+ *
+ * @param TValue $value
+ * @param callable(TValue): TDefault|TDefault $default
+ * @return ($value is empty ? TDefault : mixed)
+ */
+function enum_value($value, $default = null)
+{
+    return match (true) {
+        $value instanceof BackedEnum => $value->value,
+        $value instanceof UnitEnum => $value->name,
+
+        default => $value ?? value($default),
+    };
+}