Merge pull request #3 from Antevenio/custom_row_class

Rows to be returned as custom objects if desired.

Author: pinfake

composer.json

@@ -21,6 +21,9 @@
             "PdoMysqlSelectIterator\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": { "PdoMysqlSelectIterator\\Test\\": "test/" }
+    },
     "require": {
         "php": ">=5.6"
     },

src/Factory.php

@@ -7,6 +7,7 @@ class Factory {
      * @param $query
      * @param $blockSize
      * @return Iterator
+     * @throws Exception\InvalidQueryException
      */
     public function create(\PDO $adapter, $query, $blockSize)
     {

src/LimitIterator.php

@@ -45,6 +45,15 @@ class LimitIterator implements \Iterator, Iterator
      */
     protected $results;
 
+    protected $rowClass;
+
+    /**
+     * LimitIterator constructor.
+     * @param \PDO $pdo
+     * @param $query
+     * @param int $blockSize
+     * @throws InvalidQueryException
+     */
     public function __construct(\PDO $pdo, $query, $blockSize = self::BLOCK_SIZE)
     {
         $this->assertValidQuery($query);
@@ -55,8 +64,18 @@ public function __construct(\PDO $pdo, $query, $blockSize = self::BLOCK_SIZE)
         $this->blockSize = $blockSize;
         $this->results = null;
         $this->rowCount = null;
+        $this->rowClass = null;
     }
 
+    public function setRowClass($rowClass)
+    {
+        $this->rowClass = $rowClass;
+    }
+
+    /**
+     * @param $query
+     * @throws InvalidQueryException
+     */
     protected function assertValidQuery($query)
     {
         if (!$this->isAValidSelect($query)) {
@@ -128,7 +147,14 @@ public function key()
 
     public function current()
     {
-        return ($this->results[$this->currentBlockIndex]);
+        $rowdata = $this->results[$this->currentBlockIndex];
+        if ($this->rowClass) {
+            /** @var Row $row */
+            $row = new $this->rowClass();
+            $row->hydrate($rowdata);
+            return ($row);
+        }
+        return ($rowdata);
     }
 
     public function rewind()

src/Row.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace PdoMysqlSelectIterator;
+
+interface Row
+{
+    /**
+     * @param array $row
+     * @return mixed
+     */
+    public function hydrate(array $row);
+}

test/FactoryTest.php

@@ -1,7 +1,11 @@
 <?php
+namespace PdoMysqlSelectIterator\Test;
+
+use PDO;
 use PdoMysqlSelectIterator\LimitIterator;
-use PdoMysqlSelectIterator\NativePDOIterator;
+use PDOStatement;
 use PHPUnit\Framework\TestCase;
+use PHPUnit_Framework_MockObject_MockObject;
 
 class FactoryTest extends TestCase
 {

test/IteratorTest.php

@@ -1,5 +1,8 @@
 <?php
+namespace PdoMysqlSelectIterator\Test;
+
 use PdoMysqlSelectIterator\LimitIterator;
+use PDOStatement;
 use PHPUnit\Framework\TestCase;
 
 class IteratorTest extends TestCase
@@ -192,6 +195,24 @@ public function testCurrentShouldReturnCurrentRow()
         }
     }
 
+    public function testCurrentShouldReturnAnHydratedRowClassIfDefined()
+    {
+        $this->sut->setRowClass(TestRow::class);
+        $this->setPdoQueryExpectations(
+            [
+                [3, 0, self::DATA_BLOCKS[0]],
+                [3, 3, self::DATA_BLOCKS[1]]
+            ]
+        );
+        $this->sut->rewind();
+        for ($i = 0; $i < 3; $i++) {
+            $this->assertEquals(
+                ["a" => "a".($i+1), "b" => "b".($i+1)], $this->sut->current()->getRow()
+            );
+            $this->sut->next();
+        }
+    }
+
     public function testValidShouldReturnTrueWhenCurrentRowExists()
     {
         $this->setPdoQueryExpectations(

test/TestRow.php

@@ -0,0 +1,19 @@
+<?php
+namespace PdoMysqlSelectIterator\Test;
+
+use PdoMysqlSelectIterator\Row;
+
+class TestRow implements Row
+{
+    protected $row;
+
+    public function hydrate(array $row)
+    {
+        $this->row = $row;
+    }
+
+    public function getRow()
+    {
+        return $this->row;
+    }
+}