Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

IBX-7355: Allowed LIKE query conditions in Criteria for joins #13

Merged
merged 2 commits into from
Jan 11, 2024
Merged

IBX-7355: Allowed LIKE query conditions in Criteria for joins #13

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff42e0b
Allowed LIKE query conditions in Criteria for joins
Steveb-p Dec 12, 2023
25f9609
Spread arguments into multiple lines
Steveb-p Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 67 additions & 61 deletions src/lib/Gateway/ExpressionVisitor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,65 +118,7 @@ public function walkComparison(Comparison $comparison)
}
$parameter = new Parameter($parameterName, $value, $type);

switch ($comparison->getOperator()) {
case Comparison::IN:
$this->parameters[] = $parameter;

return $this->expr()->in($fullColumnName, $placeholder);

case Comparison::NIN:
$this->parameters[] = $parameter;

return $this->expr()->notIn($fullColumnName, $placeholder);

case Comparison::EQ:
case Comparison::IS:
if ($this->walkValue($comparison->getValue()) === null) {
return $this->expr()->isNull($fullColumnName);
}

$this->parameters[] = $parameter;

return $this->expr()->eq($fullColumnName, $placeholder);

case Comparison::NEQ:
if ($this->walkValue($comparison->getValue()) === null) {
return $this->expr()->isNotNull($fullColumnName);
}

$this->parameters[] = $parameter;

return $this->expr()->neq($fullColumnName, $placeholder);

case Comparison::CONTAINS:
$parameter->setValue('%' . $this->escapeSpecialSQLValues($parameter) . '%');
$this->parameters[] = $parameter;

return $this->expr()->like($fullColumnName, $placeholder);

case Comparison::STARTS_WITH:
$parameter->setValue($this->escapeSpecialSQLValues($parameter) . '%');
$this->parameters[] = $parameter;

return $this->expr()->like($fullColumnName, $placeholder);

case Comparison::ENDS_WITH:
$parameter->setValue('%' . $this->escapeSpecialSQLValues($parameter));
$this->parameters[] = $parameter;

return $this->expr()->like($fullColumnName, $placeholder);

case Comparison::GT:
case Comparison::GTE:
case Comparison::LT:
case Comparison::LTE:
$this->parameters[] = $parameter;

return $this->expr()->comparison($fullColumnName, $comparison->getOperator(), $placeholder);

default:
throw new RuntimeException('Unknown comparison operator: ' . $comparison->getOperator());
}
return $this->handleComparison($comparison, $parameter, $fullColumnName, $placeholder);
}

