Add a mandatory escape char argument

Author: greg0ire

lib/Doctrine/DBAL/Platforms/AbstractPlatform.php

@@ -3582,21 +3582,29 @@ public function getStringLiteralQuoteCharacter()
     /**
      * Escapes metacharacters in a string intended to be used with a LIKE
      * operator.
+     *
+     * @param string $inputString a literal, unquoted string
+     * @param string $escapeChar  should be exactly one character long and
+     *                            should be reused by the caller in the LIKE
+     *                            expression.
      */
-    final public function escapeStringForLike(string $inputString): string
+    final public function escapeStringForLike(string $inputString, string $escapeChar): string
     {
-        $escapeChar = $this->getLikeEscapeChar();
+        /* Some RDBMS' can deal with multibyte characters, but let us assume
+         * that kind of will not actually be needed */
+        $escapeCharLength = \strlen($escapeChar);
+        if ($escapeCharLength !== 1) {
+            throw new \InvalidArgumentException(sprintf(
+                'The escape character should be exactly that, got "%s"',
+                $escapeCharLength
+            ));
+        }
         $replacePairs = [$escapeChar => $escapeChar.$escapeChar];
         foreach ($this->getLikeWildcardCharacters() as $metaChar) {
             $replacePairs[$metaCharacter] = $escapeChar.$metaChar;
         }
 
-        return strtr($inputString, $replacePairs);
-    }
-
-    protected function getLikeEscapeChar(): string
-    {
-        return '\\';
+        return \strtr($inputString, $replacePairs);
     }
 
     protected function getLikeWildcardCharacters(): iterable

tests/Doctrine/Tests/DBAL/Platforms/AbstractPlatformTestCase.php

@@ -1468,4 +1468,10 @@ public function getGeneratesFloatDeclarationSQL()
             array(array('precision' => 8, 'scale' => 2), 'DOUBLE PRECISION'),
         );
     }
+
+    public function testItThrowsOnMultibyteEscapeChar()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->_platform->escapeStringForLike('random string', '💩');
+    }
 }