ResultIterator: Class generation and Usage, update tests

Author: homersimpsons

src/Commands/AlteredConfiguration.php

@@ -56,6 +56,14 @@ public function getDaoNamespace(): string
         return $this->configuration->getDaoNamespace();
     }
 
+    /**
+     * @return string
+     */
+    public function getResultIteratorNamespace(): string
+    {
+        return $this->configuration->getResultIteratorNamespace();
+    }
+
     /**
      * @return Connection
      */

src/Configuration.php

@@ -33,6 +33,8 @@ class Configuration implements ConfigurationInterface
      * @var string
      */
     private $daoNamespace;
+    /** @var string */
+    private $resultIteratorNamespace;
     /**
      * @var Connection
      */
@@ -73,6 +75,7 @@ class Configuration implements ConfigurationInterface
     /**
      * @param string $beanNamespace The namespace hosting the beans
      * @param string $daoNamespace The namespace hosting the DAOs
+     * @param string $resultIteratorNamespace The namespace hosting the ResultIterators
      * @param Connection $connection The connection to the database
      * @param NamingStrategyInterface|null $namingStrategy
      * @param Cache|null $cache The Doctrine cache to store database metadata
@@ -83,10 +86,22 @@ class Configuration implements ConfigurationInterface
      * @param CodeGeneratorListenerInterface[] $codeGeneratorListeners A list of listeners that can alter code generation of each bean/dao
      * @throws \Mouf\Database\SchemaAnalyzer\SchemaAnalyzerException
      */
