Reviewed and edited #13

Author: weierophinney

src/Hydrator/Iterator/HydratingArrayIterator.php

@@ -24,6 +24,11 @@ class HydratingArrayIterator extends HydratingIteratorIterator
      */
     protected $prototype;
 
+    /**
+     * @param HydratorInterface $hydrator
+     * @param array $data
+     * @param string|object $prototype Object, or class name to use for prototype.
+     */
     public function __construct(HydratorInterface $hydrator, array $data, $prototype)
     {
         parent::__construct($hydrator, new ArrayIterator($data), $prototype);

src/Hydrator/Iterator/HydratingIteratorInterface.php

@@ -15,15 +15,17 @@
 interface HydratingIteratorInterface extends Iterator
 {
     /**
-     * This sets the prototype of that will be hydrated.  This can be the name of the class or
-     * the object itself.  The iterator will clone the object
+     * This sets the prototype to hydrate.
+     *
+     * This prototype can be the name of the class or the object itself;
+     * iteration will clone the object.
      *
      * @param string|object $prototype
      */
     public function setPrototype($prototype);
 
     /**
-     * Sets the hydrator to use for the prototype
+     * Sets the hydrator to use during iteration.
      *
      * @param HydratorInterface $hydrator
      */

src/Hydrator/Iterator/HydratingIteratorIterator.php

@@ -26,13 +26,21 @@ class HydratingIteratorIterator extends IteratorIterator implements HydratingIte
      */
     protected $prototype;
 
+    /**
+     * @param HydratorInterface $hydrator
+     * @param Iterator $data
+     * @param string|object $prototype Object or class name to use for prototype.
+     */
     public function __construct(HydratorInterface $hydrator, Iterator $data, $prototype)
     {
         $this->setHydrator($hydrator);
         $this->setPrototype($prototype);
         parent::__construct($data);
     }
 
+    /**
+     * @inheritdoc
+     */
     public function setPrototype($prototype)
     {
         if (is_object($prototype)) {
@@ -49,11 +57,17 @@ public function setPrototype($prototype)
         $this->prototype = new $prototype;
     }
 
+    /**
+     * @inheritdoc
+     */
     public function setHydrator(HydratorInterface $hydrator)
     {
         $this->hydrator = $hydrator;
     }
 
+    /**
+     * @return object Returns hydrated clone of $prototype
+     */
     public function current()
     {
         $currentValue = parent::current();

test/Hydrator/Iterator/HydratingArrayIteratorTest.php

@@ -19,7 +19,7 @@ public function testHydratesObjectAndClonesOnCurrent()
     {
         $data = [
             ['foo' => 'bar'],
-            ['baz' => 'bat']
+            ['baz' => 'bat'],
         ];
 
         $object   = new ArrayObject();
@@ -41,7 +41,7 @@ public function testHydratesObjectAndClonesOnCurrent()
     public function testUsingStringForObjectName()
     {
         $data = [
-            ['foo' => 'bar']
+            ['foo' => 'bar'],
         ];
 
         $hydratingIterator = new HydratingArrayIterator(new ArraySerializable(), $data, '\ArrayObject');

test/Hydrator/Iterator/HydratingIteratorIteratorTest.php

@@ -20,7 +20,7 @@ public function testHydratesObjectAndClonesOnCurrent()
     {
         $data = [
             ['foo' => 'bar'],
-            ['baz' => 'bat']
+            ['baz' => 'bat'],
         ];
 
         $iterator = new ArrayIterator($data);
@@ -43,7 +43,7 @@ public function testHydratesObjectAndClonesOnCurrent()
     public function testUsingStringForObjectName()
     {
         $data = [
-            ['foo' => 'bar']
+            ['foo' => 'bar'],
         ];
 
         $iterator = new ArrayIterator($data);
@@ -57,6 +57,10 @@ public function testUsingStringForObjectName()
     public function testThrowingInvalidArguementExceptionWhenSettingPrototypeToInvalidClass()
     {
         $this->setExpectedException('Zend\Stdlib\Exception\InvalidArgumentException');
-        $hydratingIterator = new HydratingIteratorIterator(new ArraySerializable(), new ArrayIterator(), 'not a real class');
+        $hydratingIterator = new HydratingIteratorIterator(
+            new ArraySerializable(),
+            new ArrayIterator(),
+            'not a real class'
+        );
     }
 }