/**
Expand Down Expand Up @@ -300,13 +242,14 @@ private function handleJoinQuery(
}

$parameter = new Parameter($parameterName, $value, $type);
$this->parameters[] = $parameter;

if (is_array($value)) {
$this->parameters[] = $parameter;

return $this->expr()->in($tableName . '.' . $field, $placeholder);
}

return $this->expr()->comparison($tableName . '.' . $field, $comparison->getOperator(), $placeholder);
return $this->handleComparison($comparison, $parameter, $tableName . '.' . $field, $placeholder);
}

private function handleSubSelectQuery(
Expand Down Expand Up @@ -379,4 +322,67 @@ private function isInheritedColumn(string $column): bool
return $this->schemaMetadata->getIdentifierColumn() !== $column
&& $this->schemaMetadata->isInheritedColumn($column);
}

private function handleComparison(Comparison $comparison, Parameter $parameter, string $fullColumnName, string $placeholder): string
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arguments in separate lines for readability would be nice.

{
switch ($comparison->getOperator()) {
case Comparison::IN:
$this->parameters[] = $parameter;

return $this->expr()->in($fullColumnName, $placeholder);

case Comparison::NIN:
$this->parameters[] = $parameter;

return $this->expr()->notIn($fullColumnName, $placeholder);

case Comparison::EQ:
case Comparison::IS:
if ($this->walkValue($comparison->getValue()) === null) {
return $this->expr()->isNull($fullColumnName);
}

$this->parameters[] = $parameter;

return $this->expr()->eq($fullColumnName, $placeholder);

case Comparison::NEQ:
if ($this->walkValue($comparison->getValue()) === null) {
return $this->expr()->isNotNull($fullColumnName);
}

$this->parameters[] = $parameter;

return $this->expr()->neq($fullColumnName, $placeholder);

case Comparison::CONTAINS:
$parameter->setValue('%' . $this->escapeSpecialSQLValues($parameter) . '%');
$this->parameters[] = $parameter;

return $this->expr()->like($fullColumnName, $placeholder);

case Comparison::STARTS_WITH:
$parameter->setValue($this->escapeSpecialSQLValues($parameter) . '%');
$this->parameters[] = $parameter;

return $this->expr()->like($fullColumnName, $placeholder);

case Comparison::ENDS_WITH:
$parameter->setValue('%' . $this->escapeSpecialSQLValues($parameter));
$this->parameters[] = $parameter;

return $this->expr()->like($fullColumnName, $placeholder);

case Comparison::GT:
case Comparison::GTE:
case Comparison::LT:
case Comparison::LTE:
$this->parameters[] = $parameter;

return $this->expr()->comparison($fullColumnName, $comparison->getOperator(), $placeholder);

default:
throw new RuntimeException('Unknown comparison operator: ' . $comparison->getOperator());
}
}
}
38 changes: 35 additions & 3 deletions tests/bundle/Gateway/ExpressionVisitorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,9 +224,14 @@ public function testFieldFromSubSelectRelationship(): void

/**
* @dataProvider provideForFieldFromInheritedRelationship
*
* @phpstan-param array<\Ibexa\CorePersistence\Gateway\Parameter> $parameters
*/
public function testFieldFromInheritedRelationship(Comparison $comparison, string $expectedResult): void
{
public function testFieldFromInheritedRelationship(
Comparison $comparison,
string $expectedResult,
array $parameters
): void {
/** @var class-string $relationshipClass pretend it's a class-string */
$relationshipClass = 'relationship_class';
$doctrineRelationship = new DoctrineOneToManyRelationship(
Expand Down Expand Up @@ -254,26 +259,53 @@ public function testFieldFromInheritedRelationship(Comparison $comparison, strin
$expectedResult,
$result,
);

self::assertEquals($parameters, $this->expressionVisitor->getParameters());
}

/**
* @return iterable<array{\Doctrine\Common\Collections\Expr\Comparison, non-empty-string}>
* @return iterable<array{
* \Doctrine\Common\Collections\Expr\Comparison,
* non-empty-string,
* array<\Ibexa\CorePersistence\Gateway\Parameter>,
* }>
*/
public static function provideForFieldFromInheritedRelationship(): iterable
{
yield [
new Comparison('relationship_1.field', '=', 'value'),
'relationship_table_name.field = :field_0',
[new Parameter('field_0', 'value', 0)],
];

yield [
new Comparison('relationship_1.field', 'IN', ['value', 'value_2']),
'relationship_table_name.field IN (:field_0)',
[new Parameter('field_0', ['value', 'value_2'], 100)],
];

yield [
new Comparison('relationship_1.field', '=', ['value', 'value_2']),
'relationship_table_name.field IN (:field_0)',
[new Parameter('field_0', ['value', 'value_2'], 100)],
];

yield [
new Comparison('relationship_1.field', 'STARTS_WITH', 'value'),
'relationship_table_name.field LIKE :field_0',
[new Parameter('field_0', 'value%', 0)],
];

yield [
new Comparison('relationship_1.field', 'ENDS_WITH', 'value'),
'relationship_table_name.field LIKE :field_0',
[new Parameter('field_0', '%value', 0)],
];

yield [
new Comparison('relationship_1.field', 'CONTAINS', 'value'),
'relationship_table_name.field LIKE :field_0',
[new Parameter('field_0', '%value%', 0)],
];
}

Expand Down
2 changes: 1 addition & 1 deletion tests/integration/Gateway/ExpressionVisitorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public static function provideForTraversingRelationships(): iterable
'IN',
'bar',
),
'relationship_2_table_name.relationship_2_foo IN :relationship_2_foo_0',
'relationship_2_table_name.relationship_2_foo IN (:relationship_2_foo_0)',
];

yield [
Expand Down
Loading