Merge pull request #66 from homersimpsons/fix/sql-hints

sql hints

Author: moufmouf

src/SQLParser/Node/Hint.php

@@ -0,0 +1,36 @@
+<?php
+
+
+namespace SQLParser\Node;
+
+
+/**
+ * This class represent a SQL hint, for example USE INDEX (my_index)
+ */
+class Hint
+{
+    /**
+     * @var string The hint type (example 'USE INDEX')
+     */
+    private $type;
+    /**
+     * @var string The hint list (example '(my_index)')
+     */
+    private $list;
+
+    public function __construct(string $type, string $list)
+    {
+        $this->type = $type;
+        $this->list = $list;
+    }
+
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
+    public function getList(): string
+    {
+        return $this->list;
+    }
+}

src/SQLParser/Node/NodeFactory.php

@@ -191,6 +191,12 @@ public static function toObject(array $desc)
                     $expr->setRefClause(self::simplify($subTreeNodes));
                 }
 
+                if (isset($desc['hints']) && $desc['hints']) {
+                    $expr->setHints(array_map(static function (array $hint) {
+                        return new Hint($hint['hint_type'], $hint['hint_list']);
+                    }, $desc['hints']));
+                }
+
                 // Debug:
                 unset($desc['base_expr']);
                 unset($desc['expr_type']);

src/SQLParser/Node/Table.php

@@ -163,6 +163,31 @@ public function setRefClause($refClause)
         $this->refClause = $refClause;
     }
 
+    /**
+     * @var Hint[]
+     */
+    private $hints;
+
+    /**
+     * Return the list of table hints
+     *
+     * @return Hint[]
+     */
+    public function getHints(): array
+    {
+        return $this->hints;
+    }
+
+    /**
+     * Set a list of table hints
+     *
+     * @param Hint[] $hints
+     */
+    public function setHints(array $hints): void
+    {
+        $this->hints = $hints;
+    }
+
     /**
      * Returns a Mouf instance descriptor describing this object.
      *
@@ -206,6 +231,11 @@ public function toSql(array $parameters, AbstractPlatform $platform, int $indent
         if ($this->alias) {
             $sql .= ' AS '.$platform->quoteSingleIdentifier($this->alias);
         }
+        if ($this->hints) {
+            foreach ($this->hints as $hint) {
+                $sql .= ' ' . $hint->getType() . ' ' . $hint->getList();
+            }
+        }
         if ($this->refClause) {
             $sql .= ' ON ';
             $sql .= NodeFactory::toSql($this->refClause, $platform, $parameters, ' ', true, $indent, $conditionsMode, $extrapolateParameters);

tests/Mouf/Database/MagicQueryTest.php

@@ -88,6 +88,9 @@ public function testStandardSelect()
         $sql = 'SELECT * FROM users WHERE email not like :email';
         $this->assertEquals("SELECT * FROM users WHERE email NOT LIKE '%@example.com'", self::simplifySql($magicQuery->build($sql, ['email' => '%@example.com'])));
 
+        $sql = 'SELECT * FROM users USE INDEX (idx_users_email) ORDER BY email';
+        $this->assertEquals("SELECT * FROM users USE INDEX (idx_users_email) ORDER BY email ASC", self::simplifySql($magicQuery->build($sql)));
+
         $sql = 'SELECT * FROM myTable where someField BETWEEN :value1 AND :value2';
         $this->assertEquals("SELECT * FROM myTable WHERE someField BETWEEN '2' AND '4'", self::simplifySql($magicQuery->build($sql, ['value1' => 2, 'value2' => 4])));
         $this->assertEquals("SELECT * FROM myTable WHERE someField >= '2'", self::simplifySql($magicQuery->build($sql, ['value1' => 2])));