Adding a getMagicSqlSubQuery to the QueryFactory.

Author: moufmouf

src/QueryFactory/AbstractQueryFactory.php

@@ -34,8 +34,18 @@ abstract class AbstractQueryFactory implements QueryFactory
      */
     protected $orderBy;
 
+    /**
+     * @var string|null
+     */
     protected $magicSql;
+    /**
+     * @var string|null
+     */
     protected $magicSqlCount;
+    /**
+     * @var string|null
+     */
+    protected $magicSqlSubQuery;
     protected $columnDescList;
 
     /**
@@ -214,6 +224,15 @@ public function getMagicSqlCount() : string
         return $this->magicSqlCount;
     }
 
+    public function getMagicSqlSubQuery() : string
+    {
+        if ($this->magicSqlSubQuery === null) {
+            $this->compute();
+        }
+
+        return $this->magicSqlSubQuery;
+    }
+
     public function getColumnDescriptors() : array
     {
         if ($this->columnDescList === null) {

src/QueryFactory/FindObjectsFromRawSqlQueryFactory.php

@@ -395,4 +395,15 @@ protected function getTableGroupName(array $relatedTables): string
         sort($relatedTables);
         return implode('_``_', $relatedTables);
     }
+
+    /**
+     * Returns a sub-query to be used in another query.
+     * A sub-query is similar to a query except it returns only the primary keys of the table (to be used as filters)
+     *
+     * @return string
+     */
+    public function getMagicSqlSubQuery(): string
+    {
+        throw new TDBMException('Using resultset generated from findFromRawSql as subqueries is unsupported for now.');
+    }
 }

src/QueryFactory/FindObjectsFromSqlQueryFactory.php

@@ -11,6 +11,7 @@
 use TheCodingMachine\TDBM\OrderByAnalyzer;
 use TheCodingMachine\TDBM\TDBMException;
 use TheCodingMachine\TDBM\TDBMService;
+use function implode;
 
 /**
  * This class is in charge of creating the MagicQuery SQL based on parameters passed to findObjectsFromSql method.
@@ -55,6 +56,7 @@ protected function compute(): void
         }, $pkColumnNames);
 
         $countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM '.$this->from;
+        $subQuery = 'SELECT DISTINCT '.implode(', ', $pkColumnNames).' FROM '.$this->from;
 
         // Add joins on inherited tables if necessary
         if (count($allFetchedTables) > 1) {
@@ -89,6 +91,7 @@ protected function compute(): void
         if (!empty($this->filterString)) {
             $sql .= ' WHERE '.$this->filterString;
             $countSql .= ' WHERE '.$this->filterString;
+            $subQuery .= ' WHERE '.$this->filterString;
         }
 
         if (!empty($orderString)) {
@@ -101,6 +104,7 @@ protected function compute(): void
 
         $this->magicSql = $sql;
         $this->magicSqlCount = $countSql;
+        $this->magicSqlSubQuery = $subQuery;
         $this->columnDescList = $columnDescList;
     }
 

src/QueryFactory/FindObjectsQueryFactory.php

@@ -8,6 +8,7 @@
 use Doctrine\DBAL\Schema\Schema;
 use TheCodingMachine\TDBM\OrderByAnalyzer;
 use TheCodingMachine\TDBM\TDBMService;
+use function implode;
 
 /**
  * This class is in charge of creating the MagicQuery SQL based on parameters passed to findObjects method.
@@ -52,15 +53,18 @@ protected function compute(): void
             return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn);
         }, $pkColumnNames);
 
+        $subQuery = 'SELECT DISTINCT '.implode(', ', $pkColumnNames).' FROM MAGICJOIN('.$this->mainTable.')';
+
         if (count($pkColumnNames) === 1 || $this->tdbmService->getConnection()->getDatabasePlatform() instanceof MySqlPlatform) {
             $countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM MAGICJOIN('.$this->mainTable.')';
         } else {
-            $countSql = 'SELECT COUNT(*) FROM (SELECT DISTINCT '.implode(', ', $pkColumnNames).' FROM MAGICJOIN('.$this->mainTable.')) tmp';
+            $countSql = 'SELECT COUNT(*) FROM ('.$subQuery.') tmp';
         }
 
         if (!empty($this->filterString)) {
             $sql .= ' WHERE '.$this->filterString;
             $countSql .= ' WHERE '.$this->filterString;
+            $subQuery .= ' WHERE '.$this->filterString;
         }
 
         if (!empty($orderString)) {
@@ -69,6 +73,7 @@ protected function compute(): void
 
         $this->magicSql = $sql;
         $this->magicSqlCount = $countSql;
+        $this->magicSqlSubQuery = $subQuery;
         $this->columnDescList = $columnDescList;
 
         $this->cache->save($key, [

src/QueryFactory/QueryFactory.php

@@ -31,7 +31,15 @@ public function getMagicSql() : string;
     public function getMagicSqlCount() : 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, colum, type, tableGroup
+     * Returns a sub-query to be used in another query.
+     * A sub-query is similar to a query except it returns only the primary keys of the table (to be used as filters)
+     *
+     * @return string
+     */
+    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;
 }