dump as collection option

Author: michael-rubel

src/Traits/LoopFunctions.php

@@ -5,6 +5,7 @@
 namespace MichaelRubel\LoopFunctions\Traits;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Collection;
 
 trait LoopFunctions
 {
@@ -75,12 +76,16 @@ public function arrayToProperties(array|\ArrayAccess|null $data, mixed $rescue =
      *
      * @param string|object|null $class
      * @param int|null           $filter
+     * @param bool               $asCollection
      *
-     * @return array
+     * @return array|Collection
      * @throws \ReflectionException
      */
-    public function dumpProperties(string|object|null $class = null, ?int $filter = null): array
-    {
+    public function dumpProperties(
+        string|object|null $class = null,
+        ?int $filter = null,
+        bool $asCollection = false
+    ): array|Collection {
         $class = match (true) {
             is_string($class) => app($class),
             is_object($class) => $class,
@@ -90,10 +95,16 @@ public function dumpProperties(string|object|null $class = null, ?int $filter =
         $properties = (new \ReflectionClass($class))
             ->getProperties($filter);
 
-        return collect($properties)->mapWithKeys(
+        $collection = collect($properties)->mapWithKeys(
             fn (\ReflectionProperty $property) => [
                 $property->getName() => $property->getValue($class),
             ]
-        )->all();
+        );
+
+        if ($asCollection) {
+            return $collection;
+        }
+
+        return $collection->all();
     }
 }

tests/RecursiveClassDumpTest.php

@@ -33,4 +33,15 @@ public function testCanDumpPassedObjectProperties()
         $this->assertArrayHasKey('escapeWhenCastingToString', $properties);
         $this->assertFalse($properties['escapeWhenCastingToString']);
     }
+
+    /** @test */
+    public function testCanDumpAsCollection()
+    {
+        $properties = app(TestClass::class)->dumpProperties(
+            class: Collection::class,
+            asCollection: true,
+        );
+
+        $this->assertInstanceOf(Collection::class, $properties);
+    }
 }