Merge pull request #38 from compwright/to-array

Add GenericCollection::toArray()

composer.json

@@ -26,5 +26,8 @@
         "psr-4": {
             "Aura\\Marshal\\": "tests/"
         }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit"
     }
 }

docs/advanced-usage.md

@@ -1,5 +1,13 @@
 # Advanced Usage
 
+## Extracting Marshaled Collections To Array
+
+Say you want to get your data back out, relations and all, but in array format. You can call toArray() on any collection:
+
+```php
+$posts = $manager->posts->toArray();
+```
+
 ## Entity and Collection Builders
 
 We have a good amount of control over how the type objects create entities and

src/Collection/GenericCollection.php

@@ -11,7 +11,7 @@
 namespace Aura\Marshal\Collection;
 
 use Aura\Marshal\Data;
-use Aura\Marshal\Type\GenericType;
+use Aura\Marshal\ToArrayTrait;
 
 /**
  *
@@ -22,6 +22,8 @@
  */
 class GenericCollection extends Data
 {
+    use ToArrayTrait;
+
     /**
      *
      * Returns an array of all values for a single field in the collection.

src/Entity/GenericEntity.php

@@ -12,6 +12,7 @@
 
 use Aura\Marshal\Data;
 use Aura\Marshal\Lazy\LazyInterface;
+use Aura\Marshal\ToArrayTrait;
 
 /**
  *
@@ -23,6 +24,7 @@
 class GenericEntity extends Data
 {
     use MagicArrayAccessTrait;
+    use ToArrayTrait;
 
     /**
      *

src/ToArrayInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Aura\Marshal;
+
+interface ToArrayInterface
+{
+    public function toArray(): array;
+}

src/ToArrayTrait.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Aura\Marshal;
+
+use Aura\Marshal\Lazy\GenericLazy;
+
+trait ToArrayTrait
+{
+    public function toArray(): array
+    {
+        return array_map(
+            function ($entity)
+            {
+                if ($entity instanceof GenericLazy) {
+                    $entity = $entity->get($this);
+                }
+
+                if ($entity instanceof ToArrayInterface) {
+                    return $entity->toArray();
+                }
+
+                return $entity;
+            },
+            $this->data
+        );
+    }
+}

tests/CollectionTest.php

@@ -4,7 +4,6 @@
 use Aura\Marshal\Type\GenericType;
 use Aura\Marshal\Entity\Builder as EntityBuilder;
 use Aura\Marshal\Collection\Builder as CollectionBuilder;
-use Aura\Marshal\Lazy\Builder as LazyBuilder;
 use Yoast\PHPUnitPolyfills\TestCases\TestCase;
 
 /**
@@ -13,6 +12,8 @@
  */
 class CollectionTest extends TestCase
 {
+    protected $data;
+
     protected $type;
 
     protected $collection;
@@ -35,6 +36,7 @@ protected function set_up()
             ];
         }
 
+        $this->data = $data;
         $this->collection = new GenericCollection($data);
         $this->empty_collection = new GenericCollection([]);
     }
@@ -95,4 +97,9 @@ public function testObjectsInCollectionAreInIdentityMap()
         $actual = $collection[0];
         $this->assertSame($expect->name, $actual->name);
     }
+
+    public function testToArray()
+    {
+        $this->assertEquals($this->data, $this->collection->toArray());
+    }
 }

tests/EntityTest.php

@@ -90,4 +90,18 @@ public function testMagicPropertyAccess()
         $expect = (object) ['foreign_field' => 'foreign_value'];
         $this->assertEquals($expect, $actual);
     }
+
+    public function testToArray()
+    {
+        $entity = $this->newGenericEntity();
+        $expect = [
+            'foo' => 'bar',
+            'baz' => 'dim',
+            'zim' => 'gir',
+            'related' => (object) [
+                'foreign_field' => 'foreign_value',
+            ],
+        ];
+        $this->assertEquals($expect, $entity->toArray());
+    }
 }