Merge pull request #23 from contentful/hotfix/link-resolver-interface

Change second parameter of resolveLinkCollection

Author: dborsatto

CHANGELOG.md

@@ -5,6 +5,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased](https://github.com/contentful/contentful-core.php/compare/2.1.0...HEAD)
 
+### Fixed
+
+* Method `LinkResolverInterface::resolveLinkCollection()`'s second parameter was fixed, changing from `string $locale = null` to `array $parameters = []`.
+
 ## [2.1.0](https://github.com/contentful/contentful-core.php/tree/2.1.0) (2018-11-07)
 
 ### Added

src/Api/LinkResolverInterface.php

@@ -29,10 +29,10 @@ public function resolveLink(Link $link, array $parameters = []): ResourceInterfa
      * to reduce the amount of necessary API calls, or simply forward this
      * to the "resolveLink" method.
      *
-     * @param Link[]      $links
-     * @param string|null $locale
+     * @param Link[]   $links
+     * @param string[] $parameters
      *
      * @return ResourceInterface[]
      */
-    public function resolveLinkCollection(array $links, string $locale = \null): array;
+    public function resolveLinkCollection(array $links, array $parameters = []): array;
 }

tests/Implementation/Entry.php

@@ -0,0 +1,92 @@
+<?php
+
+/**
+ * This file is part of the contentful/contentful-core package.
+ *
+ * @copyright 2015-2018 Contentful GmbH
+ * @license   MIT
+ */
+
+declare(strict_types=1);
+
+namespace Contentful\Tests\Core\Implementation;
+
+use Contentful\Core\Api\Link;
+use Contentful\Core\Resource\EntryInterface;
+
+class Entry implements EntryInterface
+{
+    /**
+     * @var string
+     */
+    private $id;
+
+    /**
+     * @var string
+     */
+    private $type;
+
+    /**
+     * @var array
+     */
+    private $parameters;
+
+    public function __construct(string $id, string $type, array $parameters = [])
+    {
+        $this->id = $id;
+        $this->type = $type;
+        $this->parameters = $parameters;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getId(): string
+    {
+        return $this->id;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getSystemProperties()
+    {
+        throw new \Exception('Not supported');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function jsonSerialize()
+    {
+        return [
+            'id' => $this->id,
+            'type' => $this->type,
+            'parameters' => $this->parameters,
+        ];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function asLink(): Link
+    {
+        return new Link($this->id, $this->type);
+    }
+
+    /**
+     * @return array
+     */
+    public function getParameters(): array
+    {
+        return $this->parameters;
+    }
+}

tests/Implementation/LinkResolver.php

@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * This file is part of the contentful/contentful-core package.
+ *
+ * @copyright 2015-2018 Contentful GmbH
+ * @license   MIT
+ */
+
+declare(strict_types=1);
+
+namespace Contentful\Tests\Core\Implementation;
+
+use Contentful\Core\Api\Link;
+use Contentful\Core\Api\LinkResolverInterface;
+use Contentful\Core\Resource\ResourceInterface;
+
+class LinkResolver implements LinkResolverInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function resolveLink(Link $link, array $parameters = []): ResourceInterface
+    {
+        return new Entry($link->getId(), $link->getLinkType(), $parameters);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function resolveLinkCollection(array $links, array $parameters = []): array
+    {
+        return \array_map(function (Link $link) use ($parameters): ResourceInterface {
+            return $this->resolveLink($link, $parameters);
+        }, $links);
+    }
+}

tests/Unit/Api/LinkResolverInterfaceTest.php

@@ -0,0 +1,50 @@
+<?php
+
+/**
+ * This file is part of the contentful/contentful-core package.
+ *
+ * @copyright 2015-2018 Contentful GmbH
+ * @license   MIT
+ */
+
+declare(strict_types=1);
+
+namespace Contentful\Tests\Core\Unit\Api;
+
+use Contentful\Core\Api\Link;
+use Contentful\Tests\Core\Implementation\Entry;
+use Contentful\Tests\Core\Implementation\LinkResolver;
+use Contentful\Tests\TestCase;
+
+class LinkResolverInterfaceTest extends TestCase
+{
+    public function testLinkResolver()
+    {
+        $linkResolver = new LinkResolver();
+
+        /** @var Entry $entry */
+        $entry = $linkResolver->resolveLink(
+            new Link('someEntryId', 'Entry'),
+            ['someParameter' => 'someValue']
+        );
+
+        $this->assertSame('someEntryId', $entry->getId());
+        $this->assertSame('Entry', $entry->getType());
+        $this->assertSame(['someParameter' => 'someValue'], $entry->getParameters());
+
+        /** @var Entry[] $entries */
+        $entries = $linkResolver->resolveLinkCollection(
+            [new Link('someEntryId', 'Entry')],
+            ['someParameter' => 'someValue']
+        );
+
+        $this->assertContainsOnlyInstancesOf(Entry::class, $entries);
+        $this->assertCount(1, $entries);
+
+        $entry = $entries[0];
+
+        $this->assertSame('someEntryId', $entry->getId());
+        $this->assertSame('Entry', $entry->getType());
+        $this->assertSame(['someParameter' => 'someValue'], $entry->getParameters());
+    }
+}