Skip to content

D
doctrine-dbal
Unverified Commit 388ea62f authored by Michael Moravec's avatar Michael Moravec Committed by Sergei Morozov
Browse files
Options

Remove deprecated SQLParserUtils::getPlaceholderPositions()

parent 21160fb0
Show whitespace changes
Inline Side-by-side
Showing with 80 additions and 73 deletions
UPGRADE.md
View file @ 388ea62f
...@@ -9,6 +9,7 @@ ...@@ -9,6 +9,7 @@
* Removed `MysqlPlatform::getCollationFieldDeclaration()`. * Removed `MysqlPlatform::getCollationFieldDeclaration()`.
* Removed `AbstractPlatform::getIdentityColumnNullInsertSQL()`. * Removed `AbstractPlatform::getIdentityColumnNullInsertSQL()`.
* Removed `Table::addUnnamedForeignKeyConstraint()` and `Table::addNamedForeignKeyConstraint()`. * Removed `Table::addUnnamedForeignKeyConstraint()` and `Table::addNamedForeignKeyConstraint()`.
* Removed `SQLParserUtils::getPlaceholderPositions()`.
* `SQLParserUtils::*_TOKEN` constants made private. * `SQLParserUtils::*_TOKEN` constants made private.
## BC BREAK changes the `Driver::connect()` signature ## BC BREAK changes the `Driver::connect()` signature
......
src/SQLParserUtils.php
View file @ 388ea62f
...@@ -42,26 +42,6 @@ class SQLParserUtils ...@@ -42,26 +42,6 @@ class SQLParserUtils
private const ESCAPED_BRACKET_QUOTED_TEXT = '(?<!\b(?i:ARRAY))\[(?:[^\]])*\]'; private const ESCAPED_BRACKET_QUOTED_TEXT = '(?<!\b(?i:ARRAY))\[(?:[^\]])*\]';
/**
* Gets an array of the placeholders in an sql statements as keys and their positions in the query string.
*
* For a statement with positional parameters, returns a zero-indexed list of placeholder position.
* For a statement with named parameters, returns a map of placeholder positions to their parameter names.
*
* @deprecated Will be removed as internal implementation detail.
*
* @param string $statement
* @param bool $isPositional
*
* @return int[]|string[]
*/
public static function getPlaceholderPositions($statement, $isPositional = true)
{
return $isPositional
? self::getPositionalPlaceholderPositions($statement)
: self::getNamedPlaceholderPositions($statement);
}
/** /**
* Returns a zero-indexed list of placeholder position. * Returns a zero-indexed list of placeholder position.
* *
......
tests/SQLParserUtilsTest.php
View file @ 388ea62f
...@@ -7,6 +7,7 @@ use Doctrine\DBAL\ParameterType; ...@@ -7,6 +7,7 @@ use Doctrine\DBAL\ParameterType;
use Doctrine\DBAL\SQLParserUtils; use Doctrine\DBAL\SQLParserUtils;
use Doctrine\DBAL\SQLParserUtilsException; use Doctrine\DBAL\SQLParserUtilsException;
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
use ReflectionMethod;
/** /**
* @group DBAL-78 * @group DBAL-78
...@@ -17,55 +18,66 @@ class SQLParserUtilsTest extends TestCase ...@@ -17,55 +18,66 @@ class SQLParserUtilsTest extends TestCase
/** /**
* @return mixed[][] * @return mixed[][]
*/ */
public static function dataGetPlaceholderPositions(): iterable public static function dataGetPlaceholderPositionalPositions(): iterable
{ {
return [ return [
// none // none
['SELECT * FROM Foo', true, []], ['SELECT * FROM Foo', []],
['SELECT * FROM Foo', false, []],
// Positionals // Positionals
['SELECT ?', true, [7]], ['SELECT ?', [7]],
['SELECT * FROM Foo WHERE bar IN (?, ?, ?)', true, [32, 35, 38]], ['SELECT * FROM Foo WHERE bar IN (?, ?, ?)', [32, 35, 38]],
['SELECT ? FROM ?', true, [7, 14]], ['SELECT ? FROM ?', [7, 14]],
['SELECT "?" FROM foo', true, []], ['SELECT "?" FROM foo', []],
["SELECT '?' FROM foo", true, []], ["SELECT '?' FROM foo", []],
['SELECT `?` FROM foo', true, []], // Ticket DBAL-552 ['SELECT `?` FROM foo', []], // Ticket DBAL-552
['SELECT [?] FROM foo', true, []], ['SELECT [?] FROM foo', []],
["SELECT 'Doctrine\DBAL?' FROM foo", true, []], // Ticket DBAL-558 ["SELECT 'Doctrine\DBAL?' FROM foo", []], // Ticket DBAL-558
['SELECT "Doctrine\DBAL?" FROM foo', true, []], // Ticket DBAL-558 ['SELECT "Doctrine\DBAL?" FROM foo', []], // Ticket DBAL-558
['SELECT `Doctrine\DBAL?` FROM foo', true, []], // Ticket DBAL-558 ['SELECT `Doctrine\DBAL?` FROM foo', []], // Ticket DBAL-558
['SELECT [Doctrine\DBAL?] FROM foo', true, []], // Ticket DBAL-558 ['SELECT [Doctrine\DBAL?] FROM foo', []], // Ticket DBAL-558
['SELECT "?" FROM foo WHERE bar = ?', true, [32]], ['SELECT "?" FROM foo WHERE bar = ?', [32]],
["SELECT '?' FROM foo WHERE bar = ?", true, [32]], ["SELECT '?' FROM foo WHERE bar = ?", [32]],
['SELECT `?` FROM foo WHERE bar = ?', true, [32]], // Ticket DBAL-552 ['SELECT `?` FROM foo WHERE bar = ?', [32]], // Ticket DBAL-552
['SELECT [?] FROM foo WHERE bar = ?', true, [32]], ['SELECT [?] FROM foo WHERE bar = ?', [32]],
['SELECT * FROM foo WHERE jsonb_exists_any(foo.bar, ARRAY[?])', true, [56]], // Ticket GH-2295 ['SELECT * FROM foo WHERE jsonb_exists_any(foo.bar, ARRAY[?])', [56]], // Ticket GH-2295
["SELECT 'Doctrine\DBAL?' FROM foo WHERE bar = ?", true, [45]], // Ticket DBAL-558 ["SELECT 'Doctrine\DBAL?' FROM foo WHERE bar = ?", [45]], // Ticket DBAL-558
['SELECT "Doctrine\DBAL?" FROM foo WHERE bar = ?', true, [45]], // Ticket DBAL-558 ['SELECT "Doctrine\DBAL?" FROM foo WHERE bar = ?', [45]], // Ticket DBAL-558
['SELECT `Doctrine\DBAL?` FROM foo WHERE bar = ?', true, [45]], // Ticket DBAL-558 ['SELECT `Doctrine\DBAL?` FROM foo WHERE bar = ?', [45]], // Ticket DBAL-558
['SELECT [Doctrine\DBAL?] FROM foo WHERE bar = ?', true, [45]], // Ticket DBAL-558 ['SELECT [Doctrine\DBAL?] FROM foo WHERE bar = ?', [45]], // Ticket DBAL-558
["SELECT * FROM FOO WHERE bar = 'it\\'s a trap? \\\\' OR bar = ?\nAND baz = \"\\\"quote\\\" me on it? \\\\\" OR baz = ?", true, [58, 104]], ["SELECT * FROM FOO WHERE bar = 'it\\'s a trap? \\\\' OR bar = ?\nAND baz = \"\\\"quote\\\" me on it? \\\\\" OR baz = ?", [58, 104]],
['SELECT * FROM foo WHERE foo = ? AND bar = ?', true, [1 => 42, 0 => 30]], // explicit keys ['SELECT * FROM foo WHERE foo = ? AND bar = ?', [1 => 42, 0 => 30]], // explicit keys
];
}
/**
* @return mixed[][]
*/
public function dataGetPlaceholderNamedPositions(): iterable
{
return [
// none
['SELECT * FROM Foo', []],
// named // named
['SELECT :foo FROM :bar', false, [7 => 'foo', 17 => 'bar']], ['SELECT :foo FROM :bar', [7 => 'foo', 17 => 'bar']],
['SELECT * FROM Foo WHERE bar IN (:name1, :name2)', false, [32 => 'name1', 40 => 'name2']], ['SELECT * FROM Foo WHERE bar IN (:name1, :name2)', [32 => 'name1', 40 => 'name2']],
['SELECT ":foo" FROM Foo WHERE bar IN (:name1, :name2)', false, [37 => 'name1', 45 => 'name2']], ['SELECT ":foo" FROM Foo WHERE bar IN (:name1, :name2)', [37 => 'name1', 45 => 'name2']],
["SELECT ':foo' FROM Foo WHERE bar IN (:name1, :name2)", false, [37 => 'name1', 45 => 'name2']], ["SELECT ':foo' FROM Foo WHERE bar IN (:name1, :name2)", [37 => 'name1', 45 => 'name2']],
['SELECT :foo_id', false, [7 => 'foo_id']], // Ticket DBAL-231 ['SELECT :foo_id', [7 => 'foo_id']], // Ticket DBAL-231
['SELECT @rank := 1', false, []], // Ticket DBAL-398 ['SELECT @rank := 1', []], // Ticket DBAL-398
['SELECT @rank := 1 AS rank, :foo AS foo FROM :bar', false, [27 => 'foo', 44 => 'bar']], // Ticket DBAL-398 ['SELECT @rank := 1 AS rank, :foo AS foo FROM :bar', [27 => 'foo', 44 => 'bar']], // Ticket DBAL-398
['SELECT * FROM Foo WHERE bar > :start_date AND baz > :start_date', false, [30 => 'start_date', 52 => 'start_date']], // Ticket GH-113 ['SELECT * FROM Foo WHERE bar > :start_date AND baz > :start_date', [30 => 'start_date', 52 => 'start_date']], // Ticket GH-113
['SELECT foo::date as date FROM Foo WHERE bar > :start_date AND baz > :start_date', false, [46 => 'start_date', 68 => 'start_date']], // Ticket GH-259 ['SELECT foo::date as date FROM Foo WHERE bar > :start_date AND baz > :start_date', [46 => 'start_date', 68 => 'start_date']], // Ticket GH-259
['SELECT `d.ns:col_name` FROM my_table d WHERE `d.date` >= :param1', false, [57 => 'param1']], // Ticket DBAL-552 ['SELECT `d.ns:col_name` FROM my_table d WHERE `d.date` >= :param1', [57 => 'param1']], // Ticket DBAL-552
['SELECT [d.ns:col_name] FROM my_table d WHERE [d.date] >= :param1', false, [57 => 'param1']], // Ticket DBAL-552 ['SELECT [d.ns:col_name] FROM my_table d WHERE [d.date] >= :param1', [57 => 'param1']], // Ticket DBAL-552
['SELECT * FROM foo WHERE jsonb_exists_any(foo.bar, ARRAY[:foo])', false, [56 => 'foo']], // Ticket GH-2295 ['SELECT * FROM foo WHERE jsonb_exists_any(foo.bar, ARRAY[:foo])', [56 => 'foo']], // Ticket GH-2295
['SELECT * FROM foo WHERE jsonb_exists_any(foo.bar, array[:foo])', false, [56 => 'foo']], ['SELECT * FROM foo WHERE jsonb_exists_any(foo.bar, array[:foo])', [56 => 'foo']],
['SELECT table.field1, ARRAY[\'3\'] FROM schema.table table WHERE table.f1 = :foo AND ARRAY[\'3\']', false, [73 => 'foo']], ['SELECT table.field1, ARRAY[\'3\'] FROM schema.table table WHERE table.f1 = :foo AND ARRAY[\'3\']', [73 => 'foo']],
['SELECT table.field1, ARRAY[\'3\']::integer[] FROM schema.table table WHERE table.f1 = :foo AND ARRAY[\'3\']::integer[]', false, [84 => 'foo']], ['SELECT table.field1, ARRAY[\'3\']::integer[] FROM schema.table table WHERE table.f1 = :foo AND ARRAY[\'3\']::integer[]', [84 => 'foo']],
['SELECT table.field1, ARRAY[:foo] FROM schema.table table WHERE table.f1 = :bar AND ARRAY[\'3\']', false, [27 => 'foo', 74 => 'bar']], ['SELECT table.field1, ARRAY[:foo] FROM schema.table table WHERE table.f1 = :bar AND ARRAY[\'3\']', [27 => 'foo', 74 => 'bar']],
['SELECT table.field1, ARRAY[:foo]::integer[] FROM schema.table table WHERE table.f1 = :bar AND ARRAY[\'3\']::integer[]', false, [27 => 'foo', 85 => 'bar']], ['SELECT table.field1, ARRAY[:foo]::integer[] FROM schema.table table WHERE table.f1 = :bar AND ARRAY[\'3\']::integer[]', [27 => 'foo', 85 => 'bar']],
[ [
<<<'SQLDATA' <<<'SQLDATA'
SELECT * FROM foo WHERE SELECT * FROM foo WHERE
...@@ -77,31 +89,45 @@ OR bar='' ...@@ -77,31 +89,45 @@ OR bar=''
OR bar=:a_param3 OR bar=:a_param3
SQLDATA SQLDATA
, ,
false,
[ [
74 => 'a_param1', 74 => 'a_param1',
91 => 'a_param2', 91 => 'a_param2',
190 => 'a_param3', 190 => 'a_param3',
], ],
], ],
["SELECT data.age AS age, data.id AS id, data.name AS name, data.id AS id FROM test_data data WHERE (data.description LIKE :condition_0 ESCAPE '\\\\') AND (data.description LIKE :condition_1 ESCAPE '\\\\') ORDER BY id ASC", false, [121 => 'condition_0', 174 => 'condition_1']], ["SELECT data.age AS age, data.id AS id, data.name AS name, data.id AS id FROM test_data data WHERE (data.description LIKE :condition_0 ESCAPE '\\\\') AND (data.description LIKE :condition_1 ESCAPE '\\\\') ORDER BY id ASC", [121 => 'condition_0', 174 => 'condition_1']],
['SELECT data.age AS age, data.id AS id, data.name AS name, data.id AS id FROM test_data data WHERE (data.description LIKE :condition_0 ESCAPE "\\\\") AND (data.description LIKE :condition_1 ESCAPE "\\\\") ORDER BY id ASC', false, [121 => 'condition_0', 174 => 'condition_1']], ['SELECT data.age AS age, data.id AS id, data.name AS name, data.id AS id FROM test_data data WHERE (data.description LIKE :condition_0 ESCAPE "\\\\") AND (data.description LIKE :condition_1 ESCAPE "\\\\") ORDER BY id ASC', [121 => 'condition_0', 174 => 'condition_1']],
['SELECT data.age AS age, data.id AS id, data.name AS name, data.id AS id FROM test_data data WHERE (data.description LIKE :condition_0 ESCAPE "\\\\") AND (data.description LIKE :condition_1 ESCAPE \'\\\\\') ORDER BY id ASC', false, [121 => 'condition_0', 174 => 'condition_1']], ['SELECT data.age AS age, data.id AS id, data.name AS name, data.id AS id FROM test_data data WHERE (data.description LIKE :condition_0 ESCAPE "\\\\") AND (data.description LIKE :condition_1 ESCAPE \'\\\\\') ORDER BY id ASC', [121 => 'condition_0', 174 => 'condition_1']],
['SELECT data.age AS age, data.id AS id, data.name AS name, data.id AS id FROM test_data data WHERE (data.description LIKE :condition_0 ESCAPE `\\\\`) AND (data.description LIKE :condition_1 ESCAPE `\\\\`) ORDER BY id ASC', false, [121 => 'condition_0', 174 => 'condition_1']], ['SELECT data.age AS age, data.id AS id, data.name AS name, data.id AS id FROM test_data data WHERE (data.description LIKE :condition_0 ESCAPE `\\\\`) AND (data.description LIKE :condition_1 ESCAPE `\\\\`) ORDER BY id ASC', [121 => 'condition_0', 174 => 'condition_1']],
['SELECT data.age AS age, data.id AS id, data.name AS name, data.id AS id FROM test_data data WHERE (data.description LIKE :condition_0 ESCAPE \'\\\\\') AND (data.description LIKE :condition_1 ESCAPE `\\\\`) ORDER BY id ASC', false, [121 => 'condition_0', 174 => 'condition_1']], ['SELECT data.age AS age, data.id AS id, data.name AS name, data.id AS id FROM test_data data WHERE (data.description LIKE :condition_0 ESCAPE \'\\\\\') AND (data.description LIKE :condition_1 ESCAPE `\\\\`) ORDER BY id ASC', [121 => 'condition_0', 174 => 'condition_1']],
["SELECT * FROM Foo WHERE (foo.bar LIKE :condition_0 ESCAPE '\') AND (foo.baz = :condition_1) AND (foo.bak LIKE :condition_2 ESCAPE '\')", false, [38 => 'condition_0', 78 => 'condition_1', 110 => 'condition_2']], ["SELECT * FROM Foo WHERE (foo.bar LIKE :condition_0 ESCAPE '\') AND (foo.baz = :condition_1) AND (foo.bak LIKE :condition_2 ESCAPE '\')", [38 => 'condition_0', 78 => 'condition_1', 110 => 'condition_2']],
]; ];
} }
/** /**
* @param int[] $expectedParamPos * @param int[] $expectedParamPos
* *
* @dataProvider dataGetPlaceholderPositions * @dataProvider dataGetPlaceholderPositionalPositions
*/ */
public function testGetPlaceholderPositions(string $query, bool $isPositional, array $expectedParamPos): void public function testGetPositionalPlaceholderPositions(string $query, array $expectedParamPos): void
{ {
$actualParamPos = SQLParserUtils::getPlaceholderPositions($query, $isPositional); $reflection = new ReflectionMethod(SQLParserUtils::class, 'getPositionalPlaceholderPositions');
self::assertEquals($expectedParamPos, $actualParamPos); $reflection->setAccessible(true);
self::assertEquals($expectedParamPos, $reflection->invoke(null, $query));
}
/**
* @param string[] $expectedParamPos
*
* @dataProvider dataGetPlaceholderNamedPositions
*/
public function testGetNamedPlaceholderPositions(string $query, array $expectedParamPos): void
{
$reflection = new ReflectionMethod(SQLParserUtils::class, 'getNamedPlaceholderPositions');
$reflection->setAccessible(true);
self::assertEquals($expectedParamPos, $reflection->invoke(null, $query));
} }
/** /**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment