ManyToMany: Escape with MySQL syntax

Author: homersimpsons

README.md

@@ -12,3 +12,10 @@ TDBM (The DataBase Machine)
 
 Check out [the documentation at https://thecodingmachine.github.io/tdbm/](https://thecodingmachine.github.io/tdbm/).
 
+## Run the test locally
+
+### Postgres
+
+Run an instance with `docker run -p 5432:5432 -e POSTGRES_HOST_AUTH_METHOD=trust postgres:12`
+
+Run the tests with `vendor/bin/phpunit -c phpunit.postgres.xml`

src/TDBMService.php

@@ -1474,10 +1474,13 @@ private function fromCache(string $key, callable $closure)
      */
     public function _getRelatedBeans(ManyToManyRelationshipPathDescriptor $pathDescriptor, AbstractTDBMObject $bean): ResultIterator
     {
+        // Magic Query expect MySQL syntax for quotes
+        $platform = new MySqlPlatform();
+
         return $this->findObjectsFromSql(
             $pathDescriptor->getTargetName(),
-            $pathDescriptor->getPivotFrom($this->connection),
-            $pathDescriptor->getPivotWhere($this->connection),
+            $pathDescriptor->getPivotFrom($platform),
+            $pathDescriptor->getPivotWhere($platform),
             $pathDescriptor->getPivotParams($this->getPrimaryKeyValues($bean)),
             null,
             null,

src/Utils/ManyToManyRelationshipPathDescriptor.php

@@ -3,6 +3,7 @@
 namespace TheCodingMachine\TDBM\Utils;
 
 use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Schema\ForeignKeyConstraint;
 use TheCodingMachine\TDBM\ResultIterator;
 use TheCodingMachine\TDBM\TDBMInvalidArgumentException;
@@ -13,11 +14,11 @@
 class ManyToManyRelationshipPathDescriptor
 {
     /**
-     * @var string
+     * @var string Unquoted identifier of the target table
      */
     private $targetTable;
     /**
-     * @var string
+     * @var string Unquoted identifier of the pivot table
      */
     private $pivotTable;
     /**
@@ -69,7 +70,12 @@ public function getTargetName(): string
         return $this->targetTable;
     }
 
-    public function getPivotFrom(Connection $connection): string
+    /**
+     * Get the `FROM` clause of the query.
+     *
+     * This may have issue handling namespaced table (e.g. mydb.table)
+     */
+    public function getPivotFrom(AbstractPlatform $platform): string
     {
         $mainTable = $this->targetTable;
         $pivotTable = $this->pivotTable;
@@ -78,21 +84,26 @@ public function getPivotFrom(Connection $connection): string
         foreach ($this->joinForeignKeys as $key => $column) {
             $join[] = sprintf(
                 '%s.%s = %s.%s',
-                $connection->quoteIdentifier($mainTable),
-                $connection->quoteIdentifier($column),
-                $connection->quoteIdentifier($pivotTable),
-                $connection->quoteIdentifier($this->joinLocalKeys[$key])
+                $platform->quoteIdentifier($mainTable),
+                $platform->quoteIdentifier($column),
+                $platform->quoteIdentifier($pivotTable),
+                $platform->quoteIdentifier($this->joinLocalKeys[$key])
             );
         }
 
-        return $connection->quoteIdentifier($mainTable) . ' JOIN ' . $connection->quoteIdentifier($pivotTable) . ' ON ' . implode(' AND ', $join);
+        return $platform->quoteIdentifier($mainTable) . ' JOIN ' . $platform->quoteIdentifier($pivotTable) . ' ON ' . implode(' AND ', $join);
     }
 
-    public function getPivotWhere(Connection $connection): string
+    /**
+     * Get the `WHERE` clause of the query.
+     *
+     * This may have issue handling namespaced table (e.g. mydb.table)
+     */
+    public function getPivotWhere(AbstractPlatform $platform): string
     {
         $paramList = [];
         foreach ($this->whereKeys as $key => $column) {
-            $paramList[] = sprintf('%s.%s = :param%s', $connection->quoteIdentifier($this->pivotTable), $connection->quoteIdentifier($column), $key);
+            $paramList[] = sprintf('%s.%s = :param%s', $platform->quoteIdentifier($this->pivotTable), $platform->quoteIdentifier($column), $key);
         }
         return implode(' AND ', $paramList);
     }