Adding the ability to filter by ResultIterator at the top level of a filter

Author: moufmouf

src/QueryFactory/AbstractQueryFactory.php

@@ -47,19 +47,25 @@ abstract class AbstractQueryFactory implements QueryFactory
      */
     protected $magicSqlSubQuery;
     protected $columnDescList;
+    protected $subQueryColumnDescList;
+    /**
+     * @var string
+     */
+    protected $mainTable;
 
     /**
      * @param TDBMService $tdbmService
      * @param Schema $schema
      * @param OrderByAnalyzer $orderByAnalyzer
      * @param string|UncheckedOrderBy|null $orderBy
      */
-    public function __construct(TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, $orderBy)
+    public function __construct(TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, string $mainTable, $orderBy)
     {
         $this->tdbmService = $tdbmService;
         $this->schema = $schema;
         $this->orderByAnalyzer = $orderByAnalyzer;
         $this->orderBy = $orderBy;
+        $this->mainTable = $mainTable;
     }
 
     /**
@@ -242,6 +248,27 @@ public function getColumnDescriptors() : array
         return $this->columnDescList;
     }
 
+    /**
+     * @return string[][] An array of column descriptors. Value is an array with those keys: table, column
+     */
+    public function getSubQueryColumnDescriptors() : array
+    {
+        if ($this->subQueryColumnDescList === null) {
+            $columns = $this->tdbmService->getPrimaryKeyColumns($this->mainTable);
+            $descriptors = [];
+            foreach ($columns as $column) {
+                $descriptors[] = [
+                    'table' => $this->mainTable,
+                    'column' => $column
+                ];
+            }
+            $this->subQueryColumnDescList = $descriptors;
+        }
+
+        return $this->subQueryColumnDescList;
+    }
+
+
     /**
      * Sets the ORDER BY directive executed in SQL.
      *

src/QueryFactory/FindObjectsFromRawSqlQueryFactory.php

@@ -406,4 +406,12 @@ public function getMagicSqlSubQuery(): string
     {
         throw new TDBMException('Using resultset generated from findFromRawSql as subqueries is unsupported for now.');
     }
+
+    /**
+     * @return string[][] An array of column descriptors. Value is an array with those keys: table, column
+     */
+    public function getSubQueryColumnDescriptors(): array
+    {
+        throw new TDBMException('Using resultset generated from findFromRawSql as subqueries is unsupported for now.');
+    }
 }

src/QueryFactory/FindObjectsFromSqlQueryFactory.php

@@ -18,7 +18,6 @@
  */
 class FindObjectsFromSqlQueryFactory extends AbstractQueryFactory
 {
-    private $mainTable;
     private $from;
     private $filterString;
     private $cache;
@@ -27,8 +26,7 @@ class FindObjectsFromSqlQueryFactory extends AbstractQueryFactory
 
     public function __construct(string $mainTable, string $from, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, SchemaAnalyzer $schemaAnalyzer, Cache $cache, string $cachePrefix)
     {
-        parent::__construct($tdbmService, $schema, $orderByAnalyzer, $orderBy);
-        $this->mainTable = $mainTable;
+        parent::__construct($tdbmService, $schema, $orderByAnalyzer, $mainTable, $orderBy);
         $this->from = $from;
         $this->filterString = $filterString;
         $this->schemaAnalyzer = $schemaAnalyzer;

src/QueryFactory/FindObjectsQueryFactory.php

@@ -15,7 +15,6 @@
  */
 class FindObjectsQueryFactory extends AbstractQueryFactory
 {
-    private $mainTable;
     private $additionalTablesFetch;
     private $filterString;
     /**
@@ -25,8 +24,7 @@ class FindObjectsQueryFactory extends AbstractQueryFactory
 
     public function __construct(string $mainTable, array $additionalTablesFetch, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, Cache $cache)
     {
-        parent::__construct($tdbmService, $schema, $orderByAnalyzer, $orderBy);
-        $this->mainTable = $mainTable;
+        parent::__construct($tdbmService, $schema, $orderByAnalyzer, $mainTable, $orderBy);
         $this->additionalTablesFetch = $additionalTablesFetch;
         $this->filterString = $filterString;
         $this->cache = $cache;

src/QueryFactory/QueryFactory.php

@@ -42,4 +42,9 @@ public function getMagicSqlSubQuery() : string;
      * @return mixed[][] An array of column descriptors. The key is in the form "$tableName____$columnName". Value is an array with those keys: as, table, column, type, tableGroup
      */
     public function getColumnDescriptors() : array;
+
+    /**
+     * @return string[][] An array of column descriptors. Value is an array with those keys: table, column
+     */
+    public function getSubQueryColumnDescriptors() : array;
 }

src/ResultIterator.php

@@ -7,6 +7,7 @@
 use function array_map;
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Statement;
+use function array_pop;
 use function is_array;
 use function is_int;
 use Mouf\Database\MagicQuery;
@@ -354,4 +355,24 @@ public function withParameters(array $parameters) : ResultIterator
 
         return $clone;
     }
+
+    /**
+     * @internal
+     * @return string
+     */
+    public function _getSubQuery(): string
+    {
+        $sql = $this->magicQuery->build($this->queryFactory->getMagicSqlSubQuery(), $this->parameters);
+        $primaryKeyColumnDescs = $this->queryFactory->getSubQueryColumnDescriptors();
+
+        if (count($primaryKeyColumnDescs) > 1) {
+            throw new TDBMException('You cannot use in a sub-query a table that has a primary key on more that 1 column.');
+        }
+
+        $pkDesc = array_pop($primaryKeyColumnDescs);
+
+        $sql = $this->tdbmService->getConnection()->quoteIdentifier($pkDesc['table']).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkDesc['column']).' IN ('.$sql.')';
+
+        return $sql;
+    }
 }

