Adding buildPreparedStatement method that can have cached results

Author: moufmouf

.travis.yml

@@ -1,10 +1,8 @@
 language: php
 
 php:
- - 5.6
- - 7.0
- - 7.1
- - 7.2
+ - "7.1"
+ - "7.3"
 
 env:
   matrix:
@@ -16,6 +14,7 @@ before_script:
 
 script:
  - vendor/bin/phpunit
+ - composer phpstan
 
 after_script:
  - php vendor/bin/coveralls -v

composer.json

@@ -13,7 +13,7 @@
         }
     ],
     "require": {
-    	"php": ">=5.3.0",
+    	"php": ">=7.1.0",
     	"mouf/utils.common.conditioninterface": "~2.0",
     	"mouf/utils.value.value-interface": "~1.0",
     	"mouf/utils.common.paginable-interface": "~1.0",
@@ -24,9 +24,10 @@
         "doctrine/cache": "^1.5"
     },
     "require-dev": {
-        "phpunit/phpunit": "~5.0",
+        "phpunit/phpunit": "^7.5.10",
         "satooshi/php-coveralls": "~1.0",
-        "doctrine/dbal": "~2.5"
+        "doctrine/dbal": "~2.5",
+        "phpstan/phpstan": "^0.11.7"
     },
     "suggest": {
       "doctrine/dbal": "To support more databases than just MySQL and to use MagicJoin feature",
@@ -64,5 +65,8 @@
 		}
 	},
     "minimum-stability": "dev",
-    "prefer-stable": true
+    "prefer-stable": true,
+    "scripts": {
+        "phpstan": "vendor/bin/phpstan analyse -c phpstan.neon src"
+    }
 }

doc/discard_unused_parameters.md

