1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
|
<?php
declare(strict_types=1);
namespace Doctrine\Tests\ORM\Query;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Query;
use Doctrine\ORM\Query\AST\ComparisonExpression;
use Doctrine\ORM\Query\AST\ConditionalExpression;
use Doctrine\ORM\Query\AST\ConditionalFactor;
use Doctrine\ORM\Query\AST\ConditionalPrimary;
use Doctrine\ORM\Query\AST\ConditionalTerm;
use Doctrine\ORM\Query\AST\PathExpression;
use Doctrine\ORM\Query\AST\SelectStatement;
use Doctrine\ORM\Query\AST\WhereClause;
use Doctrine\ORM\Query\QueryException;
use Doctrine\ORM\Query\SqlOutputWalker;
use Doctrine\ORM\Query\SqlWalker;
use Doctrine\ORM\Query\TreeWalker;
use Doctrine\ORM\Query\TreeWalkerAdapter;
use Doctrine\Tests\Mocks\CustomTreeWalkerJoin;
use Doctrine\Tests\Models\CMS\CmsUser;
use Doctrine\Tests\OrmTestCase;
use PHPUnit\Framework\Attributes\RequiresPhpunit;
use function array_merge;
use function count;
/**
* Test case for custom AST walking and modification.
*
* @link http://www.doctrine-project.org
*/
#[RequiresPhpunit('< 12')]
class CustomTreeWalkersTest extends OrmTestCase
{
private EntityManagerInterface $entityManager;
protected function setUp(): void
{
$this->entityManager = $this->getTestEntityManager();
}
/**
* @param list<class-string<TreeWalker>> $treeWalkers
* @param class-string<SqlWalker>|null $outputWalker
*/
public function generateSql(string $dqlToBeTested, array $treeWalkers, string|null $outputWalker): string
{
$query = $this->entityManager->createQuery($dqlToBeTested);
$query->setHint(Query::HINT_CUSTOM_TREE_WALKERS, $treeWalkers)
->useQueryCache(false);
if ($outputWalker) {
$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, $outputWalker);
}
return $query->getSql();
}
/**
* @param list<class-string<TreeWalker>> $treeWalkers
* @param class-string<SqlWalker>|null $outputWalker
*/
public function assertSqlGeneration(
string $dqlToBeTested,
string $sqlToBeConfirmed,
array $treeWalkers = [],
string|null $outputWalker = null,
): void {
self::assertEquals($sqlToBeConfirmed, $this->generateSql($dqlToBeTested, $treeWalkers, $outputWalker));
}
public function testSupportsQueriesWithoutWhere(): void
{
$this->assertSqlGeneration(
'select u from Doctrine\Tests\Models\CMS\CmsUser u',
'SELECT c0_.id AS id_0, c0_.status AS status_1, c0_.username AS username_2, c0_.name AS name_3, c0_.email_id AS email_id_4 FROM cms_users c0_ WHERE c0_.id = 1',
[CustomTreeWalker::class],
);
}
public function testSupportsQueriesWithMultipleConditionalExpressions(): void
{
$this->assertSqlGeneration(
'select u from Doctrine\Tests\Models\CMS\CmsUser u where u.name = :name or u.name = :otherName',
'SELECT c0_.id AS id_0, c0_.status AS status_1, c0_.username AS username_2, c0_.name AS name_3, c0_.email_id AS email_id_4 FROM cms_users c0_ WHERE (c0_.name = ? OR c0_.name = ?) AND c0_.id = 1',
[CustomTreeWalker::class],
);
}
public function testSupportsQueriesWithSimpleConditionalExpression(): void
{
$this->assertSqlGeneration(
'select u from Doctrine\Tests\Models\CMS\CmsUser u where u.name = :name',
'SELECT c0_.id AS id_0, c0_.status AS status_1, c0_.username AS username_2, c0_.name AS name_3, c0_.email_id AS email_id_4 FROM cms_users c0_ WHERE c0_.name = ? AND c0_.id = 1',
[CustomTreeWalker::class],
);
}
public function testSetUnknownQueryComponentThrowsException(): void
{
$this->expectException(QueryException::class);
$this->expectExceptionMessage("Invalid query component given for DQL alias 'x', requires 'metadata', 'parent', 'relation', 'map', 'nestingLevel' and 'token' keys.");
$this->generateSql(
'select u from Doctrine\Tests\Models\CMS\CmsUser u',
[],
AddUnknownQueryComponentWalker::class,
);
}
public function testSupportsSeveralHintsQueries(): void
{
$this->assertSqlGeneration(
'select u from Doctrine\Tests\Models\CMS\CmsUser u',
'SELECT c0_.id AS id_0, c0_.status AS status_1, c0_.username AS username_2, c0_.name AS name_3, c1_.id AS id_4, c1_.country AS country_5, c1_.zip AS zip_6, c1_.city AS city_7, c0_.email_id AS email_id_8, c1_.user_id AS user_id_9 FROM cms_users c0_ LEFT JOIN cms_addresses c1_ ON c0_.id = c1_.user_id WHERE c0_.id = 1',
[CustomTreeWalkerJoin::class, CustomTreeWalker::class],
);
}
}
class AddUnknownQueryComponentWalker extends SqlOutputWalker
{
protected function createSqlForFinalizer(SelectStatement $selectStatement): string
{
$this->setQueryComponent('x', []);
return parent::createSqlForFinalizer($selectStatement);
}
}
class CustomTreeWalker extends TreeWalkerAdapter
{
public function walkSelectStatement(SelectStatement $selectStatement): void
{
// Get the DQL aliases of all the classes we want to modify
$dqlAliases = [];
foreach ($this->getQueryComponents() as $dqlAlias => $comp) {
// Hard-coded check just for demonstration: We want to modify the query if
// it involves the CmsUser class.
if ($comp['metadata']->name === CmsUser::class) {
$dqlAliases[] = $dqlAlias;
}
}
// Create our conditions for all involved classes
$factors = [];
foreach ($dqlAliases as $alias) {
$pathExpr = new PathExpression(PathExpression::TYPE_STATE_FIELD, $alias, 'id');
$pathExpr->type = PathExpression::TYPE_STATE_FIELD;
$comparisonExpr = new ComparisonExpression($pathExpr, '=', '1');
$condPrimary = new ConditionalPrimary();
$condPrimary->simpleConditionalExpression = $comparisonExpr;
$factor = new ConditionalFactor($condPrimary);
$factors[] = $factor;
}
$whereClause = $selectStatement->whereClause;
if ($whereClause !== null) {
// There is already a WHERE clause, so append the conditions
$condExpr = $whereClause->conditionalExpression;
// Since Phase 1 AST optimizations were included, we need to re-add the ConditionalExpression
if (! ($condExpr instanceof ConditionalExpression)) {
$condExpr = new ConditionalExpression([$condExpr]);
$whereClause->conditionalExpression = $condExpr;
}
$existingTerms = $whereClause->conditionalExpression->conditionalTerms;
if (count($existingTerms) > 1) {
// More than one term, so we need to wrap all these terms in a single root term
// i.e: "WHERE u.name = :foo or u.other = :bar" => "WHERE (u.name = :foo or u.other = :bar) AND <our condition>"
$primary = new ConditionalPrimary();
$primary->conditionalExpression = new ConditionalExpression($existingTerms);
$existingFactor = new ConditionalFactor($primary);
$term = new ConditionalTerm([...[$existingFactor], ...$factors]);
$selectStatement->whereClause->conditionalExpression->conditionalTerms = [$term];
} else {
// Just one term so we can simply append our factors to that term
$singleTerm = $selectStatement->whereClause->conditionalExpression->conditionalTerms[0];
// Since Phase 1 AST optimizations were included, we need to re-add the ConditionalExpression
if (! ($singleTerm instanceof ConditionalTerm)) {
$singleTerm = new ConditionalTerm([$singleTerm]);
$selectStatement->whereClause->conditionalExpression->conditionalTerms[0] = $singleTerm;
}
$singleTerm->conditionalFactors = array_merge($singleTerm->conditionalFactors, $factors);
$selectStatement->whereClause->conditionalExpression->conditionalTerms = [$singleTerm];
}
} else {
// Create a new WHERE clause with our factors
$term = new ConditionalTerm($factors);
$condExpr = new ConditionalExpression([$term]);
$whereClause = new WhereClause($condExpr);
$selectStatement->whereClause = $whereClause;
}
}
}
|