Adding a possibility to bypass MagicParameter

Author: moufmouf

doc/discard_unused_parameters.md

@@ -65,6 +65,28 @@ $magicQuery = new MagicQuery();
 $sql = $magicQuery->build($sql, $params);
 ```
 
+####Forcing some parameters to be null
+
+MagicQuery assumes that if a parameter is null, you want to completely remove the code related to this 
+parameter from the SQL.
+
+But sometimes, you actually want to test parameters against the NULL value.
+In those cases, you need to disable the MagicParameter feature of MagicQuery for those parameters.
+
+<div class="alert alert-info">To disable MagicParameter for a given parameter, simply add an exclamation
+mark (!) after the parameter name.</div>
+
+```php
+// This query uses twice the "status" parameter. Once with ! and once without
+$sql = "SELECT * FROM products p WHERE status1 = :status AND status2 = :status!";
+
+$magicQuery = new MagicQuery();
+// We don't pass the "status" parameter
+$sql = $magicQuery->build($sql, []);
+// The part "status1 = :status" is discarded, but the part "status2 = :status!" is kept
+// $sql == "SELECT * FROM products p WHERE status2 = null"
+```
+
 ###Other alternatives
 
 To avoid concatenating strings, frameworks and libraries have used different strategies. Using a full ORM (like

src/Mouf/Database/MagicQuery.php

@@ -58,7 +58,7 @@ public function __construct($connection = null, $cache = null, SchemaAnalyzer $s
      * @return $this
      */
     public function setEnableTwig($enableTwig = true) {
-        $this->enableTwig = true;
+        $this->enableTwig = $enableTwig;
         return $this;
     }
 

src/SQLParser/Node/AbstractTwoOperandsOperator.php

@@ -101,12 +101,12 @@ public function toSql(array $parameters = array(), Connection $dbConnection = nu
         if ($conditionsMode == self::CONDITION_GUESS) {
             $bypass = false;
             if ($this->leftOperand instanceof Parameter) {
-                if (!isset($parameters[$this->leftOperand->getName()])) {
+                if ($this->leftOperand->isDiscardedOnNull() && !isset($parameters[$this->leftOperand->getName()])) {
                     $bypass = true;
                 }
             }
             if ($this->rightOperand instanceof Parameter) {
-                if (!isset($parameters[$this->rightOperand->getName()])) {
+                if ($this->rightOperand->isDiscardedOnNull() && !isset($parameters[$this->rightOperand->getName()])) {
                     $bypass = true;
                 }
             }

src/SQLParser/Node/Parameter.php

@@ -46,9 +46,10 @@
 class Parameter implements NodeInterface
 {
     private $name;
+    private $discardedOnNull = true;
 
     /**
-     * Returns the name name.
+     * Returns the name.
      *
      * @return string
      */
@@ -58,15 +59,22 @@ public function getName()
     }
 
     /**
-     * Sets the name name.
+     * Sets the name.
+     * If the name ends with !, the parameter will be considered not nullable (regarding magicparameter settings)
      *
      * @Important
      *
      * @param string $name
      */
     public function setName($name)
     {
-        $this->name = $name;
+        if (strrpos($name, '!') === strlen($name)-1) {
+            $this->name = substr($name, 0, strlen($name)-1);
+            $this->discardedOnNull = false;
+        } else {
+            $this->name = $name;
+            $this->discardedOnNull = true;
+        }
     }
 
     /**
@@ -177,6 +185,8 @@ public function toSql(array $parameters = array(), Connection $dbConnection = nu
 
                 }
             }
+        } elseif (!$this->isDiscardedOnNull()) {
+            return 'null';
         } else {
             return ':'.$this->name;
         }
@@ -196,4 +206,12 @@ public function walk(VisitorInterface $visitor) {
         }
         return $visitor->leaveNode($node);
     }
+
+    /**
+     * Returns whether the parameter can be discarded if provided value is null.
+     * @return bool
+     */
+    public function isDiscardedOnNull() {
+       return $this->discardedOnNull;
+    }
 }

tests/Mouf/Database/MagicQueryTest.php

@@ -36,7 +36,9 @@ public function testStandardSelect()
         $sql = 'SELECT id+1 FROM users';
         $this->assertEquals("SELECT id + '1' FROM users", self::simplifySql($magicQuery->build($sql)));
 
-
+        // Tests parameters with a ! (to force NULL values)
+        $sql = 'SELECT * FROM users WHERE status = :status!';
+        $this->assertEquals("SELECT * FROM users WHERE status = null", self::simplifySql($magicQuery->build($sql, ['status' => null])));
     }
 
     public function testWithCache() {