-    public function __construct(string $beanNamespace, string $daoNamespace, Connection $connection, NamingStrategyInterface $namingStrategy = null, Cache $cache = null, SchemaAnalyzer $schemaAnalyzer = null, LoggerInterface $logger = null, array $generatorListeners = [], AnnotationParser $annotationParser = null, array $codeGeneratorListeners = [])
-    {
+    public function __construct(
+        string $beanNamespace,
+        string $daoNamespace,
+        string $resultIteratorNamespace,
+        Connection $connection,
+        NamingStrategyInterface $namingStrategy = null,
+        Cache $cache = null,
+        SchemaAnalyzer $schemaAnalyzer = null,
+        LoggerInterface $logger = null,
+        array $generatorListeners = [],
+        AnnotationParser $annotationParser = null,
+        array $codeGeneratorListeners = []
+    ) {
         $this->beanNamespace = rtrim($beanNamespace, '\\');
         $this->daoNamespace = rtrim($daoNamespace, '\\');
+        $this->resultIteratorNamespace = rtrim($resultIteratorNamespace, '\\');
         $this->connection = $connection;
         if ($cache !== null) {
             $this->cache = $cache;
@@ -122,6 +137,14 @@ public function getDaoNamespace(): string
         return $this->daoNamespace;
     }
 
+    /**
+     * @return string
+     */
+    public function getResultIteratorNamespace(): string
+    {
+        return $this->resultIteratorNamespace;
+    }
+
     /**
      * @return Connection
      */

src/ConfigurationInterface.php

@@ -26,6 +26,11 @@ public function getBeanNamespace(): string;
      */
     public function getDaoNamespace(): string;
 
+    /**
+     * @return string
+     */
+    public function getResultIteratorNamespace(): string;
+
     /**
      * @return Connection
      */

src/ResultIterator.php

@@ -84,7 +84,7 @@ private function __construct()
      */
     public static function createResultIterator(QueryFactory $queryFactory, array $parameters, ObjectStorageInterface $objectStorage, ?string $className, TDBMService $tdbmService, MagicQuery $magicQuery, int $mode, LoggerInterface $logger): self
     {
-        $iterator =  new self();
+        $iterator =  new static();
         if ($mode !== TDBMService::MODE_CURSOR && $mode !== TDBMService::MODE_ARRAY) {
             throw new TDBMException("Unknown fetch mode: '".$mode."'");
         }

src/TDBMService.php

@@ -1119,13 +1119,17 @@ private function exploreChildrenTablesRelationships(SchemaAnalyzer $schemaAnalyz
      * @param string[]                     $additionalTablesFetch
      * @param int|null                     $mode
      * @param string                       $className             Optional: The name of the class to instantiate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned
+     * @param string                       $resultIteratorClass   The name of the resultIterator class to return
      *
      * @return ResultIterator An object representing an array of results
      *
      * @throws TDBMException
      */
-    public function findObjects(string $mainTable, $filter = null, array $parameters = array(), $orderString = null, array $additionalTablesFetch = array(), ?int $mode = null, string $className = null) : ResultIterator
+    public function findObjects(string $mainTable, $filter = null, array $parameters = array(), $orderString = null, array $additionalTablesFetch = array(), ?int $mode = null, string $className = null, string $resultIteratorClass = ResultIterator::class): ResultIterator
     {
+        if (!is_a($resultIteratorClass, ResultIterator::class, true)) {
+            throw new TDBMInvalidArgumentException('$resultIteratorClass should be a `'. ResultIterator::class. '`. `' . $resultIteratorClass . '` provided.');
+        }
         // $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
         if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
             throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
@@ -1141,7 +1145,7 @@ public function findObjects(string $mainTable, $filter = null, array $parameters
 
         $queryFactory = new FindObjectsQueryFactory($mainTable, $additionalTablesFetch, $filterString, $orderString, $this, $this->tdbmSchemaAnalyzer->getSchema(), $this->orderByAnalyzer, $this->cache);
 
-        return ResultIterator::createResultIterator($queryFactory, $parameters, $this->objectStorage, $className, $this, $this->magicQuery, $mode, $this->logger);
+        return $resultIteratorClass::createResultIterator($queryFactory, $parameters, $this->objectStorage, $className, $this, $this->magicQuery, $mode, $this->logger);
     }
 
     /**
@@ -1152,13 +1156,17 @@ public function findObjects(string $mainTable, $filter = null, array $parameters
      * @param string|UncheckedOrderBy|null $orderString The ORDER BY part of the query. All columns must be prefixed by the table name (in the form: table.column)
      * @param int                          $mode
      * @param string                       $className   Optional: The name of the class to instantiate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned
+     * @param string                       $resultIteratorClass   The name of the resultIterator class to return
      *
      * @return ResultIterator An object representing an array of results
      *
      * @throws TDBMException
      */
-    public function findObjectsFromSql(string $mainTable, string $from, $filter = null, array $parameters = array(), $orderString = null, ?int $mode = null, string $className = null): ResultIterator
+    public function findObjectsFromSql(string $mainTable, string $from, $filter = null, array $parameters = array(), $orderString = null, ?int $mode = null, string $className = null, string $resultIteratorClass = ResultIterator::class): ResultIterator
     {
+        if (!is_a($resultIteratorClass, ResultIterator::class, true)) {
+            throw new TDBMInvalidArgumentException('$resultIteratorClass should be a `'. ResultIterator::class. '`. `' . $resultIteratorClass . '` provided.');
+        }
         // $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
         if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
             throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
@@ -1174,7 +1182,7 @@ public function findObjectsFromSql(string $mainTable, string $from, $filter = nu
 
         $queryFactory = new FindObjectsFromSqlQueryFactory($mainTable, $from, $filterString, $orderString, $this, $this->tdbmSchemaAnalyzer->getSchema(), $this->orderByAnalyzer, $this->schemaAnalyzer, $this->cache, $this->cachePrefix);
 
-        return ResultIterator::createResultIterator($queryFactory, $parameters, $this->objectStorage, $className, $this, $this->magicQuery, $mode, $this->logger);
+        return $resultIteratorClass::createResultIterator($queryFactory, $parameters, $this->objectStorage, $className, $this, $this->magicQuery, $mode, $this->logger);
     }
 
     /**
@@ -1322,13 +1330,17 @@ public function findObjectFromSql(string $mainTable, string $from, $filter = nul
      * @param int|null $mode
      * @param string|null $className
      * @param string $sqlCount
+     * @param string $resultIteratorClass The name of the resultIterator class to return
      *
      * @return ResultIterator
      *
      * @throws TDBMException
      */
-    public function findObjectsFromRawSql(string $mainTable, string $sql, array $parameters = array(), ?int $mode = null, string $className = null, string $sqlCount = null): ResultIterator
+    public function findObjectsFromRawSql(string $mainTable, string $sql, array $parameters = array(), ?int $mode = null, string $className = null, string $sqlCount = null, string $resultIteratorClass = ResultIterator::class): ResultIterator
     {
+        if (!is_a($resultIteratorClass, ResultIterator::class, true)) {
+            throw new TDBMInvalidArgumentException('$resultIteratorClass should be a `'. ResultIterator::class. '`. `' . $resultIteratorClass . '` provided.');
+        }
         // $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
         if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
             throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
@@ -1338,7 +1350,7 @@ public function findObjectsFromRawSql(string $mainTable, string $sql, array $par
 
         $queryFactory = new FindObjectsFromRawSqlQueryFactory($this, $this->tdbmSchemaAnalyzer->getSchema(), $mainTable, $sql, $sqlCount);
 
-        return ResultIterator::createResultIterator($queryFactory, $parameters, $this->objectStorage, $className, $this, $this->magicQuery, $mode, $this->logger);
+        return $resultIteratorClass::createResultIterator($queryFactory, $parameters, $this->objectStorage, $className, $this, $this->magicQuery, $mode, $this->logger);
     }
 
     /**