fix(Suggestion): correct type mapping for suggestion result

Closes #228

Author: Jens Schulze

src/Model/Product/LocalizedSuggestionCollection.php

@@ -0,0 +1,70 @@
+<?php
+/**
+ * @author @jayS-de <[email protected]>
+ */
+
+namespace Commercetools\Core\Model\Product;
+
+use Commercetools\Core\Error\InvalidArgumentException;
+use Commercetools\Core\Error\Message;
+use Commercetools\Core\Model\Common\Collection;
+use Commercetools\Core\Model\Common\Context;
+
+/**
+ * @package Commercetools\Core\Model\Product
+ * @link https://dev.commercetools.com/http-api-projects-products-search.html#representations
+ * @method SuggestionCollection current()
+ * @method LocalizedSuggestionCollection add(SuggestionCollection $element)
+ * @method SuggestionCollection getAt($offset)
+ */
+class LocalizedSuggestionCollection extends Collection
+{
+    protected $type = '\Commercetools\Core\Model\Product\SuggestionCollection';
+
+    /**
+     * @param $locale
+     * @return SuggestionCollection
+     */
+    public function __get($locale)
+    {
+        $context = new Context();
+        $context->setGraceful($this->getContext()->isGraceful())
+            ->setLanguages([$locale]);
+        return $this->get($context);
+    }
+
+    /**
+     * @param Context $context
+     * @return string
+     */
+    protected function getLanguage(Context $context)
+    {
+        $locale = null;
+        foreach ($context->getLanguages() as $language) {
+            if (isset($this[$language])) {
+                $locale = $language;
+                break;
+            }
+        }
+        return $locale;
+    }
+
+    /**
+     * @param Context $context
+     * @return SuggestionCollection
+     */
+    public function get(Context $context = null)
+    {
+        if (is_null($context)) {
+            $context = $this->getContext();
+        }
+        $locale = $this->getLanguage($context);
+        if (!isset($this[$locale])) {
+            if (!$context->isGraceful()) {
+                throw new InvalidArgumentException(Message::NO_VALUE_FOR_LOCALE);
+            }
+            return new SuggestionCollection();
+        }
+        return $this->getAt($locale);
+    }
+}

src/Model/Product/SuggestionResult.php

@@ -0,0 +1,53 @@
+<?php
+/**
+ * @author @jayS-de <[email protected]>
+ */
+
+namespace Commercetools\Core\Model\Product;
+
+use Commercetools\Core\Model\Common\JsonObject;
+
+/**
+ * @package Commercetools\Core\Model\Product
+ *
+ * @method LocalizedSuggestionCollection getSearchKeywords()
+ * @method SuggestionResult setSearchKeywords(LocalizedSuggestionCollection $searchKeywords = null)
+ */
+class SuggestionResult extends JsonObject
+{
+    public function fieldDefinitions()
+    {
+        return [
+            'searchKeywords' => [static::TYPE => '\Commercetools\Core\Model\Product\LocalizedSuggestionCollection']
+        ];
+    }
+
+    public static function fromArray(array $data, $context = null)
+    {
+        $result = [];
+        foreach ($data as $key => $value) {
+            $parts = explode('.', $key, 2);
+            if ($parts[0] == 'searchKeywords') {
+                $result['searchKeywords'][$parts[1]] = $value;
+            } else {
+                $result[$key] = $value;
+            }
+        }
+
+        return parent::fromArray($result, $context);
+    }
+
+    public function toArray()
+    {
+        $data = parent::toArray();
+        
+        if (isset($data['searchKeywords']) && is_array($data['searchKeywords'])) {
+            foreach ($data['searchKeywords'] as $locale => $keywords) {
+                $data['searchKeywords.' . $locale] = $keywords;
+            }
+            unset($data['searchKeywords']);
+        }
+
+        return $data;
+    }
+}

src/Request/Products/ProductsSuggestRequest.php

@@ -17,12 +17,13 @@
 use Commercetools\Core\Response\ResourceResponse;
 use Commercetools\Core\Model\Product\SuggestionCollection;
 use Commercetools\Core\Response\ApiResponseInterface;
+use Commercetools\Core\Model\Product\SuggestionResult;
 
 /**
  * @package Commercetools\Core\Request\Products
  * @link https://dev.commercetools.com/http-api-projects-products-suggestions.html#suggest-query
  * @method ResourceResponse executeWithClient(Client $client)
- * @method SuggestionCollection mapResponse(ApiResponseInterface $response)
+ * @method SuggestionResult mapResponse(ApiResponseInterface $response)
  */
 class ProductsSuggestRequest extends AbstractProjectionRequest
 {
@@ -33,7 +34,7 @@ class ProductsSuggestRequest extends AbstractProjectionRequest
      */
     protected $searchKeywords;
 
-    protected $resultClass = '\Commercetools\Core\Model\Product\SuggestionCollection';
+    protected $resultClass = '\Commercetools\Core\Model\Product\SuggestionResult';
 
     /**
      * @param LocalizedString $keywords

tests/unit/Request/Products/ProductsSuggestRequestTest.php

@@ -8,6 +8,7 @@
 use Commercetools\Core\Client\HttpMethod;
 use Commercetools\Core\Model\Common\LocalizedString;
 use Commercetools\Core\Model\Product\LocalizedSearchKeywords;
+use Commercetools\Core\Model\Product\SuggestionResult;
 use Commercetools\Core\RequestTestCase;
 
 class ProductsSuggestRequestTest extends RequestTestCase
@@ -21,20 +22,25 @@ protected function getKeywords()
 
     public function testMapResult()
     {
+        $data = ["searchKeywords.en" => [["text" => "Swiss Army Knife"]]];
+        /**
+         * @var SuggestionResult $result
+         */
         $result = $this->mapQueryResult(
             ProductsSuggestRequest::ofKeywords($this->getKeywords()),
             [],
-            ["searchKeywords.en" => ["text" => "Swiss Army Knife"]]
+            ["searchKeywords.en" => [["text" => "Swiss Army Knife"]]]
         );
-        $this->assertInstanceOf('\Commercetools\Core\Model\Product\SuggestionCollection', $result);
-        $this->assertInstanceOf('\Commercetools\Core\Model\Product\Suggestion', $result->current());
-        $this->assertSame(["text" => "Swiss Army Knife"], $result->current()->toArray());
+        $this->assertInstanceOf('\Commercetools\Core\Model\Product\SuggestionResult', $result);
+        $this->assertInstanceOf('\Commercetools\Core\Model\Product\LocalizedSuggestionCollection', $result->getSearchKeywords());
+        $this->assertSame(["text" => "Swiss Army Knife"], $result->getSearchKeywords()->en->current()->toArray());
+        $this->assertSame($data, $result->toArray());
     }
 
     public function testMapEmptyResult()
     {
         $result = $this->mapEmptyResult(ProductsSuggestRequest::ofKeywords($this->getKeywords()));
-        $this->assertInstanceOf('\Commercetools\Core\Model\Product\SuggestionCollection', $result);
+        $this->assertInstanceOf('\Commercetools\Core\Model\Product\SuggestionResult', $result);
         $this->assertEmpty($result->toArray());
     }