make collection iteratable

chubbyphp-legacy · Dec 1, 2016 · 2778258 · 2778258
1 parent e32de9b
commit 2778258
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 1 deletion.
diff --git a/src/Collection/LazyModelCollection.php b/src/Collection/LazyModelCollection.php
@@ -112,6 +112,16 @@ public function getInitialModels(): array
         return $this->initialModels;
     }
 
+    /**
+     * @return \ArrayIterator
+     */
+    public function getIterator()
+    {
+        $this->resolveModels();
+
+        return new \ArrayIterator($this->models);
+    }
+
     /**
      * @return array
      */

diff --git a/src/Collection/ModelCollection.php b/src/Collection/ModelCollection.php
@@ -84,6 +84,14 @@ public function getInitialModels(): array
         return $this->initialModels;
     }
 
+    /**
+     * @return \ArrayIterator
+     */
+    public function getIterator()
+    {
+        return new \ArrayIterator($this->models);
+    }
+
     /**
      * @return array
      */

diff --git a/src/Collection/ModelCollectionInterface.php b/src/Collection/ModelCollectionInterface.php
@@ -6,7 +6,7 @@
 
 use Chubbyphp\Model\ModelInterface;
 
-interface ModelCollectionInterface extends \JsonSerializable
+interface ModelCollectionInterface extends \IteratorAggregate, \JsonSerializable
 {
     /**
      * @param ModelInterface $model

diff --git a/tests/Collection/LazyModelCollectionTest.php b/tests/Collection/LazyModelCollectionTest.php
@@ -4,6 +4,7 @@
 
 use Chubbyphp\Model\Collection\LazyModelCollection;
 use Chubbyphp\Tests\Model\Resources\User;
+use Ramsey\Uuid\Uuid;
 
 /**
  * @covers Chubbyphp\Model\Collection\LazyModelCollection
@@ -63,6 +64,29 @@ public function testSetModels()
         self::assertCount(1, $modelCollection->getModels());
     }
 
+    public function testIteratable()
+    {
+        $id = (string) Uuid::uuid4();
+
+        $user = new User($id);
+        $user->setUsername('username1');
+        $user->setPassword('password');
+        $user->setActive(true);
+
+        $modelCollection = new LazyModelCollection(function () use ($user) {
+            return [$user];
+        });
+
+        foreach ($modelCollection as $key => $model) {
+            self::assertSame($id, $key);
+            self::assertSame($user, $model);
+
+            return;
+        }
+
+        self::fail('collection is not iteratable');
+    }
+
     public function testJsonSerialize()
     {
         $user = new User();

diff --git a/tests/Collection/ModelCollectionTest.php b/tests/Collection/ModelCollectionTest.php
@@ -4,6 +4,7 @@
 
 use Chubbyphp\Model\Collection\ModelCollection;
 use Chubbyphp\Tests\Model\Resources\User;
+use Ramsey\Uuid\Uuid;
 
 /**
  * @covers Chubbyphp\Model\Collection\ModelCollection
@@ -57,6 +58,27 @@ public function testSetModels()
         self::assertCount(1, $modelCollection->getModels());
     }
 
+    public function testIteratable()
+    {
+        $id = (string) Uuid::uuid4();
+
+        $user = new User($id);
+        $user->setUsername('username1');
+        $user->setPassword('password');
+        $user->setActive(true);
+
+        $modelCollection = new ModelCollection([$user]);
+
+        foreach ($modelCollection as $key => $model) {
+            self::assertSame($id, $key);
+            self::assertSame($user, $model);
+
+            return;
+        }
+
+        self::fail('collection is not iteratable');
+    }
+
     public function testJsonSerialize()
     {
         $user = new User();