added new MetadataInterface

added missing param in doc-blocks
fixed ExtractInstanceTrait::extractInstance signature (AbstractMetadata -> AbstractResourceMetadata)
fixed few return types
fixed useless string conversion in Link constructor
changed generateSelfLink and generateLinkForPage signature in RouteBasedCollectionStrategy to be more specific
changed UrlBasedCollectionStrategy::generateSelfLink signature to be more specific
changed few lambda function to static wherever possible
removed DepthAwareMetadataInterface

Author: tobias-trozowski

src/HalResource.php

@@ -83,7 +83,7 @@ public function __construct(array $data = [], array $links = [], array $embedded
             $this->embedded[$name] = $resource;
         });
 
-        if (array_reduce($links, function ($containsNonLinkItem, $link) {
+        if (array_reduce($links, static function ($containsNonLinkItem, $link) {
             return $containsNonLinkItem || ! $link instanceof LinkInterface;
         }, false)) {
             throw new InvalidArgumentException('Non-Link item provided in $links array');
@@ -392,7 +392,7 @@ private function isResourceCollection($value, string $name, string $context) : b
 
     private function serializeLinks()
     {
-        $relations = array_reduce($this->links, function (array $byRelation, LinkInterface $link) {
+        $relations = array_reduce($this->links, static function (array $byRelation, LinkInterface $link) {
             $representation = array_merge($link->getAttributes(), [
                 'href' => $link->getHref(),
             ]);
@@ -401,7 +401,7 @@ private function serializeLinks()
             }
 
             $linkRels = $link->getRels();
-            array_walk($linkRels, function ($rel) use (&$byRelation, $representation) {
+            array_walk($linkRels, static function ($rel) use (&$byRelation, $representation) {
                 $forceCollection = array_key_exists(Link::AS_COLLECTION, $representation)
                     ? (bool) $representation[Link::AS_COLLECTION]
                     : false;
@@ -431,7 +431,7 @@ private function serializeLinks()
             return $byRelation;
         }, []);
 
-        array_walk($relations, function ($links, $key) use (&$relations) {
+        array_walk($relations, static function ($links, $key) use (&$relations) {
             if (isset($relations[$key][Link::AS_COLLECTION])) {
                 // If forcing a collection, do nothing to the links, but DO
                 // remove the marker indicating a collection should be
@@ -452,7 +452,7 @@ private function serializeEmbeddedResources()
         array_walk($this->embedded, function ($resource, $name) use (&$embedded) {
             $embedded[$name] = $resource instanceof self
                 ? $resource->toArray()
-                : array_map(function ($item) {
+                : array_map(static function ($item) {
                     return $item->toArray();
                 }, $resource);
         });

src/HalResponseFactory.php

@@ -46,7 +46,7 @@ public function __construct(
         Renderer\XmlRenderer $xmlRenderer = null
     ) {
         // Ensures type safety of the composed factory
-        $this->responseFactory = function () use ($responseFactory) : ResponseInterface {
+        $this->responseFactory = static function () use ($responseFactory) : ResponseInterface {
             return $responseFactory();
         };
         $this->jsonRenderer = $jsonRenderer ?: new Renderer\JsonRenderer();

src/HalResponseFactoryFactory.php

@@ -9,6 +9,7 @@
 
 use Psr\Container\ContainerInterface;
 use Psr\Http\Message\ResponseInterface;
+use RuntimeException;
 
 /**
  * Create and return a HalResponseFactory instance.

src/Link.php

@@ -48,7 +48,7 @@ class Link implements EvolvableLinkInterface
 
     /**
      * @param string|string[] $relation One or more relations represented by this link.
-     * @param string|object $uri
+     * @param string $uri
      * @param bool $isTemplated
      * @param array $attributes
      * @throws InvalidArgumentException if $relation is neither a string nor an array.
@@ -58,7 +58,7 @@ class Link implements EvolvableLinkInterface
     public function __construct($relation, string $uri = '', bool $isTemplated = false, array $attributes = [])
     {
         $this->relations = $this->validateRelation($relation);
-        $this->uri = is_string($uri) ? $uri : (string) $uri;
+        $this->uri = $uri;
         $this->isTemplated = $isTemplated;
         $this->attributes = $this->validateAttributes($attributes);
     }
@@ -153,7 +153,7 @@ public function withoutRel($rel)
         }
 
         $new = clone $this;
-        $new->relations = array_filter($this->relations, function ($value) use ($rel) {
+        $new->relations = array_filter($this->relations, static function ($value) use ($rel) {
             return $rel !== $value;
         });
         return $new;
@@ -227,7 +227,7 @@ private function validateAttributeValue($value, string $context)
             ));
         }
 
-        if (is_array($value) && array_reduce($value, function ($isInvalid, $value) {
+        if (is_array($value) && array_reduce($value, static function ($isInvalid, $value) {
             return $isInvalid || ! is_string($value);
         }, false)) {
             throw new InvalidArgumentException(sprintf(
@@ -260,7 +260,7 @@ private function validateRelation($relation)
             ));
         }
 
-        if (is_array($relation) && false === array_reduce($relation, function ($isString, $value) {
+        if (is_array($relation) && false === array_reduce($relation, static function ($isString, $value) {
             return $isString === false || is_string($value) || empty($value);
         }, true)) {
             throw new InvalidArgumentException(

src/LinkCollection.php

@@ -37,7 +37,7 @@ public function getLinks()
      */
     public function getLinksByRel($rel)
     {
-        return array_filter($this->links, function (LinkInterface $link) use ($rel) {
+        return array_filter($this->links, static function (LinkInterface $link) use ($rel) {
             $rels = $link->getRels();
             return in_array($rel, $rels, true);
         });
@@ -67,7 +67,7 @@ public function withoutLink(LinkInterface $link)
         }
 
         $new = clone $this;
-        $new->links = array_filter($this->links, function (LinkInterface $compare) use ($link) {
+        $new->links = array_filter($this->links, static function (LinkInterface $compare) use ($link) {
             return $link !== $compare;
         });
         return $new;

src/Metadata/AbstractMetadata.php

@@ -7,12 +7,8 @@
 
 namespace Zend\Expressive\Hal\Metadata;
 
-use Zend\Expressive\Hal\LinkCollection;
-
-abstract class AbstractMetadata
+abstract class AbstractMetadata implements MetadataInterface
 {
-    use LinkCollection;
-
     /**
      * @var string
      */
@@ -22,4 +18,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/MetadataMapFactory.php

@@ -91,7 +91,7 @@ private function populateMetadataMapFromConfig(
      * @throws Exception\InvalidConfigException if no matching `create*()`
      *     method is found for the "__class__" entry.
      */
-    private function injectMetadata(MetadataMap $metadataMap, array $metadata, array $metadataFactories)
+    private function injectMetadata(MetadataMap $metadataMap, array $metadata, array $metadataFactories): void
     {
         if (! isset($metadata['__class__'])) {
             throw Exception\InvalidConfigException::dueToMissingMetadataClass();

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/Renderer/XmlRenderer.php

@@ -78,7 +78,7 @@ private function createResourceNode(DOMDocument $doc, array $resource, string $r
         return $this->createNodeTree($doc, $node, $resource);
     }
 
-    private function createLinkNode(DOMDocument $doc, string $rel, array $data)
+    private function createLinkNode(DOMDocument $doc, string $rel, array $data): \DOMElement
     {
         $link = $doc->createElement('link');
         $link->setAttribute('rel', $rel);