replaced DepthAwareMetadataInterface with 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/DepthAwareMetadataInterface.php renamed to src/Metadata/MetadataInterface.php

@@ -3,14 +3,14 @@
 
 namespace Zend\Expressive\Hal\Metadata;
 
-interface DepthAwareMetadataInterface
+interface MetadataInterface
 {
     /**
-     * Returns configured max depth
+     * Returns the configured metadata class name
      *
-     * @return int
+     * @return string
      */
-    public function getMaxDepth(): int;
+    public function getClass() : string;
 
     /**
      * Determines whenever the current depth level exceeds the allowed max depth

src/Metadata/RouteBasedResourceMetadata.php

@@ -7,7 +7,7 @@
 
 namespace Zend\Expressive\Hal\Metadata;
 
-class RouteBasedResourceMetadata extends AbstractResourceMetadata implements DepthAwareMetadataInterface
+class RouteBasedResourceMetadata extends AbstractResourceMetadata
 {
     /** @var string */
     private $resourceIdentifier;
@@ -67,11 +67,6 @@ public function setRouteParams(array $routeParams) : void
         $this->routeParams = $routeParams;
     }
 
-    public function getMaxDepth(): int
-    {
-        return $this->maxDepth;
-    }
-
     public function hasReachedMaxDepth(int $currentDepth): bool
     {
         return $currentDepth > $this->maxDepth;

src/ResourceGenerator/ExtractInstanceTrait.php

@@ -10,8 +10,6 @@
 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;
 
@@ -40,7 +38,7 @@ private function extractInstance(
 
         $array = $extractor->extract($instance);
 
-        if ($metadata instanceof DepthAwareMetadataInterface && $metadata->hasReachedMaxDepth($depth)) {
+        if ($metadata->hasReachedMaxDepth($depth)) {
             return $array;
         }
 

src/ResourceGenerator/RouteBasedResourceStrategy.php

@@ -47,7 +47,7 @@ public function createResource(
             $routeParams[$routeIdentifier] = $data[$resourceIdentifier];
         }
 
-        if ($metadata instanceof Metadata\DepthAwareMetadataInterface && $metadata->hasReachedMaxDepth($depth)) {
+        if ($metadata->hasReachedMaxDepth($depth)) {
             $data = [];
         }