added MetadataInterface

Author: tobias-trozowski

src/Metadata/AbstractMetadata.php

@@ -9,7 +9,7 @@
 
 use Zend\Expressive\Hal\LinkCollection;
 
-abstract class AbstractMetadata
+abstract class AbstractMetadata implements MetadataInterface
 {
     use LinkCollection;
 
@@ -22,4 +22,9 @@ public function getClass() : string
     {
         return $this->class;
     }
+
+    public function hasReachedMaxDepth(int $currentDepth): bool
+    {
+        return false;
+    }
 }

src/Metadata/MetadataInterface.php

@@ -0,0 +1,23 @@
+<?php
+declare(strict_types=1);
+
+namespace Zend\Expressive\Hal\Metadata;
+
+interface MetadataInterface
+{
+    /**
+     * Returns the configured metadata class name
+     *
+     * @return string
+     */
+    public function getClass() : string;
+
+    /**
+     * Determines whenever the current depth level exceeds the allowed max depth
+     *
+     * @param int $currentDepth
+     *
+     * @return bool
+     */
+    public function hasReachedMaxDepth(int $currentDepth): bool;
+}

src/Metadata/RouteBasedResourceMetadata.php

@@ -67,8 +67,8 @@ public function setRouteParams(array $routeParams) : void
         $this->routeParams = $routeParams;
     }
 
-    public function getMaxDepth(): int
+    public function hasReachedMaxDepth(int $currentDepth): bool
     {
-        return $this->maxDepth;
+        return $currentDepth > $this->maxDepth;
     }
 }

src/ResourceGenerator/ExtractInstanceTrait.php

@@ -10,7 +10,6 @@
 use Psr\Http\Message\ServerRequestInterface;
 use Zend\Expressive\Hal\Metadata\AbstractCollectionMetadata;
 use Zend\Expressive\Hal\Metadata\AbstractMetadata;
-use Zend\Expressive\Hal\Metadata\RouteBasedResourceMetadata;
 use Zend\Expressive\Hal\ResourceGenerator;
 use Zend\Hydrator\ExtractionInterface;
 
@@ -39,14 +38,8 @@ private function extractInstance(
 
         $array = $extractor->extract($instance);
 
-        if ($metadata instanceof RouteBasedResourceMetadata) {
-            $maxDepth = $metadata->getMaxDepth();
-            if ($depth > $maxDepth) {
-                $resourceIdentifier = $metadata->getResourceIdentifier();
-                return [
-                    $resourceIdentifier => $array[$resourceIdentifier]
-                ];
-            }
+        if ($metadata->hasReachedMaxDepth($depth)) {
+            return $array;
         }
 
         // Extract nested resources if present in metadata map

src/ResourceGenerator/RouteBasedResourceStrategy.php

@@ -47,8 +47,7 @@ public function createResource(
             $routeParams[$routeIdentifier] = $data[$resourceIdentifier];
         }
 
-        $maxDepth = $metadata->getMaxDepth();
-        if ($depth > $maxDepth) {
+        if ($metadata->hasReachedMaxDepth($depth)) {
             $data = [];
         }