Merge pull request #12 from TomHAnderson/feature/null-embedded-resources

Allow null for embedded resource

.gitignore

@@ -1,6 +1,7 @@
-vendor
-.phpunit.cache
-coverage
-composer.lock
-.vscode
-.phpcs-cache
+/vendor
+/.phpunit.cache
+/coverage
+/composer.lock
+/.vscode
+/.phpcs-cache
+/.idea

src/Resource.php

@@ -10,6 +10,7 @@
 use function array_merge;
 use function array_push;
 use function is_array;
+use function is_null;
 
 class Resource
 {
@@ -62,7 +63,7 @@ public function addLink(string $reference, $definition): self
         return $this;
     }
 
-    public function addEmbeddedResource(string $ref, Resource $resource): self
+    public function addEmbeddedResource(string $ref, Resource |null $resource): self
     {
         $this->embedded[$ref] = $resource;
 
@@ -118,6 +119,8 @@ public function toArray(): array
                     foreach ($resources as $resource) {
                         $data['_embedded'][$ref][] = $resource->toArray();
                     }
+                } elseif ($resources === null) {
+                    $data['_embedded'][$ref] = $resources;
                 } else {
                     $data['_embedded'][$ref] = $resources->toArray();
                 }

test/ResourceTest.php

@@ -43,6 +43,16 @@ public function testEmbeddedResource(): void
         $this->assertEquals('testing', $resource1->toArray()['_embedded']['embedded']['test']);
     }
 
+    public function testNullEmbeddedResource(): void
+    {
+        $hydratorManager = new HydratorManager();
+        $resource1       = $hydratorManager->resource();
+        $resource1->addEmbeddedResource('embedded', null);
+        $result = $resource1->toArray();
+
+        $this->assertNull($result['_embedded']['embedded']);
+    }
+
     public function testEmbeddedResources(): void
     {
         $hydratorManager = new HydratorManager();