Merge pull request #56 from moufmouf/platform_option

Adding an option to choose the SQL dialect generated

Author: moufmouf

README.md

@@ -154,6 +154,15 @@ $conn = \Doctrine\DBAL\DriverManager::getConnection($connectionParams, $config);
 $magicQuery = new \Mouf\Database\MagicQuery($conn);
 ```
 
+Also, if you have no connection to your database configured but you want to generate SQL in some specific dialect, you can
+instead set the DBAL database platform used:
+
+```php
+$magicQuery->setOutputDialect(new \Doctrine\DBAL\Platforms\PostgreSqlPlatform());
+$magicQuery = new \Mouf\Database\MagicQuery();
+```
+
+
 What about performances?
 ------------------------
 

phpstan.neon

@@ -1,5 +1,7 @@
 parameters:
-    level: 2
+    level: 7
+    inferPrivatePropertyTypeFromConstructor: true
     ignoreErrors:
         - "#Mouf\\\\MoufManager#"
-        - "#Mouf\\\\MoufInstanceDescriptor#"
+        - "#Mouf\\\\MoufInstanceDescriptor#"
+        - '#Method Mouf\\Database\\QueryWriter\\Utils\\FindParametersService::findParameters\(\) should return array<string> but returns array<int, int\|string>#'

src/Mouf/Database/MagicQuery.php

@@ -2,6 +2,9 @@
 
 namespace Mouf\Database;
 
+use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Platforms\MySqlPlatform;
 use function array_filter;
 use function array_keys;
 use Doctrine\Common\Cache\VoidCache;
@@ -32,6 +35,10 @@ class MagicQuery
     private $connection;
     private $cache;
     private $schemaAnalyzer;
+    /**
+     * @var AbstractPlatform
+     */
+    private $platform;
     /**
      * @var \Twig_Environment
      */
@@ -46,6 +53,7 @@ class MagicQuery
     public function __construct($connection = null, $cache = null, SchemaAnalyzer $schemaAnalyzer = null)
     {
         $this->connection = $connection;
+        $this->platform = $connection ? $connection->getDatabasePlatform() : new MySqlPlatform();
         if ($cache) {
             $this->cache = $cache;
         } else {
@@ -71,6 +79,19 @@ public function setEnableTwig($enableTwig = true)
         return $this;
     }
 
+    /**
+     * Overrides the output dialect used to generate SQL. By default, the dialect of the connection is used.
+     * If no connection is used, MySQL platform is used by default.
+     *
+     * @param AbstractPlatform $platform
+     */
+    public function setOutputDialect(AbstractPlatform $platform): self
+    {
+        $this->platform = $platform;
+
+        return $this;
+    }
+
     /**
      * Returns merged SQL from $sql and $parameters. Any parameters not available will be striped down
      * from the SQL.
@@ -173,7 +194,7 @@ public function parse($sql)
      */
     public function toSql(NodeInterface $sqlNode, array $parameters = array(), bool $extrapolateParameters = true)
     {
-        return $sqlNode->toSql($parameters, $this->connection, 0, SqlRenderInterface::CONDITION_GUESS, $extrapolateParameters);
+        return (string) $sqlNode->toSql($parameters, $this->platform, 0, SqlRenderInterface::CONDITION_GUESS, $extrapolateParameters);
     }
 
     /**
@@ -284,15 +305,15 @@ private function getSchemaAnalyzer()
                 throw new MagicQueryMissingConnectionException('In order to use MagicJoin, you need to configure a DBAL connection.');
             }
 
-            $this->schemaAnalyzer = new SchemaAnalyzer($this->connection->getSchemaManager(), $this->cache, $this->getConnectionUniqueId());
+            $this->schemaAnalyzer = new SchemaAnalyzer($this->connection->getSchemaManager(), $this->cache, $this->getConnectionUniqueId($this->connection));
         }
 
         return $this->schemaAnalyzer;
     }
 
-    private function getConnectionUniqueId()
+    private function getConnectionUniqueId(Connection $connection)
     {
-        return hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName());
+        return hash('md4', $connection->getHost().'-'.$connection->getPort().'-'.$connection->getDatabase().'-'.$connection->getDriver()->getName());
     }
 
     /**

src/Mouf/Database/QueryWriter/QueryResult.php

@@ -75,21 +75,21 @@ public function setParameters($parameters)
     public function val()
     {
         $parameters = ValueUtils::val($this->parameters);
-        $pdoStatement = $this->connection->query($this->select->toSql($parameters, $this->connection).DbHelper::getFromLimitString($this->offset, $this->limit));
+        $pdoStatement = $this->connection->query($this->select->toSql($parameters, $this->connection->getDatabasePlatform()).DbHelper::getFromLimitString($this->offset, $this->limit));
 
         return new ResultSet($pdoStatement);
     }
 
     /**
      * Returns the SQL for this query-result (without pagination, but with parameters accounted for).
      *
-     * @return string
+     * @return string|null
      */
     public function toSql()
     {
         $parameters = ValueUtils::val($this->parameters);
 
-        return $this->select->toSql($parameters, $this->connection);
+        return $this->select->toSql($parameters, $this->connection->getDatabasePlatform());
     }
 
     /**
@@ -133,9 +133,9 @@ public function sort($key, $direction = SortableInterface::ASC)
      *
      * @param string $key
      *
-     * @return NodeInterface
+     * @return NodeInterface|null
      */
-    private function findColumnByKey($key)
+    private function findColumnByKey($key): ?NodeInterface
     {
         $columns = $this->select->getColumns();
         foreach ($columns as $column) {
@@ -152,6 +152,6 @@ private function findColumnByKey($key)
             }
         }
 
-        return;
+        return null;
     }
 }

src/Mouf/Database/QueryWriter/ResultSet.php

@@ -2,6 +2,8 @@
 
 namespace Mouf\Database\QueryWriter;
 
+use Doctrine\DBAL\Statement;
+
 /**
  * Wraps the results of a PDOStatement.
  *
@@ -10,7 +12,7 @@
 class ResultSet implements \Iterator
 {
     /**
-     * @var \PDOStatement
+     * @var \PDOStatement|Statement
      */
     private $statement;
     private $castToClass;
@@ -19,7 +21,7 @@ class ResultSet implements \Iterator
     private $fetched = false;
     private $rewindCalls = 0;
 
-    public function __construct(\PDOStatement $statement, $castToClass = '')
+    public function __construct($statement, $castToClass = '')
     {
         $this->statement = $statement;
         $this->castToClass = $castToClass;

src/SQLParser/Node/AbstractManyInstancesOperator.php

@@ -2,7 +2,7 @@
 
 namespace SQLParser\Node;
 
-use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Mouf\MoufManager;
 use Mouf\MoufInstanceDescriptor;
 use SQLParser\Node\Traverser\NodeTraverser;
@@ -56,18 +56,19 @@ public function toInstanceDescriptor(MoufManager $moufManager)
     /**
      * Renders the object as a SQL string.
      *
-     * @param Connection $dbConnection
-     * @param array      $parameters
-     * @param number     $indent
-     * @param int        $conditionsMode
+     * @param array $parameters
+     * @param AbstractPlatform $platform
+     * @param int $indent
+     * @param int $conditionsMode
      *
+     * @param bool $extrapolateParameters
      * @return string
      */
-    public function toSql(array $parameters = array(), Connection $dbConnection = null, $indent = 0, $conditionsMode = self::CONDITION_APPLY, bool $extrapolateParameters = true)
+    public function toSql(array $parameters, AbstractPlatform $platform, int $indent = 0, $conditionsMode = self::CONDITION_APPLY, bool $extrapolateParameters = true): ?string
     {
         $sqlOperands = array();
         foreach ($this->operands as $operand) {
-            $sql = NodeFactory::toSql($operand, $dbConnection, $parameters, ' ', true, $indent, $conditionsMode, $extrapolateParameters);
+            $sql = NodeFactory::toSql($operand, $platform, $parameters, ' ', true, $indent, $conditionsMode, $extrapolateParameters);
             if ($sql != null) {
                 $sqlOperands[] = $sql;
             }

src/SQLParser/Node/AbstractTwoOperandsOperator.php

@@ -2,8 +2,8 @@
 
 namespace SQLParser\Node;
 
+use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Mouf\Utils\Common\ConditionInterface\ConditionTrait;
-use Doctrine\DBAL\Connection;
 use Mouf\MoufManager;
 use Mouf\MoufInstanceDescriptor;
 use SQLParser\Node\Traverser\NodeTraverser;
@@ -89,14 +89,15 @@ public function toInstanceDescriptor(MoufManager $moufManager)
     /**
      * Renders the object as a SQL string.
      *
-     * @param Connection $dbConnection
-     * @param array      $parameters
-     * @param number     $indent
-     * @param int        $conditionsMode
+     * @param array $parameters
+     * @param AbstractPlatform $platform
+     * @param int $indent
+     * @param int $conditionsMode
      *
+     * @param bool $extrapolateParameters
      * @return string
      */
-    public function toSql(array $parameters = array(), Connection $dbConnection = null, $indent = 0, $conditionsMode = self::CONDITION_APPLY, bool $extrapolateParameters = true)
+    public function toSql(array $parameters, AbstractPlatform $platform, int $indent = 0, $conditionsMode = self::CONDITION_APPLY, bool $extrapolateParameters = true): ?string
     {
         if ($conditionsMode == self::CONDITION_GUESS) {
             $bypass = false;
@@ -107,25 +108,25 @@ public function toSql(array $parameters = array(), Connection $dbConnection = nu
                 $bypass = true;
             }
             if ($bypass === true) {
-                return;
+                return null;
             } else {
                 $conditionsMode = self::CONDITION_IGNORE;
             }
         }
         if ($conditionsMode == self::CONDITION_IGNORE || !$this->condition || $this->condition->isOk($parameters)) {
-            $sql = $this->getSql($parameters, $dbConnection, $indent, $conditionsMode, $extrapolateParameters);
+            $sql = $this->getSql($parameters, $platform, $indent, $conditionsMode, $extrapolateParameters);
         } else {
             $sql = null;
         }
 
         return $sql;
     }
 
-    protected function getSql(array $parameters = array(), Connection $dbConnection = null, $indent = 0, $conditionsMode = self::CONDITION_APPLY, bool $extrapolateParameters = true)
+    protected function getSql(array $parameters, AbstractPlatform $platform, $indent = 0, $conditionsMode = self::CONDITION_APPLY, bool $extrapolateParameters = true)
     {
-        $sql = NodeFactory::toSql($this->leftOperand, $dbConnection, $parameters, ' ', false, $indent, $conditionsMode, $extrapolateParameters);
+        $sql = NodeFactory::toSql($this->leftOperand, $platform, $parameters, ' ', false, $indent, $conditionsMode, $extrapolateParameters);
         $sql .= ' '.$this->getOperatorSymbol().' ';
-        $sql .= NodeFactory::toSql($this->rightOperand, $dbConnection, $parameters, ' ', false, $indent, $conditionsMode, $extrapolateParameters);
+        $sql .= NodeFactory::toSql($this->rightOperand, $platform, $parameters, ' ', false, $indent, $conditionsMode, $extrapolateParameters);
 
         return $sql;
     }

src/SQLParser/Node/AggregateFunction.php

@@ -32,7 +32,7 @@
  */
 namespace SQLParser\Node;
 
-use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Mouf\MoufManager;
 use Mouf\MoufInstanceDescriptor;
 use SQLParser\Node\Traverser\NodeTraverser;
@@ -144,16 +144,17 @@ public function toInstanceDescriptor(MoufManager $moufManager)
     /**
      * Renders the object as a SQL string.
      *
-     * @param Connection $dbConnection
-     * @param array      $parameters
-     * @param number     $indent
-     * @param int        $conditionsMode
+     * @param array $parameters
+     * @param AbstractPlatform $platform
+     * @param int $indent
+     * @param int $conditionsMode
      *
+     * @param bool $extrapolateParameters
      * @return string
      */
-    public function toSql(array $parameters = array(), Connection $dbConnection = null, $indent = 0, $conditionsMode = self::CONDITION_APPLY, bool $extrapolateParameters = true)
+    public function toSql(array $parameters, AbstractPlatform $platform, int $indent = 0, $conditionsMode = self::CONDITION_APPLY, bool $extrapolateParameters = true): ?string
     {
-        $subTreeSql = NodeFactory::toSql($this->subTree, $dbConnection, $parameters, ', ', false, $indent, $conditionsMode, $extrapolateParameters);
+        $subTreeSql = NodeFactory::toSql($this->subTree, $platform, $parameters, ', ', false, $indent, $conditionsMode, $extrapolateParameters);
         if ($subTreeSql !== null) {
             $sql = $this->functionName.'(';
             $sql .= $subTreeSql;