added DepthAwareMetadataInterface

Author: tobias-trozowski

src/Metadata/DepthAwareMetadataInterface.php

@@ -0,0 +1,23 @@
+<?php
+declare(strict_types=1);
+
+namespace Zend\Expressive\Hal\Metadata;
+
+interface DepthAwareMetadataInterface
+{
+    /**
+     * Returns configured max depth
+     *
+     * @return int
+     */
+    public function getMaxDepth(): int;
+
+    /**
+     * 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

@@ -7,7 +7,7 @@
 
 namespace Zend\Expressive\Hal\Metadata;
 
-class RouteBasedResourceMetadata extends AbstractResourceMetadata
+class RouteBasedResourceMetadata extends AbstractResourceMetadata implements DepthAwareMetadataInterface
 {
     /** @var string */
     private $resourceIdentifier;
@@ -71,4 +71,9 @@ public function getMaxDepth(): int
     {
         return $this->maxDepth;
     }
+
+    public function hasReachedMaxDepth(int $currentDepth): bool
+    {
+        return $currentDepth > $this->maxDepth;
+    }
 }

src/ResourceGenerator/ExtractInstanceTrait.php

@@ -10,6 +10,7 @@
 use Psr\Http\Message\ServerRequestInterface;
 use Zend\Expressive\Hal\Metadata\AbstractCollectionMetadata;
 use Zend\Expressive\Hal\Metadata\AbstractMetadata;
+use Zend\Expressive\Hal\Metadata\DepthAwareMetadataInterface;
 use Zend\Expressive\Hal\Metadata\RouteBasedResourceMetadata;
 use Zend\Expressive\Hal\ResourceGenerator;
 use Zend\Hydrator\ExtractionInterface;
@@ -39,14 +40,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 instanceof DepthAwareMetadataInterface && $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 instanceof Metadata\DepthAwareMetadataInterface && $metadata->hasReachedMaxDepth($depth)) {
             $data = [];
         }