Split up Context::escape()

phpstan-baseline.neon

@@ -60,11 +60,6 @@ parameters:
 			count: 1
 			path: src/Components/ArrayObj.php
 
-		-
-			message: "#^Binary operation \"\\.\" between ' AS ' and array\\<string\\>\\|string results in an error\\.$#"
-			count: 1
-			path: src/Components/CaseExpression.php
-
 		-
 			message: "#^Property PhpMyAdmin\\\\SqlParser\\\\Components\\\\CaseExpression\\:\\:\\$alias \\(string\\|null\\) does not accept mixed\\.$#"
 			count: 1
@@ -90,11 +85,6 @@ parameters:
 			count: 1
 			path: src/Components/Condition.php
 
-		-
-			message: "#^Binary operation \"\\.\" between array\\<string\\>\\|string and ' ' results in an error\\.$#"
-			count: 1
-			path: src/Components/CreateDefinition.php
-
 		-
 			message: "#^Property PhpMyAdmin\\\\SqlParser\\\\Components\\\\CreateDefinition\\:\\:\\$name \\(string\\|null\\) does not accept mixed\\.$#"
 			count: 2
@@ -125,16 +115,6 @@ parameters:
 			count: 1
 			path: src/Components/DataType.php
 
-		-
-			message: "#^Binary operation \"\\.\" between ' AS ' and array\\<string\\>\\|string results in an error\\.$#"
-			count: 1
-			path: src/Components/Expression.php
-
-		-
-			message: "#^Parameter \\#2 \\$array of function implode expects array\\|null, array\\<string\\>\\|string given\\.$#"
-			count: 1
-			path: src/Components/Expression.php
-
 		-
 			message: "#^Property PhpMyAdmin\\\\SqlParser\\\\Components\\\\Expression\\:\\:\\$alias \\(string\\|null\\) does not accept mixed\\.$#"
 			count: 3
@@ -250,16 +230,6 @@ parameters:
 			count: 1
 			path: src/Components/JoinKeyword.php
 
-		-
-			message: "#^Binary operation \"\\.\" between array\\<string\\>\\|string and ' ' results in an error\\.$#"
-			count: 1
-			path: src/Components/Key.php
-
-		-
-			message: "#^Binary operation \"\\.\\=\" between '' and array\\<string\\>\\|string results in an error\\.$#"
-			count: 1
-			path: src/Components/Key.php
-
 		-
 			message: "#^Property PhpMyAdmin\\\\SqlParser\\\\Components\\\\Key\\:\\:\\$columns \\(array\\<array\\{name\\?\\: string, length\\?\\: int, order\\?\\: string\\}\\>\\) does not accept non\\-empty\\-array\\<array\\<string, mixed\\>\\>\\.$#"
 			count: 1
@@ -430,11 +400,6 @@ parameters:
 			count: 1
 			path: src/Components/Reference.php
 
-		-
-			message: "#^Parameter \\#2 \\$array of function implode expects array\\|null, array\\<string\\>\\|string given\\.$#"
-			count: 1
-			path: src/Components/Reference.php
-
 		-
 			message: "#^Property PhpMyAdmin\\\\SqlParser\\\\Components\\\\Reference\\:\\:\\$options \\(PhpMyAdmin\\\\SqlParser\\\\Components\\\\OptionsArray\\) does not accept PhpMyAdmin\\\\SqlParser\\\\Components\\\\OptionsArray\\|null\\.$#"
 			count: 1
@@ -480,11 +445,6 @@ parameters:
 			count: 1
 			path: src/Components/UnionKeyword.php
 
-		-
-			message: "#^Method PhpMyAdmin\\\\SqlParser\\\\Context\\:\\:escape\\(\\) should return array\\<string\\>\\|string but returns array\\<array\\<string\\>\\|string\\>\\.$#"
-			count: 1
-			path: src/Context.php
-
 		-
 			message: "#^Static property PhpMyAdmin\\\\SqlParser\\\\Context\\:\\:\\$keywords \\(non\\-empty\\-array\\<non\\-empty\\-string, int\\>\\) does not accept default value of type array\\{\\}\\.$#"
 			count: 1