@@ -98,6 +98,15 @@ $sql = $magicQuery->build($sql, []);
 // $sql == "SELECT * FROM products p WHERE status2 = null"
 ```
 
+####Working with prepared statements
+
+The `MagicQuery::build` method will remove unused parameters AND replace placeholders with the values.
+If you are looking for the best possible performance, you can use the alternative `MagicQuery::buildPreparedStatement` method.
+
+The "buildPreparedStatement" method is removing unused parameters BUT it does not replace placeholders.
+As a result, MagicQuery can perform some more internal caching and if you have many similar requests, 
+you will get some performance gains.
+
 ###Other alternatives
 
 To avoid concatenating strings, frameworks and libraries have used different strategies. Using a full ORM (like

phpstan.neon

@@ -0,0 +1,5 @@
+parameters:
+    level: 3
+    ignoreErrors:
+        - "#Mouf\\\\MoufManager#"
+        - "#Mouf\\\\MoufInstanceDescriptor#"

phpunit.xml.dist

@@ -8,7 +8,6 @@
          convertWarningsToExceptions="true"
          processIsolation="false"
          stopOnFailure="false"
-         syntaxCheck="false"
          bootstrap="tests/bootstrap.php"
 >
 
@@ -31,7 +30,7 @@
         </whitelist>
     </filter>
     <logging>
-        <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
+        <log type="coverage-html" target="build/coverage" />
         <log type="coverage-clover" target="build/logs/clover.xml"/>
     </logging>
 </phpunit>

src/Mouf/Database/MagicQuery.php

@@ -2,8 +2,11 @@
 
 namespace Mouf\Database;
 
+use function array_filter;
+use function array_keys;
 use Doctrine\Common\Cache\VoidCache;
 use function hash;
+use function implode;
 use Mouf\Database\MagicQuery\Twig\SqlTwigEnvironmentFactory;
 use Mouf\Database\SchemaAnalyzer\SchemaAnalyzer;
 use PHPSQLParser\PHPSQLParser;
@@ -85,13 +88,36 @@ public function build($sql, array $parameters = array())
             $sql = $this->getTwigEnvironment()->render($sql, $parameters);
         }
 
+        $select = $this->parse($sql);
+        $newSql = $this->toSql($select, $parameters, true);
+
+        return $newSql;
+    }
+
+    /**
+     * Returns modified SQL from $sql and $parameters. Any parameters not available will be striped down
+     * from the SQL. Unlike with the `build` method, the parameters are NOT merged into the SQL.
+     * This method is more efficient than `build`  (because result is cached and statements interpolation
+     * can be delegated to the database.
+     *
+     * @param string $sql
+     * @param array  $parameters
+     *
+     * @return string
+     */
+    public function buildPreparedStatement(string $sql, array $parameters = []): string
+    {
+        if ($this->enableTwig) {
+            $sql = $this->getTwigEnvironment()->render($sql, $parameters);
+        }
+
         $availableParameterKeys = array_keys(array_filter($parameters, static function($param) { return $param !== null;}));
         // We choose md4 because it is fast.
         $cacheKey = 'request_build_'.hash('md4', $sql.'__'.implode('_/_', $availableParameterKeys));
         $newSql = $this->cache->fetch($cacheKey);
         if ($newSql === false) {
             $select = $this->parse($sql);
-            $newSql = $this->toSql($select, $parameters);
+            $newSql = $this->toSql($select, $parameters, false);
 
             $this->cache->save($cacheKey, $newSql);
         }
@@ -140,13 +166,14 @@ public function parse($sql)
      * Transforms back a tree of SQL node into a SQL string.
      *
      * @param NodeInterface $sqlNode
-     * @param array         $parameters
-     *
+     * @param array $parameters
+     * @param bool $extrapolateParameters Whether the parameters should be fed into the returned SQL query
+
      * @return string
      */
-    public function toSql(NodeInterface $sqlNode, array $parameters = array())
+    public function toSql(NodeInterface $sqlNode, array $parameters = array(), bool $extrapolateParameters = true)
     {
-        return $sqlNode->toSql($parameters, $this->connection, 0, SqlRenderInterface::CONDITION_GUESS);
+        return $sqlNode->toSql($parameters, $this->connection, 0, SqlRenderInterface::CONDITION_GUESS, $extrapolateParameters);
     }
 
     /**

src/Mouf/Database/QueryWriter/Condition/ParamAvailableCondition.php

@@ -23,9 +23,6 @@ public function __construct($parameterName)
         $this->parameterName = $parameterName;
     }
 
-    /**
-     * @param string $caller
-     */
     public function isOk($parameters = null)
     {
         return isset($parameters[$this->parameterName]) && !empty($parameters[$this->parameterName]);

src/Mouf/Database/QueryWriter/Condition/ParamEqualsCondition.php

@@ -28,9 +28,6 @@ public function __construct($parameterName, $value)
         $this->value = $value;
     }
 
-    /**
-     * @param string $caller
-     */
     public function isOk($parameters = null)
     {
         return isset($parameters[$this->parameterName]) && $parameters[$this->parameterName] == ValueUtils::val($this->value);

src/Mouf/Database/QueryWriter/Condition/ParamNotAvailableCondition.php

@@ -23,9 +23,6 @@ public function __construct($parameterName)
         $this->parameterName = $parameterName;
     }
 
-    /**
-     * @param string $caller
-     */
     public function isOk($parameters = null)
     {
         return !isset($parameters[$this->parameterName]) || empty($parameters[$this->parameterName]);

src/SQLParser/Node/AbstractManyInstancesOperator.php

@@ -63,11 +63,11 @@ public function toInstanceDescriptor(MoufManager $moufManager)
      *
      * @return string
      */
-    public function toSql(array $parameters = array(), Connection $dbConnection = null, $indent = 0, $conditionsMode = self::CONDITION_APPLY)
+    public function toSql(array $parameters = array(), Connection $dbConnection = null, $indent = 0, $conditionsMode = self::CONDITION_APPLY, bool $extrapolateParameters = true)
     {
         $sqlOperands = array();
         foreach ($this->operands as $operand) {
-            $sql = NodeFactory::toSql($operand, $dbConnection, $parameters, ' ', true, $indent, $conditionsMode);
+            $sql = NodeFactory::toSql($operand, $dbConnection, $parameters, ' ', true, $indent, $conditionsMode, $extrapolateParameters);
             if ($sql != null) {
                 $sqlOperands[] = $sql;
             }