Merge pull request #24 from Icinga/support-for-custom-result-sets

Add support for custom result sets

src/Query.php

@@ -18,6 +18,7 @@
 use ipl\Stdlib\Filter;
 use ipl\Stdlib\Filters;
 use IteratorAggregate;
+use RuntimeException;
 use SplObjectStorage;
 
 /**
@@ -35,6 +36,9 @@ class Query implements Filterable, LimitOffsetInterface, OrderByInterface, Pagin
     /** @var Connection Database connection */
     protected $db;
 
+    /** @var string Class to return results as */
+    protected $resultSetClass = ResultSet::class;
+
     /** @var Model Model to query */
     protected $model;
 
@@ -80,6 +84,34 @@ public function setDb(Connection $db)
         return $this;
     }
 
+    /**
+     * Get the class to return results as
+     *
+     * @return string
+     */
+    public function getResultSetClass()
+    {
+        return $this->resultSetClass;
+    }
+
+    /**
+     * Set the class to return results as
+     *
+     * @param string $class
+     *
+     * @return $this
+     */
+    public function setResultSetClass($class)
+    {
+        if (! is_string($class)) {
+            throw new InvalidArgumentException('Argument $class must be a string');
+        }
+
+        $this->resultSetClass = $class;
+
+        return $this;
+    }
+
     /**
      * Get the model to query
      *
@@ -598,7 +630,16 @@ public function dump()
      */
     public function execute()
     {
-        return new ResultSet($this->yieldResults(), $this->getLimit());
+        $class = $this->getResultSetClass();
+
+        $result = new $class($this->yieldResults(), $this->getLimit());
+        if (! $result instanceof ResultSet) {
+            throw new RuntimeException(
+                $class . ' must be an instance of ' . ResultSet::class
+            );
+        }
+
+        return $result;
     }
 
     /**

tests/QueryTest.php

@@ -23,6 +23,12 @@ public function testGetModelReturnsCorrectModelIfSet()
         $this->assertSame($model, $query->getModel());
     }
 
+    public function testExecuteReturnsCustomResultSet()
+    {
+        $query = (new Query())->setResultSetClass(TestResultSet::class);
+        $this->assertInstanceOf(TestResultSet::class, $query->execute());
+    }
+
     public function testGetDbReturnsNullIfUnset()
     {
         $query = new Query();