Merge pull request #370 from mauriciofauth/context-sql-modes

Add support for passing integers to `Context::setMode`

Author: MauricioFauth

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 * Add missing return types annotations
 * Improve the WITH statements parser (#363)
+* Add support for passing `Context::SQL_MODE*` constants to `Context::setMode` method
+* Deprecate passing strings to the `Context::setMode` method
 
 ## [5.5.0] - 2021-12-08
 

README.md

@@ -24,7 +24,7 @@ composer require phpmyadmin/sql-parser
 
 ## Documentation
 
-The API documentation is available at 
+The API documentation is available at
 <https://develdocs.phpmyadmin.net/sql-parser/>.
 
 ## Usage
@@ -96,7 +96,7 @@ $query2 = $statement->build();
 var_dump($query2); // outputs string(19) 'SELECT  * FROM `b` '
 
 // Change SQL mode
-PhpMyAdmin\SqlParser\Context::setMode('ANSI_QUOTES');
+PhpMyAdmin\SqlParser\Context::setMode(PhpMyAdmin\SqlParser\Context::SQL_MODE_ANSI_QUOTES);
 
 // build the query again using different quotes
 $query2 = $statement->build();

phpstan-baseline.neon

@@ -56,20 +56,25 @@ parameters:
 			path: src/Components/ArrayObj.php
 
 		-
-			message: "#^Array \\(array\\<PhpMyAdmin\\\\SqlParser\\\\Components\\\\Expression\\>\\) does not accept PhpMyAdmin\\\\SqlParser\\\\Components\\\\Expression\\|null\\.$#"
-			count: 3
+			message: "#^Binary operation \"\\.\" between ' AS ' and array\\<string\\>\\|string results in an error\\.$#"
+			count: 1
 			path: src/Components/CaseExpression.php
 
 		-
-			message: "#^Binary operation \"\\.\" between ' AS ' and array\\<string\\>\\|string results in an error\\.$#"
+			message: "#^Property PhpMyAdmin\\\\SqlParser\\\\Components\\\\CaseExpression\\:\\:\\$alias \\(string\\|null\\) does not accept mixed\\.$#"
 			count: 1
 			path: src/Components/CaseExpression.php
 
 		-
-			message: "#^Property PhpMyAdmin\\\\SqlParser\\\\Components\\\\CaseExpression\\:\\:\\$alias \\(string\\|null\\) does not accept mixed\\.$#"
+			message: "#^Property PhpMyAdmin\\\\SqlParser\\\\Components\\\\CaseExpression\\:\\:\\$compare_values \\(array\\<PhpMyAdmin\\\\SqlParser\\\\Components\\\\Expression\\>\\) does not accept array\\<PhpMyAdmin\\\\SqlParser\\\\Components\\\\Expression\\|null\\>\\.$#"
 			count: 1
 			path: src/Components/CaseExpression.php
 
+		-
+			message: "#^Property PhpMyAdmin\\\\SqlParser\\\\Components\\\\CaseExpression\\:\\:\\$results \\(array\\<PhpMyAdmin\\\\SqlParser\\\\Components\\\\Expression\\>\\) does not accept array\\<PhpMyAdmin\\\\SqlParser\\\\Components\\\\Expression\\|null\\>\\.$#"
+			count: 2
+			path: src/Components/CaseExpression.php
+
 		-
 			message: "#^Unreachable statement \\- code above always terminates\\.$#"
 			count: 1
@@ -251,17 +256,17 @@ parameters:
 			path: src/Components/JoinKeyword.php
 
 		-
-			message: "#^Array \\(array\\<array\\{name\\?\\: string, length\\?\\: int, order\\?\\: string\\}\\>\\) does not accept non\\-empty\\-array\\<string, mixed\\>\\.$#"
+			message: "#^Binary operation \"\\.\" between array\\<string\\>\\|string and ' ' results in an error\\.$#"
 			count: 1
 			path: src/Components/Key.php
 
 		-
-			message: "#^Binary operation \"\\.\" between array\\<string\\>\\|string and ' ' results in an error\\.$#"
+			message: "#^Binary operation \"\\.\\=\" between '' and array\\<string\\>\\|string results in an error\\.$#"
 			count: 1
 			path: src/Components/Key.php
 
 		-
-			message: "#^Binary operation \"\\.\\=\" between '' and array\\<string\\>\\|string results in an error\\.$#"
+			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
 			path: src/Components/Key.php
 
@@ -345,6 +350,11 @@ parameters:
 			count: 1
 			path: src/Components/OptionsArray.php
 
+		-
+			message: "#^Property PhpMyAdmin\\\\SqlParser\\\\Components\\\\OptionsArray\\:\\:\\$options \\(array\\<int, mixed\\>\\) does not accept array\\<int\\|string, mixed\\>\\.$#"
+			count: 8
+			path: src/Components/OptionsArray.php
+
 		-
 			message: "#^Right side of && is always true\\.$#"
 			count: 1
@@ -500,19 +510,14 @@ parameters:
 			count: 1
 			path: src/Lexer.php
 
-		-
-			message: "#^Array \\(array\\<PhpMyAdmin\\\\SqlParser\\\\Statements\\\\SelectStatement\\>\\) does not accept array\\<int, PhpMyAdmin\\\\SqlParser\\\\Statements\\\\SelectStatement\\|string\\|true\\>\\.$#"
-			count: 1
-			path: src/Parser.php
-
 		-
 			message: "#^Cannot access property \\$count on PhpMyAdmin\\\\SqlParser\\\\TokensList\\|null\\.$#"
 			count: 1
 			path: src/Parser.php
 
 		-
 			message: "#^Cannot access property \\$idx on PhpMyAdmin\\\\SqlParser\\\\TokensList\\|null\\.$#"
-			count: 7
+			count: 8
 			path: src/Parser.php
 
 		-
@@ -535,6 +540,11 @@ parameters:
 			count: 3
 			path: src/Parser.php
 
+		-
+			message: "#^Property PhpMyAdmin\\\\SqlParser\\\\Statements\\\\SelectStatement\\:\\:\\$union \\(array\\<PhpMyAdmin\\\\SqlParser\\\\Statements\\\\SelectStatement\\>\\) does not accept array\\<array\\<int, bool\\|PhpMyAdmin\\\\SqlParser\\\\Statements\\\\SelectStatement\\|string\\>\\|PhpMyAdmin\\\\SqlParser\\\\Statements\\\\SelectStatement\\>\\.$#"
+			count: 1
+			path: src/Parser.php
+
 		-
 			message: "#^Cannot access property \\$type on PhpMyAdmin\\\\SqlParser\\\\Token\\|null\\.$#"
 			count: 1
@@ -1131,7 +1141,7 @@ parameters:
 			path: tests/Parser/WithStatementTest.php
 
 		-
-			message: "#^Cannot access offset int on non\\-empty\\-array\\<int, string\\>\\|false\\.$#"
+			message: "#^Cannot access offset int\\<0, max\\> on non\\-empty\\-array\\<int, string\\>\\|false\\.$#"
 			count: 1
 			path: tests/Utils/BufferedQueryTest.php
 

psalm-baseline.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="4.18.0.0">
+<files psalm-version="4.18.1@dda05fa913f4dc6eb3386f2f7ce5a45d37a71bcb">
   <file src="src/Component.php">
     <MixedReturnStatement occurrences="1">
       <code>static::build($this)</code>
@@ -584,13 +584,9 @@
     <InvalidReturnType occurrences="1">
       <code>string|string[]</code>
     </InvalidReturnType>
-    <MixedAssignment occurrences="2">
+    <MixedAssignment occurrences="1">
       <code>self::$KEYWORDS</code>
-      <code>static::$MODE</code>
     </MixedAssignment>
-    <MixedOperand occurrences="1">
-      <code>constant('static::SQL_MODE_' . $m)</code>
-    </MixedOperand>
   </file>
   <file src="src/Contexts/ContextMariaDb100000.php">
     <PropertyTypeCoercion occurrences="1"/>