fix(Collection): fix iterator for unset elements of collections (#307)

Author: Jens Schulze

src/Model/Common/Collection.php

@@ -14,6 +14,9 @@ class Collection extends AbstractJsonDeserializeObject implements \Iterator, \Js
 {
     const ID = 'id';
     use ContextTrait;
+    const COLLECTION_TYPE = Collection::TYPE_LIST;
+    const TYPE_LIST = 'List';
+    const TYPE_MAP = 'Map';
 
     /**
      * @var string
@@ -367,5 +370,20 @@ public function offsetUnset($offset)
     {
         unset($this->rawData[$offset]);
         unset($this->typeData[$offset]);
+        $rawKeys = array_keys($this->rawData);
+        $typeKeys = array_keys($this->typeData);
+        $keys = array_merge($rawKeys, $typeKeys);
+        $this->keys = array_unique($keys);
+    }
+
+    protected function toJson()
+    {
+        $data = parent::toJson();
+
+        if (static::COLLECTION_TYPE == self::TYPE_LIST) {
+            return array_values($data);
+        }
+
+        return $data;
     }
 }

src/Model/Product/FacetResultCollection.php

@@ -16,6 +16,7 @@
 class FacetResultCollection extends Collection
 {
     const OFFSET = 'offset';
+    const COLLECTION_TYPE = Collection::TYPE_MAP;
 
     protected $type = FacetResult::class;
 

src/Model/Product/LocalizedSearchKeywords.php

@@ -18,6 +18,8 @@
  */
 class LocalizedSearchKeywords extends Collection
 {
+    const COLLECTION_TYPE = Collection::TYPE_MAP;
+
     protected $type = SearchKeywords::class;
 
     /**

src/Model/Product/LocalizedSuggestionCollection.php

@@ -19,6 +19,7 @@
  */
 class LocalizedSuggestionCollection extends Collection
 {
+    const COLLECTION_TYPE = Collection::TYPE_MAP;
     protected $type = SuggestionCollection::class;
 
     /**

tests/unit/Model/Common/CollectionTest.php

@@ -235,4 +235,17 @@ public function testAdd()
 
         $this->assertCount(2, $collection);
     }
+
+    public function testUnsetIterator()
+    {
+        $collection = Collection::fromArray([1]);
+        $collection[] = 2;
+        unset($collection[0]);
+
+        $this->assertCount(1, $collection);
+        $collection->rewind();
+        $this->assertSame(1, $collection->key());
+        $this->assertSame(2, $collection->current());
+        $this->assertJsonStringEqualsJsonString('[2]', json_encode($collection));
+    }
 }

tests/unit/Model/Product/LocalizedSearchKeywordsTest.php

@@ -95,4 +95,25 @@ public function testFromArray()
         $this->assertSame('Hello World', $keywords->en->getAt(0)->getText());
         $this->assertSame('custom', $keywords->de->getAt(1)->getSuggestTokenizer()->getType());
     }
+
+    public function testUnsetIterator()
+    {
+        $keywords = LocalizedSearchKeywords::fromArray(
+            [
+                'de' => [
+                    ['text'=>'Hallo Welt'],
+                ],
+                'en' => [
+                    ['text' => 'Hello World'],
+                ],
+            ],
+            Context::of()->setLanguages(['de', 'en'])
+        );
+        unset($keywords['de']);
+
+        $this->assertCount(1, $keywords);
+        $keywords->rewind();
+        $this->assertSame('en', $keywords->key());
+        $this->assertJsonStringEqualsJsonString('{"en": [{"text": "Hello World"}]}', json_encode($keywords));
+    }
 }