src/TDBMService.php

@@ -414,6 +414,9 @@ public function buildFilterFromFilterBag($filter_bag, AbstractPlatform $platform
             }
 
             return ['(' . implode(') AND (', $sqlParts) . ')', $parameters, $counter];
+        } elseif ($filter_bag instanceof ResultIterator) {
+            $subQuery = $filter_bag->_getSubQuery();
+            return [$subQuery, [], $counter];
         } elseif ($filter_bag instanceof AbstractTDBMObject) {
             $sqlParts = [];
             $parameters = [];
@@ -433,6 +436,7 @@ public function buildFilterFromFilterBag($filter_bag, AbstractPlatform $platform
 
             return [implode(' AND ', $sqlParts), $parameters, $counter];
         } elseif ($filter_bag instanceof \Iterator) {
+            // TODO: we could instead check if is_iterable($filter_bag). That would remove useless code here.
             return $this->buildFilterFromFilterBag(iterator_to_array($filter_bag), $platform, $counter);
         } else {
             throw new TDBMException('Error in filter. An object has been passed that is neither a SQL string, nor an array, nor a bean, nor null.');

tests/Dao/TestArticleDao.php

@@ -3,6 +3,7 @@
 
 namespace TheCodingMachine\TDBM\Dao;
 
+use TheCodingMachine\TDBM\ResultIterator;
 use TheCodingMachine\TDBM\Test\Dao\Bean\ArticleBean;
 use TheCodingMachine\TDBM\Test\Dao\Generated\ArticleBaseDao;
 
@@ -14,9 +15,9 @@ class TestArticleDao extends ArticleBaseDao
     /**
      * Used to test a findFromSql with an order by clause on an inherited table.
      *
-     * @return ArticleBean[]
+     * @return ResultIterator&ArticleBean[]
      */
-    public function getArticlesByUserLogin()
+    public function getArticlesByUserLogin(): ResultIterator
     {
         return $this->findFromSql(
             'article JOIN users ON article.author_id = users.id',

tests/Dao/TestArticleSubQueryDao.php

@@ -0,0 +1,45 @@
+<?php
+declare(strict_types=1);
+
+namespace TheCodingMachine\TDBM\Dao;
+
+use TheCodingMachine\TDBM\ResultIterator;
+use TheCodingMachine\TDBM\TDBMService;
+use TheCodingMachine\TDBM\Test\Dao\Bean\ArticleBean;
+use TheCodingMachine\TDBM\Test\Dao\Generated\ArticleBaseDao;
+
+/**
+ * The UserDao class will maintain the persistence of UserBean class into the users table.
+ */
+class TestArticleSubQueryDao extends ArticleBaseDao
+{
+    /**
+     * @var TestUserDao
+     */
+    private $userDao;
+
+    public function __construct(TDBMService $tdbmService, TestUserDao $userDao)
+    {
+        parent::__construct($tdbmService);
+        $this->userDao = $userDao;
+    }
+
+    /**
+     * Used to test a findFromSql with an order by clause on an inherited table.
+     *
+     * @return ResultIterator&ArticleBean[]
+     */
+    public function getArticlesByUserLoginStartingWith(string $login): ResultIterator
+    {
+        /*return $this->find(
+            'author_id IN (:authorIds)',
+            [ 'authorIds' => $this->userDao->getUsersByLoginStartingWith($login) ],
+            'users.login'
+        );*/
+        return $this->find(
+            $this->userDao->getUsersByLoginStartingWith($login),
+            [],
+            'users.login'
+        );
+    }
+}

tests/TDBMDaoGeneratorTest.php

@@ -31,6 +31,7 @@
 use ReflectionClass;
 use ReflectionMethod;
 use TheCodingMachine\TDBM\Dao\TestArticleDao;
+use TheCodingMachine\TDBM\Dao\TestArticleSubQueryDao;
 use TheCodingMachine\TDBM\Dao\TestCountryDao;
 use TheCodingMachine\TDBM\Dao\TestRoleDao;
 use TheCodingMachine\TDBM\Dao\TestUserDao;
@@ -2184,4 +2185,23 @@ public function testSQLCountWithArray(): void
         $users = $userDao->getUsersByComplexFilterBag($country, ['John Doe', 'John Smith'])->take(0, 1);
         $this->assertEquals(1, $users->count());
     }
+
+    /**
+     * @depends testDaoGeneration
+     */
+    public function testSubQueryWithFind()
+    {
+        $userDao = new TestUserDao($this->tdbmService);
+        $articleDao = new TestArticleSubQueryDao($this->tdbmService, $userDao);
+
+        $bill = $userDao->getById(4);
+        $article = new ArticleBean('Foo');
+        $article->setAuthor($bill);
+        $articleDao->save($article);
+
+        $results = $articleDao->getArticlesByUserLoginStartingWith('bill');
+
+        $this->assertCount(1, $results);
+        $this->assertSame('Foo', $results[0]->getContent());
+    }
 }