@@ -690,21 +650,6 @@ parameters:
 			count: 1
 			path: src/Statements/DeleteStatement.php
 
-		-
-			message: "#^Binary operation \"\\.\" between ' ' and array\\<string\\>\\|string results in an error\\.$#"
-			count: 1
-			path: src/Statements/ExplainStatement.php
-
-		-
-			message: "#^Binary operation \"\\.\" between array\\<string\\>\\|string and '\\.' results in an error\\.$#"
-			count: 1
-			path: src/Statements/ExplainStatement.php
-
-		-
-			message: "#^Binary operation \"\\.\\=\" between string and array\\<string\\>\\|string results in an error\\.$#"
-			count: 1
-			path: src/Statements/ExplainStatement.php
-
 		-
 			message: "#^Cannot access property \\$keyword on PhpMyAdmin\\\\SqlParser\\\\Token\\|null\\.$#"
 			count: 1

psalm-baseline.xml

@@ -126,9 +126,6 @@
     <MoreSpecificImplementedParamType>
       <code>$component</code>
     </MoreSpecificImplementedParamType>
-    <PossiblyInvalidOperand>
-      <code><![CDATA[Context::escape($component->alias)]]></code>
-    </PossiblyInvalidOperand>
   </file>
   <file src="src/Components/Condition.php">
     <InvalidArgument>
@@ -164,9 +161,6 @@
     <MoreSpecificImplementedParamType>
       <code>$component</code>
     </MoreSpecificImplementedParamType>
-    <PossiblyInvalidOperand>
-      <code><![CDATA[Context::escape($component->name)]]></code>
-    </PossiblyInvalidOperand>
     <PossiblyNullOperand>
       <code><![CDATA[$component->options]]></code>
     </PossiblyNullOperand>
@@ -210,12 +204,6 @@
     <MoreSpecificImplementedParamType>
       <code>$component</code>
     </MoreSpecificImplementedParamType>
-    <PossiblyInvalidArgument>
-      <code>Context::escape($fields)</code>
-    </PossiblyInvalidArgument>
-    <PossiblyInvalidOperand>
-      <code><![CDATA[Context::escape($component->alias)]]></code>
-    </PossiblyInvalidOperand>
     <PossiblyNullOperand>
       <code><![CDATA[$ret->expr]]></code>
       <code><![CDATA[$ret->expr]]></code>
@@ -366,10 +354,6 @@
     <MoreSpecificImplementedParamType>
       <code>$component</code>
     </MoreSpecificImplementedParamType>
-    <PossiblyInvalidOperand>
-      <code><![CDATA[Context::escape($column['name'])]]></code>
-      <code><![CDATA[Context::escape($component->name)]]></code>
-    </PossiblyInvalidOperand>
     <PossiblyNullOperand>
       <code><![CDATA[$component->options]]></code>
       <code><![CDATA[$component->options]]></code>
@@ -528,9 +512,6 @@
     <MoreSpecificImplementedParamType>
       <code>$component</code>
     </MoreSpecificImplementedParamType>
-    <PossiblyInvalidOperand>
-      <code><![CDATA[Context::escape($component->name)]]></code>
-    </PossiblyInvalidOperand>
     <PossiblyNullPropertyAssignmentValue>
       <code>$inOut</code>
       <code>$name</code>
@@ -586,9 +567,6 @@
     <MoreSpecificImplementedParamType>
       <code>$component</code>
     </MoreSpecificImplementedParamType>
-    <PossiblyInvalidArgument>
-      <code><![CDATA[Context::escape($component->columns)]]></code>
-    </PossiblyInvalidArgument>
     <PossiblyInvalidPropertyFetch>
       <code><![CDATA[ArrayObj::parse($parser, $list)->values]]></code>
     </PossiblyInvalidPropertyFetch>
@@ -667,12 +645,6 @@
     <InvalidPropertyFetch>
       <code>$context::$keywords</code>
     </InvalidPropertyFetch>
