DDC-1360 - Add support for quoting dot chained identifiers.

doctrine · Dec 31, 2011 · 4cb8a99 · guilhermeblanco · Dec 31, 2011 · beberlei
1 parent c811c2a
commit 4cb8a99
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 13 deletions.
diff --git a/lib/Doctrine/DBAL/Platforms/AbstractPlatform.php b/lib/Doctrine/DBAL/Platforms/AbstractPlatform.php
@@ -1276,7 +1276,8 @@ public function getCreatePrimaryKeySQL(Index $index, $table)
 
     /**
      * Quotes a string so that it can be safely used as a table or column name,
-     * even if it is a reserved word of the platform.
+     * even if it is a reserved word of the platform. This also detects identifier
+     * chains seperated by dot and quotes them independently.
      *
      * NOTE: Just because you CAN use quoted identifiers doesn't mean
      * you SHOULD use them.  In general, they end up causing way more
@@ -1286,6 +1287,22 @@ public function getCreatePrimaryKeySQL(Index $index, $table)
      * @return string               quoted identifier string
      */
     public function quoteIdentifier($str)
+    {
+        if (strpos($str, ".") !== false) {
+            $parts = array_map(array($this, "quoteIdentifier"), explode(".", $str));
+            return implode(".", $parts);
+        }
+
+        return $this->quoteSingleIdentifier($str);
+    }
+
+    /**
+     * Quote a single identifier (no dot chain seperation)
+     *
+     * @param string $str
+     * @return string
+     */
+    public function quoteSingleIdentifier($str)
     {
         $c = $this->getIdentifierQuoteCharacter();
 
@@ -2591,4 +2608,4 @@ protected function getReservedKeywordsClass()
     {
         throw DBALException::notSupported(__METHOD__);
     }
-}
+}
diff --git a/lib/Doctrine/DBAL/Platforms/MsSqlPlatform.php b/lib/Doctrine/DBAL/Platforms/MsSqlPlatform.php
@@ -831,17 +831,9 @@ protected function getReservedKeywordsClass()
     }
 
     /**
-     * Quotes a string so that it can be safely used as a table or column name,
-     * even if it is a reserved word of the platform.
-     *
-     * NOTE: Just because you CAN use quoted identifiers doesn't mean
-     * you SHOULD use them.  In general, they end up causing way more
-     * problems than they solve.
-     *
-     * @param string $str           identifier name to be quoted
-     * @return string               quoted identifier string
+     * {@inheritDoc}
      */
-    public function quoteIdentifier($str)
+    public function quoteSingleIdentifier($str)
     {
         return "[" . str_replace("]", "][", $str) . "]";
     }

diff --git a/tests/Doctrine/Tests/DBAL/Platforms/AbstractPlatformTestCase.php b/tests/Doctrine/Tests/DBAL/Platforms/AbstractPlatformTestCase.php
@@ -19,16 +19,36 @@ public function setUp()
         $this->_platform = $this->createPlatform();
     }
 
+    /**
+     * @group DDC-1360
+     */
     public function testQuoteIdentifier()
     {
         if ($this->_platform->getName() == "mssql") {
             $this->markTestSkipped('Not working this way on mssql.');
         }
 
         $c = $this->_platform->getIdentifierQuoteCharacter();
+        $this->assertEquals($c."test".$c, $this->_platform->quoteIdentifier("test"));
+        $this->assertEquals($c."test".$c.".".$c."test".$c, $this->_platform->quoteIdentifier("test.test"));
         $this->assertEquals(str_repeat($c, 4), $this->_platform->quoteIdentifier($c));
     }
 
+    /**
+     * @group DDC-1360
+     */
+    public function testQuoteSingleIdentifier()
+    {
+        if ($this->_platform->getName() == "mssql") {
+            $this->markTestSkipped('Not working this way on mssql.');
+        }
+
+        $c = $this->_platform->getIdentifierQuoteCharacter();
+        $this->assertEquals($c."test".$c, $this->_platform->quoteSingleIdentifier("test"));
+        $this->assertEquals($c."test.test".$c, $this->_platform->quoteSingleIdentifier("test.test"));
+        $this->assertEquals(str_repeat($c, 4), $this->_platform->quoteSingleIdentifier($c));
+    }
+
     public function testGetInvalidtForeignKeyReferentialActionSQL()
     {
         $this->setExpectedException('InvalidArgumentException');

diff --git a/tests/Doctrine/Tests/DBAL/Platforms/MsSqlPlatformTest.php b/tests/Doctrine/Tests/DBAL/Platforms/MsSqlPlatformTest.php
@@ -171,8 +171,23 @@ public function testModifyLimitQueryWithDescOrderBy()
         $this->assertEquals('SELECT TOP 10 * FROM user ORDER BY username DESC', $sql);
     }
 
+    /**
+     * @group DDC-1360
+     */
     public function testQuoteIdentifier()
     {
         $this->assertEquals('[fo][o]', $this->_platform->quoteIdentifier('fo]o'));
+        $this->assertEquals('[test]', $this->_platform->quoteIdentifier('test'));
+        $this->assertEquals('[test].[test]', $this->_platform->quoteIdentifier('test.test'));
     }
-}
+
+    /**
+     * @group DDC-1360
+     */
+    public function testQuoteSingleIdentifier()
+    {
+        $this->assertEquals('[fo][o]', $this->_platform->quoteSingleIdentifier('fo]o'));
+        $this->assertEquals('[test]', $this->_platform->quoteSingleIdentifier('test'));
+        $this->assertEquals('[test.test]', $this->_platform->quoteSingleIdentifier('test.test'));
+    }
+}