-    <InvalidReturnStatement>
-      <code>$str</code>
-    </InvalidReturnStatement>
-    <InvalidReturnType>
-      <code>string|string[]</code>
-    </InvalidReturnType>
     <MixedAssignment>
       <code>self::$keywords</code>
     </MixedAssignment>
@@ -1118,12 +1090,6 @@
       <code><![CDATA[$this->explainedDatabase]]></code>
       <code><![CDATA[$this->explainedTable]]></code>
     </MixedAssignment>
-    <PossiblyInvalidOperand>
-      <code><![CDATA[Context::escape($this->explainedColumn)]]></code>
-      <code><![CDATA[Context::escape($this->explainedDatabase)]]></code>
-      <code><![CDATA[Context::escape($this->explainedTable)]]></code>
-      <code><![CDATA[Context::escape($this->explainedTable)]]></code>
-    </PossiblyInvalidOperand>
     <PossiblyNullPropertyFetch>
       <code><![CDATA[$nextToken->keyword]]></code>
       <code><![CDATA[$nextToken->value]]></code>

src/Components/Expression.php

@@ -472,7 +472,7 @@ public static function build($component, array $options = []): string
                 $fields[] = $component->column;
             }
 
-            $ret = implode('.', Context::escape($fields));
+            $ret = implode('.', Context::escapeAll($fields));
         }
 
         if (! empty($component->alias)) {

src/Components/Reference.php

@@ -147,7 +147,7 @@ public static function build($component, array $options = []): string
     {
         return trim(
             $component->table
-            . ' (' . implode(', ', Context::escape($component->columns)) . ') '
+            . ' (' . implode(', ', Context::escapeAll($component->columns)) . ') '
             . $component->options
         );
     }

src/Context.php

@@ -8,7 +8,6 @@
 use function explode;
 use function in_array;
 use function intval;
-use function is_array;
 use function is_int;
 use function is_numeric;
 use function str_replace;
@@ -669,21 +668,13 @@ private static function getModeFromString(string $mode): int
     /**
      * Escapes the symbol by adding surrounding backticks.
      *
-     * @param string[]|string $str   the string to be escaped
-     * @param string          $quote quote to be used when escaping
+     * @param string $str   the string to be escaped
+     * @param string $quote quote to be used when escaping
      *
-     * @return string|string[]
+     * @return string
      */
-    public static function escape($str, string $quote = '`')
+    public static function escape(string $str, string $quote = '`')
     {
-        if (is_array($str)) {
-            foreach ($str as $key => $value) {
-                $str[$key] = static::escape($value);
-            }
-
-            return $str;
-        }
-
         if ((static::$mode & self::SQL_MODE_NO_ENCLOSING_QUOTES) && (! static::isKeyword($str, true))) {
             return $str;
         }
@@ -695,6 +686,22 @@ public static function escape($str, string $quote = '`')
         return $quote . str_replace($quote, $quote . $quote, $str) . $quote;
     }
 
+    /**
+     * Escapes the symbol by adding surrounding backticks.
+     *
+     * @param string[] $strings the string to be escaped
+     *
+     * @return string[]
+     */
+    public static function escapeAll(array $strings): array
+    {
+        foreach ($strings as $key => $value) {
+            $strings[$key] = static::escape($value);
+        }
+
+        return $strings;
+    }
+
     /**
      * Returns char used to quote identifiers based on currently set SQL Mode (ie. standard or ANSI_QUOTES)
      *

tests/Lexer/ContextTest.php

@@ -222,6 +222,12 @@ public function testEscape(): void
         Context::setMode();
         $this->assertEquals('`test`', Context::escape('test'));
 
-        $this->assertEquals(['`a`', '`b`'], Context::escape(['a', 'b']));
+        $this->assertEquals(['`a`', '`b`'], Context::escapeAll(['a', 'b']));
+    }
+
+    public function testEscapeAll(): void
+    {
+        Context::setMode();
+        $this->assertEquals(['`a`', '`b`'], Context::escapeAll(['a', 'b']));
     }
 }