Symfony Profiler

<?php
declare(strict_types=1);
namespace Doctrine\ORM\Query;
use BadMethodCallException;
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\LockMode;
use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Types\Type;
use Doctrine\Deprecations\Deprecation;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Mapping\ClassMetadata;
use Doctrine\ORM\Mapping\QuoteStrategy;
use Doctrine\ORM\OptimisticLockException;
use Doctrine\ORM\Query;
use Doctrine\ORM\Utility\HierarchyDiscriminatorResolver;
use Doctrine\ORM\Utility\PersisterHelper;
use InvalidArgumentException;
use LogicException;
use function array_diff;
use function array_filter;
use function array_keys;
use function array_map;
use function array_merge;
use function assert;
use function count;
use function implode;
use function in_array;
use function is_array;
use function is_float;
use function is_numeric;
use function is_string;
use function preg_match;
use function reset;
use function sprintf;
use function strtolower;
use function strtoupper;
use function trim;
/**
* The SqlWalker walks over a DQL AST and constructs the corresponding SQL.
*
* @phpstan-import-type QueryComponent from Parser
* @phpstan-consistent-constructor
*/
class SqlWalker implements TreeWalker
{
public const HINT_DISTINCT = 'doctrine.distinct';
/**
* Used to mark a query as containing a PARTIAL expression, which needs to be known by SLC.
*/
public const HINT_PARTIAL = 'doctrine.partial';
/** @var ResultSetMapping */
private $rsm;
/**
* Counter for generating unique column aliases.
*
* @var int
*/
private $aliasCounter = 0;
/**
* Counter for generating unique table aliases.
*
* @var int
*/
private $tableAliasCounter = 0;
/**
* Counter for generating unique scalar result.
*
* @var int
*/
private $scalarResultCounter = 1;
/**
* Counter for generating unique parameter indexes.
*
* @var int
*/
private $sqlParamIndex = 0;
/**
* Counter for generating indexes.
*
* @var int
*/
private $newObjectCounter = 0;
/** @var ParserResult */
private $parserResult;
/** @var EntityManagerInterface */
private $em;
/** @var Connection */
private $conn;
/** @var Query */
private $query;
/** @var mixed[] */
private $tableAliasMap = [];
/**
* Map from result variable names to their SQL column alias names.
*
* @phpstan-var array<string|int, string|list<string>>
*/
private $scalarResultAliasMap = [];
/**
* Map from Table-Alias + Column-Name to OrderBy-Direction.
*
* @var array<string, string>
*/
private $orderedColumnsMap = [];
/**
* Map from DQL-Alias + Field-Name to SQL Column Alias.
*
* @var array<string, array<string, string>>
*/
private $scalarFields = [];
/**
* Map of all components/classes that appear in the DQL query.
*
* @phpstan-var array<string, QueryComponent>
*/
private $queryComponents;
/**
* A list of classes that appear in non-scalar SelectExpressions.
*
* @phpstan-var array<string, array{class: ClassMetadata, dqlAlias: string, resultAlias: string|null}>
*/
private $selectedClasses = [];
/**
* The DQL alias of the root class of the currently traversed query.
*
* @phpstan-var list<string>
*/
private $rootAliases = [];
/**
* Flag that indicates whether to generate SQL table aliases in the SQL.
* These should only be generated for SELECT queries, not for UPDATE/DELETE.
*
* @var bool
*/
private $useSqlTableAliases = true;
/**
* The database platform abstraction.
*
* @var AbstractPlatform
*/
private $platform;
/**
* The quote strategy.
*
* @var QuoteStrategy
*/
private $quoteStrategy;
/**
* @param Query $query The parsed Query.
* @param ParserResult $parserResult The result of the parsing process.
* @phpstan-param array<string, QueryComponent> $queryComponents The query components (symbol table).
*/
public function __construct($query, $parserResult, array $queryComponents)
{
$this->query = $query;
$this->parserResult = $parserResult;
$this->queryComponents = $queryComponents;
$this->rsm = $parserResult->getResultSetMapping();
$this->em = $query->getEntityManager();
$this->conn = $this->em->getConnection();
$this->platform = $this->conn->getDatabasePlatform();
$this->quoteStrategy = $this->em->getConfiguration()->getQuoteStrategy();
}
/**
* Gets the Query instance used by the walker.
*
* @return Query
*/
public function getQuery()
{
return $this->query;
}
/**
* Gets the Connection used by the walker.
*
* @return Connection
*/
public function getConnection()
{
return $this->conn;
}
/**
* Gets the EntityManager used by the walker.
*
* @return EntityManagerInterface
*/
public function getEntityManager()
{
return $this->em;
}
/**
* Gets the information about a single query component.
*
* @param string $dqlAlias The DQL alias.
*
* @return mixed[]
* @phpstan-return QueryComponent
*/
public function getQueryComponent($dqlAlias)
{
return $this->queryComponents[$dqlAlias];
}
public function getMetadataForDqlAlias(string $dqlAlias): ClassMetadata
{
if (! isset($this->queryComponents[$dqlAlias]['metadata'])) {
throw new LogicException(sprintf('No metadata for DQL alias: %s', $dqlAlias));
}
return $this->queryComponents[$dqlAlias]['metadata'];
}
/**
* Returns internal queryComponents array.
*
* @return array<string, QueryComponent>
*/
public function getQueryComponents()
{
return $this->queryComponents;
}
/**
* Sets or overrides a query component for a given dql alias.
*
* @param string $dqlAlias The DQL alias.
* @phpstan-param QueryComponent $queryComponent
*
* @return void
*
* @not-deprecated
*/
public function setQueryComponent($dqlAlias, array $queryComponent)
{
$requiredKeys = ['metadata', 'parent', 'relation', 'map', 'nestingLevel', 'token'];
if (array_diff($requiredKeys, array_keys($queryComponent))) {
throw QueryException::invalidQueryComponent($dqlAlias);
}
$this->queryComponents[$dqlAlias] = $queryComponent;
}
/**
* Gets an executor that can be used to execute the result of this walker.
*
* @deprecated Output walkers should no longer create the executor directly, but instead provide
* a SqlFinalizer by implementing the `OutputWalker` interface. Thus, this method is
* no longer needed and will be removed in 4.0.
*
* @param AST\DeleteStatement|AST\UpdateStatement|AST\SelectStatement $AST
*
* @return Exec\AbstractSqlExecutor
*/
public function getExecutor($AST)
{
switch (true) {
case $AST instanceof AST\DeleteStatement:
return $this->createDeleteStatementExecutor($AST);
case $AST instanceof AST\UpdateStatement:
return $this->createUpdateStatementExecutor($AST);
default:
return new Exec\SingleSelectExecutor($AST, $this);
}
}
protected function createUpdateStatementExecutor(AST\UpdateStatement $AST): Exec\AbstractSqlExecutor
{
$primaryClass = $this->em->getClassMetadata($AST->updateClause->abstractSchemaName);
return $primaryClass->isInheritanceTypeJoined()
? new Exec\MultiTableUpdateExecutor($AST, $this)
: new Exec\SingleTableDeleteUpdateExecutor($AST, $this);
}
protected function createDeleteStatementExecutor(AST\DeleteStatement $AST): Exec\AbstractSqlExecutor
{
$primaryClass = $this->em->getClassMetadata($AST->deleteClause->abstractSchemaName);
return $primaryClass->isInheritanceTypeJoined()
? new Exec\MultiTableDeleteExecutor($AST, $this)
: new Exec\SingleTableDeleteUpdateExecutor($AST, $this);
}
/**
* Generates a unique, short SQL table alias.
*
* @param string $tableName Table name
* @param string $dqlAlias The DQL alias.
*
* @return string Generated table alias.
*/
public function getSQLTableAlias($tableName, $dqlAlias = '')
{
$tableName .= $dqlAlias ? '@[' . $dqlAlias . ']' : '';
if (! isset($this->tableAliasMap[$tableName])) {
$this->tableAliasMap[$tableName] = (preg_match('/[a-z]/i', $tableName[0]) ? strtolower($tableName[0]) : 't')
. $this->tableAliasCounter++ . '_';
}
return $this->tableAliasMap[$tableName];
}
/**
* Forces the SqlWalker to use a specific alias for a table name, rather than
* generating an alias on its own.
*
* @param string $tableName
* @param string $alias
* @param string $dqlAlias
*
* @return string
*/
public function setSQLTableAlias($tableName, $alias, $dqlAlias = '')
{
$tableName .= $dqlAlias ? '@[' . $dqlAlias . ']' : '';
$this->tableAliasMap[$tableName] = $alias;
return $alias;
}
/**
* Gets an SQL column alias for a column name.
*
* @param string $columnName
*
* @return string
*/
public function getSQLColumnAlias($columnName)
{
return $this->quoteStrategy->getColumnAlias($columnName, $this->aliasCounter++, $this->platform);
}
/**
* Generates the SQL JOINs that are necessary for Class Table Inheritance
* for the given class.
*
* @param ClassMetadata $class The class for which to generate the joins.
* @param string $dqlAlias The DQL alias of the class.
*
* @return string The SQL.
*/
private function generateClassTableInheritanceJoins(
ClassMetadata $class,
string $dqlAlias
): string {
$sql = '';
$baseTableAlias = $this->getSQLTableAlias($class->getTableName(), $dqlAlias);
// INNER JOIN parent class tables
foreach ($class->parentClasses as $parentClassName) {
$parentClass = $this->em->getClassMetadata($parentClassName);
$tableAlias = $this->getSQLTableAlias($parentClass->getTableName(), $dqlAlias);
// If this is a joined association we must use left joins to preserve the correct result.
$sql .= isset($this->queryComponents[$dqlAlias]['relation']) ? ' LEFT ' : ' INNER ';
$sql .= 'JOIN ' . $this->quoteStrategy->getTableName($parentClass, $this->platform) . ' ' . $tableAlias . ' ON ';
$sqlParts = [];
foreach ($this->quoteStrategy->getIdentifierColumnNames($class, $this->platform) as $columnName) {
$sqlParts[] = $baseTableAlias . '.' . $columnName . ' = ' . $tableAlias . '.' . $columnName;
}
// Add filters on the root class
$sqlParts[] = $this->generateFilterConditionSQL($parentClass, $tableAlias);
$sql .= implode(' AND ', array_filter($sqlParts));
}
// Ignore subclassing inclusion if partial objects is disallowed
if ($this->query->getHint(Query::HINT_FORCE_PARTIAL_LOAD)) {
return $sql;
}
// LEFT JOIN child class tables
foreach ($class->subClasses as $subClassName) {
$subClass = $this->em->getClassMetadata($subClassName);
$tableAlias = $this->getSQLTableAlias($subClass->getTableName(), $dqlAlias);
$sql .= ' LEFT JOIN ' . $this->quoteStrategy->getTableName($subClass, $this->platform) . ' ' . $tableAlias . ' ON ';
$sqlParts = [];
foreach ($this->quoteStrategy->getIdentifierColumnNames($subClass, $this->platform) as $columnName) {
$sqlParts[] = $baseTableAlias . '.' . $columnName . ' = ' . $tableAlias . '.' . $columnName;
}
$sql .= implode(' AND ', $sqlParts);
}
return $sql;
}
private function generateOrderedCollectionOrderByItems(): string
{
$orderedColumns = [];
foreach ($this->selectedClasses as $selectedClass) {
$dqlAlias = $selectedClass['dqlAlias'];
$qComp = $this->queryComponents[$dqlAlias];
if (! isset($qComp['relation']['orderBy'])) {
continue;
}
assert(isset($qComp['metadata']));
$persister = $this->em->getUnitOfWork()->getEntityPersister($qComp['metadata']->name);
foreach ($qComp['relation']['orderBy'] as $fieldName => $orientation) {
$columnName = $this->quoteStrategy->getColumnName($fieldName, $qComp['metadata'], $this->platform);
$tableName = $qComp['metadata']->isInheritanceTypeJoined()
? $persister->getOwningTable($fieldName)
: $qComp['metadata']->getTableName();
$orderedColumn = $this->getSQLTableAlias($tableName, $dqlAlias) . '.' . $columnName;
// OrderByClause should replace an ordered relation. see - DDC-2475
if (isset($this->orderedColumnsMap[$orderedColumn])) {
continue;
}
$this->orderedColumnsMap[$orderedColumn] = $orientation;
$orderedColumns[] = $orderedColumn . ' ' . $orientation;
}
}
return implode(', ', $orderedColumns);
}
/**
* Generates a discriminator column SQL condition for the class with the given DQL alias.
*
* @phpstan-param list<string> $dqlAliases List of root DQL aliases to inspect for discriminator restrictions.
*/
private function generateDiscriminatorColumnConditionSQL(array $dqlAliases): string
{
$sqlParts = [];
foreach ($dqlAliases as $dqlAlias) {
$class = $this->getMetadataForDqlAlias($dqlAlias);
if (! $class->isInheritanceTypeSingleTable()) {
continue;
}
$sqlTableAlias = $this->useSqlTableAliases
? $this->getSQLTableAlias($class->getTableName(), $dqlAlias) . '.'
: '';
$conn = $this->em->getConnection();
$values = [];
if ($class->discriminatorValue !== null) { // discriminators can be 0
$values[] = $conn->quote($class->discriminatorValue);
}
foreach ($class->subClasses as $subclassName) {
$subclassMetadata = $this->em->getClassMetadata($subclassName);
// Abstract entity classes show up in the list of subClasses, but may be omitted
// from the discriminator map. In that case, they have a null discriminator value.
if ($subclassMetadata->discriminatorValue === null) {
continue;
}
$values[] = $conn->quote($subclassMetadata->discriminatorValue);
}
if ($values !== []) {
$sqlParts[] = $sqlTableAlias . $class->getDiscriminatorColumn()['name'] . ' IN (' . implode(', ', $values) . ')';
} else {
$sqlParts[] = '1=0'; // impossible condition
}
}
$sql = implode(' AND ', $sqlParts);
return count($sqlParts) > 1 ? '(' . $sql . ')' : $sql;
}
/**
* Generates the filter SQL for a given entity and table alias.
*
* @param ClassMetadata $targetEntity Metadata of the target entity.
* @param string $targetTableAlias The table alias of the joined/selected table.
*
* @return string The SQL query part to add to a query.
*/
private function generateFilterConditionSQL(
ClassMetadata $targetEntity,
string $targetTableAlias
): string {
if (! $this->em->hasFilters()) {
return '';
}
switch ($targetEntity->inheritanceType) {
case ClassMetadata::INHERITANCE_TYPE_NONE:
break;
case ClassMetadata::INHERITANCE_TYPE_JOINED:
// The classes in the inheritance will be added to the query one by one,
// but only the root node is getting filtered
if ($targetEntity->name !== $targetEntity->rootEntityName) {
return '';
}
break;
case ClassMetadata::INHERITANCE_TYPE_SINGLE_TABLE:
// With STI the table will only be queried once, make sure that the filters
// are added to the root entity
$targetEntity = $this->em->getClassMetadata($targetEntity->rootEntityName);
break;
default:
//@todo: throw exception?
return '';
}
$filterClauses = [];
foreach ($this->em->getFilters()->getEnabledFilters() as $filter) {
$filterExpr = $filter->addFilterConstraint($targetEntity, $targetTableAlias);
if ($filterExpr !== '') {
$filterClauses[] = '(' . $filterExpr . ')';
}
}
return implode(' AND ', $filterClauses);
}
/**
* Walks down a SelectStatement AST node, thereby generating the appropriate SQL.
*
* @return string
*/
public function walkSelectStatement(AST\SelectStatement $AST)
{
$sql = $this->createSqlForFinalizer($AST);
$finalizer = new Exec\SingleSelectSqlFinalizer($sql);
return $finalizer->finalizeSql($this->query);
}
protected function createSqlForFinalizer(AST\SelectStatement $AST): string
{
$sql = $this->walkSelectClause($AST->selectClause)
. $this->walkFromClause($AST->fromClause)
. $this->walkWhereClause($AST->whereClause);
if ($AST->groupByClause) {
$sql .= $this->walkGroupByClause($AST->groupByClause);
}
if ($AST->havingClause) {
$sql .= $this->walkHavingClause($AST->havingClause);
}
if ($AST->orderByClause) {
$sql .= $this->walkOrderByClause($AST->orderByClause);
}
$orderBySql = $this->generateOrderedCollectionOrderByItems();
if (! $AST->orderByClause && $orderBySql) {
$sql .= ' ORDER BY ' . $orderBySql;
}
$this->assertOptimisticLockingHasAllClassesVersioned();
return $sql;
}
private function assertOptimisticLockingHasAllClassesVersioned(): void
{
$lockMode = $this->query->getHint(Query::HINT_LOCK_MODE) ?: LockMode::NONE;
if ($lockMode === LockMode::OPTIMISTIC) {
foreach ($this->selectedClasses as $selectedClass) {
if (! $selectedClass['class']->isVersioned) {
throw OptimisticLockException::lockFailed($selectedClass['class']->name);
}
}
}
}
/**
* Walks down an UpdateStatement AST node, thereby generating the appropriate SQL.
*
* @return string
*/
public function walkUpdateStatement(AST\UpdateStatement $AST)
{
$this->useSqlTableAliases = false;
$this->rsm->isSelect = false;
return $this->walkUpdateClause($AST->updateClause)
. $this->walkWhereClause($AST->whereClause);
}
/**
* Walks down a DeleteStatement AST node, thereby generating the appropriate SQL.
*
* @return string
*/
public function walkDeleteStatement(AST\DeleteStatement $AST)
{
$this->useSqlTableAliases = false;
$this->rsm->isSelect = false;
return $this->walkDeleteClause($AST->deleteClause)
. $this->walkWhereClause($AST->whereClause);
}
/**
* Walks down an IdentificationVariable AST node, thereby generating the appropriate SQL.
* This one differs of ->walkIdentificationVariable() because it generates the entity identifiers.
*
* @param string $identVariable
*
* @return string
*
* @not-deprecated
*/
public function walkEntityIdentificationVariable($identVariable)
{
$class = $this->getMetadataForDqlAlias($identVariable);
$tableAlias = $this->getSQLTableAlias($class->getTableName(), $identVariable);
$sqlParts = [];
foreach ($this->quoteStrategy->getIdentifierColumnNames($class, $this->platform) as $columnName) {
$sqlParts[] = $tableAlias . '.' . $columnName;
}
return implode(', ', $sqlParts);
}
/**
* Walks down an IdentificationVariable (no AST node associated), thereby generating the SQL.
*
* @param string $identificationVariable
* @param string $fieldName
*
* @return string The SQL.
*
* @not-deprecated
*/
public function walkIdentificationVariable($identificationVariable, $fieldName = null)
{
$class = $this->getMetadataForDqlAlias($identificationVariable);
if (
$fieldName !== null && $class->isInheritanceTypeJoined() &&
isset($class->fieldMappings[$fieldName]['inherited'])
) {
$class = $this->em->getClassMetadata($class->fieldMappings[$fieldName]['inherited']);
}
return $this->getSQLTableAlias($class->getTableName(), $identificationVariable);
}
/**
* Walks down a PathExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\PathExpression $pathExpr
*
* @return string
*
* @not-deprecated
*/
public function walkPathExpression($pathExpr)
{
$sql = '';
assert($pathExpr->field !== null);
switch ($pathExpr->type) {
case AST\PathExpression::TYPE_STATE_FIELD:
$fieldName = $pathExpr->field;
$dqlAlias = $pathExpr->identificationVariable;
$class = $this->getMetadataForDqlAlias($dqlAlias);
if ($this->useSqlTableAliases) {
$sql .= $this->walkIdentificationVariable($dqlAlias, $fieldName) . '.';
}
$sql .= $this->quoteStrategy->getColumnName($fieldName, $class, $this->platform);
break;
case AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION:
// 1- the owning side:
// Just use the foreign key, i.e. u.group_id
$fieldName = $pathExpr->field;
$dqlAlias = $pathExpr->identificationVariable;
$class = $this->getMetadataForDqlAlias($dqlAlias);
if (isset($class->associationMappings[$fieldName]['inherited'])) {
$class = $this->em->getClassMetadata($class->associationMappings[$fieldName]['inherited']);
}
$assoc = $class->associationMappings[$fieldName];
if (! $assoc['isOwningSide']) {
throw QueryException::associationPathInverseSideNotSupported($pathExpr);
}
// COMPOSITE KEYS NOT (YET?) SUPPORTED
if (count($assoc['sourceToTargetKeyColumns']) > 1) {
throw QueryException::associationPathCompositeKeyNotSupported();
}
if ($this->useSqlTableAliases) {
$sql .= $this->getSQLTableAlias($class->getTableName(), $dqlAlias) . '.';
}
$sql .= reset($assoc['targetToSourceKeyColumns']);
break;
default:
throw QueryException::invalidPathExpression($pathExpr);
}
return $sql;
}
/**
* Walks down a SelectClause AST node, thereby generating the appropriate SQL.
*
* @param AST\SelectClause $selectClause
*
* @return string
*
* @not-deprecated
*/
public function walkSelectClause($selectClause)
{
$sql = 'SELECT ' . ($selectClause->isDistinct ? 'DISTINCT ' : '');
$sqlSelectExpressions = array_filter(array_map([$this, 'walkSelectExpression'], $selectClause->selectExpressions));
if ($this->query->getHint(Query::HINT_INTERNAL_ITERATION) === true && $selectClause->isDistinct) {
$this->query->setHint(self::HINT_DISTINCT, true);
}
$addMetaColumns = ! $this->query->getHint(Query::HINT_FORCE_PARTIAL_LOAD) &&
$this->query->getHydrationMode() === Query::HYDRATE_OBJECT
|| $this->query->getHint(Query::HINT_INCLUDE_META_COLUMNS);
foreach ($this->selectedClasses as $selectedClass) {
$class = $selectedClass['class'];
$dqlAlias = $selectedClass['dqlAlias'];
$resultAlias = $selectedClass['resultAlias'];
// Register as entity or joined entity result
if (! isset($this->queryComponents[$dqlAlias]['relation'])) {
$this->rsm->addEntityResult($class->name, $dqlAlias, $resultAlias);
} else {
assert(isset($this->queryComponents[$dqlAlias]['parent']));
$this->rsm->addJoinedEntityResult(
$class->name,
$dqlAlias,
$this->queryComponents[$dqlAlias]['parent'],
$this->queryComponents[$dqlAlias]['relation']['fieldName']
);
}
if ($class->isInheritanceTypeSingleTable() || $class->isInheritanceTypeJoined()) {
// Add discriminator columns to SQL
$rootClass = $this->em->getClassMetadata($class->rootEntityName);
$tblAlias = $this->getSQLTableAlias($rootClass->getTableName(), $dqlAlias);
$discrColumn = $rootClass->getDiscriminatorColumn();
$columnAlias = $this->getSQLColumnAlias($discrColumn['name']);
$sqlSelectExpressions[] = $tblAlias . '.' . $discrColumn['name'] . ' AS ' . $columnAlias;
$this->rsm->setDiscriminatorColumn($dqlAlias, $columnAlias);
$this->rsm->addMetaResult($dqlAlias, $columnAlias, $discrColumn['fieldName'], false, $discrColumn['type']);
if (! empty($discrColumn['enumType'])) {
$this->rsm->addEnumResult($columnAlias, $discrColumn['enumType']);
}
}
// Add foreign key columns to SQL, if necessary
if (! $addMetaColumns && ! $class->containsForeignIdentifier) {
continue;
}
// Add foreign key columns of class and also parent classes
foreach ($class->associationMappings as $assoc) {
if (
! ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE)
|| ( ! $addMetaColumns && ! isset($assoc['id']))
) {
continue;
}
$targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
$isIdentifier = (isset($assoc['id']) && $assoc['id'] === true);
$owningClass = isset($assoc['inherited']) ? $this->em->getClassMetadata($assoc['inherited']) : $class;
$sqlTableAlias = $this->getSQLTableAlias($owningClass->getTableName(), $dqlAlias);
foreach ($assoc['joinColumns'] as $joinColumn) {
$columnName = $joinColumn['name'];
$columnAlias = $this->getSQLColumnAlias($columnName);
$columnType = PersisterHelper::getTypeOfColumn($joinColumn['referencedColumnName'], $targetClass, $this->em);
$quotedColumnName = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
$sqlSelectExpressions[] = $sqlTableAlias . '.' . $quotedColumnName . ' AS ' . $columnAlias;
$this->rsm->addMetaResult($dqlAlias, $columnAlias, $columnName, $isIdentifier, $columnType);
}
}
// Add foreign key columns to SQL, if necessary
if (! $addMetaColumns) {
continue;
}
// Add foreign key columns of subclasses
foreach ($class->subClasses as $subClassName) {
$subClass = $this->em->getClassMetadata($subClassName);
$sqlTableAlias = $this->getSQLTableAlias($subClass->getTableName(), $dqlAlias);
foreach ($subClass->associationMappings as $assoc) {
// Skip if association is inherited
if (isset($assoc['inherited'])) {
continue;
}
if ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE) {
$targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
foreach ($assoc['joinColumns'] as $joinColumn) {
$columnName = $joinColumn['name'];
$columnAlias = $this->getSQLColumnAlias($columnName);
$columnType = PersisterHelper::getTypeOfColumn($joinColumn['referencedColumnName'], $targetClass, $this->em);
$quotedColumnName = $this->quoteStrategy->getJoinColumnName($joinColumn, $subClass, $this->platform);
$sqlSelectExpressions[] = $sqlTableAlias . '.' . $quotedColumnName . ' AS ' . $columnAlias;
$this->rsm->addMetaResult($dqlAlias, $columnAlias, $columnName, $subClass->isIdentifier($columnName), $columnType);
}
}
}
}
}
return $sql . implode(', ', $sqlSelectExpressions);
}
/**
* Walks down a FromClause AST node, thereby generating the appropriate SQL.
*
* @param AST\FromClause $fromClause
*
* @return string
*
* @not-deprecated
*/
public function walkFromClause($fromClause)
{
$identificationVarDecls = $fromClause->identificationVariableDeclarations;
$sqlParts = [];
foreach ($identificationVarDecls as $identificationVariableDecl) {
$sqlParts[] = $this->walkIdentificationVariableDeclaration($identificationVariableDecl);
}
return ' FROM ' . implode(', ', $sqlParts);
}
/**
* Walks down a IdentificationVariableDeclaration AST node, thereby generating the appropriate SQL.
*
* @param AST\IdentificationVariableDeclaration $identificationVariableDecl
*
* @return string
*
* @not-deprecated
*/
public function walkIdentificationVariableDeclaration($identificationVariableDecl)
{
$sql = $this->walkRangeVariableDeclaration($identificationVariableDecl->rangeVariableDeclaration);
if ($identificationVariableDecl->indexBy) {
$this->walkIndexBy($identificationVariableDecl->indexBy);
}
foreach ($identificationVariableDecl->joins as $join) {
$sql .= $this->walkJoin($join);
}
return $sql;
}
/**
* Walks down a IndexBy AST node.
*
* @param AST\IndexBy $indexBy
*
* @return void
*
* @not-deprecated
*/
public function walkIndexBy($indexBy)
{
$pathExpression = $indexBy->singleValuedPathExpression;
$alias = $pathExpression->identificationVariable;
assert($pathExpression->field !== null);
switch ($pathExpression->type) {
case AST\PathExpression::TYPE_STATE_FIELD:
$field = $pathExpression->field;
break;
case AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION:
// Just use the foreign key, i.e. u.group_id
$fieldName = $pathExpression->field;
$class = $this->getMetadataForDqlAlias($alias);
if (isset($class->associationMappings[$fieldName]['inherited'])) {
$class = $this->em->getClassMetadata($class->associationMappings[$fieldName]['inherited']);
}
$association = $class->associationMappings[$fieldName];
if (! $association['isOwningSide']) {
throw QueryException::associationPathInverseSideNotSupported($pathExpression);
}
if (count($association['sourceToTargetKeyColumns']) > 1) {
throw QueryException::associationPathCompositeKeyNotSupported();
}
$field = reset($association['targetToSourceKeyColumns']);
break;
default:
throw QueryException::invalidPathExpression($pathExpression);
}
if (isset($this->scalarFields[$alias][$field])) {
$this->rsm->addIndexByScalar($this->scalarFields[$alias][$field]);
return;
}
$this->rsm->addIndexBy($alias, $field);
}
/**
* Walks down a RangeVariableDeclaration AST node, thereby generating the appropriate SQL.
*
* @param AST\RangeVariableDeclaration $rangeVariableDeclaration
*
* @return string
*
* @not-deprecated
*/
public function walkRangeVariableDeclaration($rangeVariableDeclaration)
{
return $this->generateRangeVariableDeclarationSQL($rangeVariableDeclaration, false);
}
/**
* Generate appropriate SQL for RangeVariableDeclaration AST node
*/
private function generateRangeVariableDeclarationSQL(
AST\RangeVariableDeclaration $rangeVariableDeclaration,
bool $buildNestedJoins
): string {
$class = $this->em->getClassMetadata($rangeVariableDeclaration->abstractSchemaName);
$dqlAlias = $rangeVariableDeclaration->aliasIdentificationVariable;
if ($rangeVariableDeclaration->isRoot) {
$this->rootAliases[] = $dqlAlias;
}
$sql = $this->platform->appendLockHint(
$this->quoteStrategy->getTableName($class, $this->platform) . ' ' .
$this->getSQLTableAlias($class->getTableName(), $dqlAlias),
$this->query->getHint(Query::HINT_LOCK_MODE) ?: LockMode::NONE
);
if (! $class->isInheritanceTypeJoined()) {
return $sql;
}
$classTableInheritanceJoins = $this->generateClassTableInheritanceJoins($class, $dqlAlias);
if (! $buildNestedJoins) {
return $sql . $classTableInheritanceJoins;
}
return $classTableInheritanceJoins === '' ? $sql : '(' . $sql . $classTableInheritanceJoins . ')';
}
/**
* Walks down a JoinAssociationDeclaration AST node, thereby generating the appropriate SQL.
*
* @param AST\JoinAssociationDeclaration $joinAssociationDeclaration
* @param int $joinType
* @param AST\ConditionalExpression|AST\Phase2OptimizableConditional $condExpr
* @phpstan-param AST\Join::JOIN_TYPE_* $joinType
*
* @return string
*
* @throws QueryException
*
* @not-deprecated
*/
public function walkJoinAssociationDeclaration($joinAssociationDeclaration, $joinType = AST\Join::JOIN_TYPE_INNER, $condExpr = null)
{
$sql = '';
$associationPathExpression = $joinAssociationDeclaration->joinAssociationPathExpression;
$joinedDqlAlias = $joinAssociationDeclaration->aliasIdentificationVariable;
$indexBy = $joinAssociationDeclaration->indexBy;
$relation = $this->queryComponents[$joinedDqlAlias]['relation'] ?? null;
assert($relation !== null);
$targetClass = $this->em->getClassMetadata($relation['targetEntity']);
$sourceClass = $this->em->getClassMetadata($relation['sourceEntity']);
$targetTableName = $this->quoteStrategy->getTableName($targetClass, $this->platform);
$targetTableAlias = $this->getSQLTableAlias($targetClass->getTableName(), $joinedDqlAlias);
$sourceTableAlias = $this->getSQLTableAlias($sourceClass->getTableName(), $associationPathExpression->identificationVariable);
// Ensure we got the owning side, since it has all mapping info
$assoc = ! $relation['isOwningSide'] ? $targetClass->associationMappings[$relation['mappedBy']] : $relation;
if ($this->query->getHint(Query::HINT_INTERNAL_ITERATION) === true && (! $this->query->getHint(self::HINT_DISTINCT) || isset($this->selectedClasses[$joinedDqlAlias]))) {
if ($relation['type'] === ClassMetadata::ONE_TO_MANY || $relation['type'] === ClassMetadata::MANY_TO_MANY) {
throw QueryException::iterateWithFetchJoinNotAllowed($assoc);
}
}
$fetchMode = $this->query->getHint('fetchMode')[$assoc['sourceEntity']][$assoc['fieldName']] ?? $relation['fetch'];
if ($fetchMode === ClassMetadata::FETCH_EAGER && $condExpr !== null) {
throw QueryException::eagerFetchJoinWithNotAllowed($assoc['sourceEntity'], $assoc['fieldName']);
}
// This condition is not checking ClassMetadata::MANY_TO_ONE, because by definition it cannot
// be the owning side and previously we ensured that $assoc is always the owning side of the associations.
// The owning side is necessary at this point because only it contains the JoinColumn information.
switch (true) {
case $assoc['type'] & ClassMetadata::TO_ONE:
$conditions = [];
foreach ($assoc['joinColumns'] as $joinColumn) {
$quotedSourceColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $targetClass, $this->platform);
$quotedTargetColumn = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $targetClass, $this->platform);
if ($relation['isOwningSide']) {
$conditions[] = $sourceTableAlias . '.' . $quotedSourceColumn . ' = ' . $targetTableAlias . '.' . $quotedTargetColumn;
continue;
}
$conditions[] = $sourceTableAlias . '.' . $quotedTargetColumn . ' = ' . $targetTableAlias . '.' . $quotedSourceColumn;
}
// Apply remaining inheritance restrictions
$discrSql = $this->generateDiscriminatorColumnConditionSQL([$joinedDqlAlias]);
if ($discrSql) {
$conditions[] = $discrSql;
}
// Apply the filters
$filterExpr = $this->generateFilterConditionSQL($targetClass, $targetTableAlias);
if ($filterExpr) {
$conditions[] = $filterExpr;
}
$targetTableJoin = [
'table' => $targetTableName . ' ' . $targetTableAlias,
'condition' => implode(' AND ', $conditions),
];
break;
case $assoc['type'] === ClassMetadata::MANY_TO_MANY:
// Join relation table
$joinTable = $assoc['joinTable'];
$joinTableAlias = $this->getSQLTableAlias($joinTable['name'], $joinedDqlAlias);
$joinTableName = $this->quoteStrategy->getJoinTableName($assoc, $sourceClass, $this->platform);
$conditions = [];
$relationColumns = $relation['isOwningSide']
? $assoc['joinTable']['joinColumns']
: $assoc['joinTable']['inverseJoinColumns'];
foreach ($relationColumns as $joinColumn) {
$quotedSourceColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $targetClass, $this->platform);
$quotedTargetColumn = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $targetClass, $this->platform);
$conditions[] = $sourceTableAlias . '.' . $quotedTargetColumn . ' = ' . $joinTableAlias . '.' . $quotedSourceColumn;
}
$sql .= $joinTableName . ' ' . $joinTableAlias . ' ON ' . implode(' AND ', $conditions);
// Join target table
$sql .= $joinType === AST\Join::JOIN_TYPE_LEFT || $joinType === AST\Join::JOIN_TYPE_LEFTOUTER ? ' LEFT JOIN ' : ' INNER JOIN ';
$conditions = [];
$relationColumns = $relation['isOwningSide']
? $assoc['joinTable']['inverseJoinColumns']
: $assoc['joinTable']['joinColumns'];
foreach ($relationColumns as $joinColumn) {
$quotedSourceColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $targetClass, $this->platform);
$quotedTargetColumn = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $targetClass, $this->platform);
$conditions[] = $targetTableAlias . '.' . $quotedTargetColumn . ' = ' . $joinTableAlias . '.' . $quotedSourceColumn;
}
// Apply remaining inheritance restrictions
$discrSql = $this->generateDiscriminatorColumnConditionSQL([$joinedDqlAlias]);
if ($discrSql) {
$conditions[] = $discrSql;
}
// Apply the filters
$filterExpr = $this->generateFilterConditionSQL($targetClass, $targetTableAlias);
if ($filterExpr) {
$conditions[] = $filterExpr;
}
$targetTableJoin = [
'table' => $targetTableName . ' ' . $targetTableAlias,
'condition' => implode(' AND ', $conditions),
];
break;
default:
throw new BadMethodCallException('Type of association must be one of *_TO_ONE or MANY_TO_MANY');
}
// Handle WITH clause
$withCondition = $condExpr === null ? '' : ('(' . $this->walkConditionalExpression($condExpr) . ')');
if ($targetClass->isInheritanceTypeJoined()) {
$ctiJoins = $this->generateClassTableInheritanceJoins($targetClass, $joinedDqlAlias);
// If we have WITH condition, we need to build nested joins for target class table and cti joins
if ($withCondition && $ctiJoins) {
$sql .= '(' . $targetTableJoin['table'] . $ctiJoins . ') ON ' . $targetTableJoin['condition'];
} else {
$sql .= $targetTableJoin['table'] . ' ON ' . $targetTableJoin['condition'] . $ctiJoins;
}
} else {
$sql .= $targetTableJoin['table'] . ' ON ' . $targetTableJoin['condition'];
}
if ($withCondition) {
$sql .= ' AND ' . $withCondition;
}
// Apply the indexes
if ($indexBy) {
// For Many-To-One or One-To-One associations this obviously makes no sense, but is ignored silently.
$this->walkIndexBy($indexBy);
} elseif (isset($relation['indexBy'])) {
$this->rsm->addIndexBy($joinedDqlAlias, $relation['indexBy']);
}
return $sql;
}
/**
* Walks down a FunctionNode AST node, thereby generating the appropriate SQL.
*
* @param AST\Functions\FunctionNode $function
*
* @return string
*
* @not-deprecated
*/
public function walkFunction($function)
{
return $function->getSql($this);
}
/**
* Walks down an OrderByClause AST node, thereby generating the appropriate SQL.
*
* @param AST\OrderByClause $orderByClause
*
* @return string
*
* @not-deprecated
*/
public function walkOrderByClause($orderByClause)
{
$orderByItems = array_map([$this, 'walkOrderByItem'], $orderByClause->orderByItems);
$collectionOrderByItems = $this->generateOrderedCollectionOrderByItems();
if ($collectionOrderByItems !== '') {
$orderByItems = array_merge($orderByItems, (array) $collectionOrderByItems);
}
return ' ORDER BY ' . implode(', ', $orderByItems);
}
/**
* Walks down an OrderByItem AST node, thereby generating the appropriate SQL.
*
* @param AST\OrderByItem $orderByItem
*
* @return string
*
* @not-deprecated
*/
public function walkOrderByItem($orderByItem)
{
$type = strtoupper($orderByItem->type);
$expr = $orderByItem->expression;
$sql = $expr instanceof AST\Node
? $expr->dispatch($this)
: $this->walkResultVariable($this->queryComponents[$expr]['token']->value);
$this->orderedColumnsMap[$sql] = $type;
if ($expr instanceof AST\Subselect) {
return '(' . $sql . ') ' . $type;
}
return $sql . ' ' . $type;
}
/**
* Walks down a HavingClause AST node, thereby generating the appropriate SQL.
*
* @param AST\HavingClause $havingClause
*
* @return string The SQL.
*
* @not-deprecated
*/
public function walkHavingClause($havingClause)
{
return ' HAVING ' . $this->walkConditionalExpression($havingClause->conditionalExpression);
}
/**
* Walks down a Join AST node and creates the corresponding SQL.
*
* @param AST\Join $join
*
* @return string
*
* @not-deprecated
*/
public function walkJoin($join)
{
$joinType = $join->joinType;
$joinDeclaration = $join->joinAssociationDeclaration;
$sql = $joinType === AST\Join::JOIN_TYPE_LEFT || $joinType === AST\Join::JOIN_TYPE_LEFTOUTER
? ' LEFT JOIN '
: ' INNER JOIN ';
switch (true) {
case $joinDeclaration instanceof AST\RangeVariableDeclaration:
$class = $this->em->getClassMetadata($joinDeclaration->abstractSchemaName);
$dqlAlias = $joinDeclaration->aliasIdentificationVariable;
$tableAlias = $this->getSQLTableAlias($class->table['name'], $dqlAlias);
$conditions = [];
if ($join->conditionalExpression) {
$conditions[] = '(' . $this->walkConditionalExpression($join->conditionalExpression) . ')';
}
$isUnconditionalJoin = $conditions === [];
$condExprConjunction = $class->isInheritanceTypeJoined() && $joinType !== AST\Join::JOIN_TYPE_LEFT && $joinType !== AST\Join::JOIN_TYPE_LEFTOUTER && $isUnconditionalJoin
? ' AND '
: ' ON ';
$sql .= $this->generateRangeVariableDeclarationSQL($joinDeclaration, ! $isUnconditionalJoin);
// Apply remaining inheritance restrictions
$discrSql = $this->generateDiscriminatorColumnConditionSQL([$dqlAlias]);
if ($discrSql) {
$conditions[] = $discrSql;
}
// Apply the filters
$filterExpr = $this->generateFilterConditionSQL($class, $tableAlias);
if ($filterExpr) {
$conditions[] = $filterExpr;
}
if ($conditions) {
$sql .= $condExprConjunction . implode(' AND ', $conditions);
}
break;
case $joinDeclaration instanceof AST\JoinAssociationDeclaration:
$sql .= $this->walkJoinAssociationDeclaration($joinDeclaration, $joinType, $join->conditionalExpression);
break;
}
return $sql;
}
/**
* Walks down a CoalesceExpression AST node and generates the corresponding SQL.
*
* @param AST\CoalesceExpression $coalesceExpression
*
* @return string The SQL.
*
* @not-deprecated
*/
public function walkCoalesceExpression($coalesceExpression)
{
$sql = 'COALESCE(';
$scalarExpressions = [];
foreach ($coalesceExpression->scalarExpressions as $scalarExpression) {
$scalarExpressions[] = $this->walkSimpleArithmeticExpression($scalarExpression);
}
return $sql . implode(', ', $scalarExpressions) . ')';
}
/**
* Walks down a NullIfExpression AST node and generates the corresponding SQL.
*
* @param AST\NullIfExpression $nullIfExpression
*
* @return string The SQL.
*
* @not-deprecated
*/
public function walkNullIfExpression($nullIfExpression)
{
$firstExpression = is_string($nullIfExpression->firstExpression)
? $this->conn->quote($nullIfExpression->firstExpression)
: $this->walkSimpleArithmeticExpression($nullIfExpression->firstExpression);
$secondExpression = is_string($nullIfExpression->secondExpression)
? $this->conn->quote($nullIfExpression->secondExpression)
: $this->walkSimpleArithmeticExpression($nullIfExpression->secondExpression);
return 'NULLIF(' . $firstExpression . ', ' . $secondExpression . ')';
}
/**
* Walks down a GeneralCaseExpression AST node and generates the corresponding SQL.
*
* @return string The SQL.
*
* @not-deprecated
*/
public function walkGeneralCaseExpression(AST\GeneralCaseExpression $generalCaseExpression)
{
$sql = 'CASE';
foreach ($generalCaseExpression->whenClauses as $whenClause) {
$sql .= ' WHEN ' . $this->walkConditionalExpression($whenClause->caseConditionExpression);
$sql .= ' THEN ' . $this->walkSimpleArithmeticExpression($whenClause->thenScalarExpression);
}
$sql .= ' ELSE ' . $this->walkSimpleArithmeticExpression($generalCaseExpression->elseScalarExpression) . ' END';
return $sql;
}
/**
* Walks down a SimpleCaseExpression AST node and generates the corresponding SQL.
*
* @param AST\SimpleCaseExpression $simpleCaseExpression
*
* @return string The SQL.
*
* @not-deprecated
*/
public function walkSimpleCaseExpression($simpleCaseExpression)
{
$sql = 'CASE ' . $this->walkStateFieldPathExpression($simpleCaseExpression->caseOperand);
foreach ($simpleCaseExpression->simpleWhenClauses as $simpleWhenClause) {
$sql .= ' WHEN ' . $this->walkSimpleArithmeticExpression($simpleWhenClause->caseScalarExpression);
$sql .= ' THEN ' . $this->walkSimpleArithmeticExpression($simpleWhenClause->thenScalarExpression);
}
$sql .= ' ELSE ' . $this->walkSimpleArithmeticExpression($simpleCaseExpression->elseScalarExpression) . ' END';
return $sql;
}
/**
* Walks down a SelectExpression AST node and generates the corresponding SQL.
*
* @param AST\SelectExpression $selectExpression
*
* @return string
*
* @not-deprecated
*/
public function walkSelectExpression($selectExpression)
{
$sql = '';
$expr = $selectExpression->expression;
$hidden = $selectExpression->hiddenAliasResultVariable;
switch (true) {
case $expr instanceof AST\PathExpression:
if ($expr->type !== AST\PathExpression::TYPE_STATE_FIELD) {
throw QueryException::invalidPathExpression($expr);
}
assert($expr->field !== null);
$fieldName = $expr->field;
$dqlAlias = $expr->identificationVariable;
$class = $this->getMetadataForDqlAlias($dqlAlias);
$resultAlias = $selectExpression->fieldIdentificationVariable ?: $fieldName;
$tableName = $class->isInheritanceTypeJoined()
? $this->em->getUnitOfWork()->getEntityPersister($class->name)->getOwningTable($fieldName)
: $class->getTableName();
$sqlTableAlias = $this->getSQLTableAlias($tableName, $dqlAlias);
$fieldMapping = $class->fieldMappings[$fieldName];
$columnName = $this->quoteStrategy->getColumnName($fieldName, $class, $this->platform);
$columnAlias = $this->getSQLColumnAlias($fieldMapping['columnName']);
$col = $sqlTableAlias . '.' . $columnName;
if (isset($fieldMapping['requireSQLConversion'])) {
$type = Type::getType($fieldMapping['type']);
$col = $type->convertToPHPValueSQL($col, $this->conn->getDatabasePlatform());
}
$sql .= $col . ' AS ' . $columnAlias;
$this->scalarResultAliasMap[$resultAlias] = $columnAlias;
if (! $hidden) {
$this->rsm->addScalarResult($columnAlias, $resultAlias, $fieldMapping['type']);
$this->scalarFields[$dqlAlias][$fieldName] = $columnAlias;
if (! empty($fieldMapping['enumType'])) {
$this->rsm->addEnumResult($columnAlias, $fieldMapping['enumType']);
}
}
break;
case $expr instanceof AST\AggregateExpression:
case $expr instanceof AST\Functions\FunctionNode:
case $expr instanceof AST\SimpleArithmeticExpression:
case $expr instanceof AST\ArithmeticTerm:
case $expr instanceof AST\ArithmeticFactor:
case $expr instanceof AST\ParenthesisExpression:
case $expr instanceof AST\Literal:
case $expr instanceof AST\NullIfExpression:
case $expr instanceof AST\CoalesceExpression:
case $expr instanceof AST\GeneralCaseExpression:
case $expr instanceof AST\SimpleCaseExpression:
$columnAlias = $this->getSQLColumnAlias('sclr');
$resultAlias = $selectExpression->fieldIdentificationVariable ?: $this->scalarResultCounter++;
$sql .= $expr->dispatch($this) . ' AS ' . $columnAlias;
$this->scalarResultAliasMap[$resultAlias] = $columnAlias;
if ($hidden) {
break;
}
if (! $expr instanceof Query\AST\TypedExpression) {
// Conceptually we could resolve field type here by traverse through AST to retrieve field type,
// but this is not a feasible solution; assume 'string'.
$this->rsm->addScalarResult($columnAlias, $resultAlias, 'string');
break;
}
$this->rsm->addScalarResult($columnAlias, $resultAlias, Type::getTypeRegistry()->lookupName($expr->getReturnType()));
break;
case $expr instanceof AST\Subselect:
$columnAlias = $this->getSQLColumnAlias('sclr');
$resultAlias = $selectExpression->fieldIdentificationVariable ?: $this->scalarResultCounter++;
$sql .= '(' . $this->walkSubselect($expr) . ') AS ' . $columnAlias;
$this->scalarResultAliasMap[$resultAlias] = $columnAlias;
if (! $hidden) {
// We cannot resolve field type here; assume 'string'.
$this->rsm->addScalarResult($columnAlias, $resultAlias, 'string');
}
break;
case $expr instanceof AST\NewObjectExpression:
$sql .= $this->walkNewObject($expr, $selectExpression->fieldIdentificationVariable);
break;
default:
// IdentificationVariable or PartialObjectExpression
if ($expr instanceof AST\PartialObjectExpression) {
$this->query->setHint(self::HINT_PARTIAL, true);
$dqlAlias = $expr->identificationVariable;
$partialFieldSet = $expr->partialFieldSet;
} else {
$dqlAlias = $expr;
$partialFieldSet = [];
}
$class = $this->getMetadataForDqlAlias($dqlAlias);
$resultAlias = $selectExpression->fieldIdentificationVariable ?: null;
if (! isset($this->selectedClasses[$dqlAlias])) {
$this->selectedClasses[$dqlAlias] = [
'class' => $class,
'dqlAlias' => $dqlAlias,
'resultAlias' => $resultAlias,
];
}
$sqlParts = [];
// Select all fields from the queried class
foreach ($class->fieldMappings as $fieldName => $mapping) {
if ($partialFieldSet && ! in_array($fieldName, $partialFieldSet, true)) {
continue;
}
$tableName = isset($mapping['inherited'])
? $this->em->getClassMetadata($mapping['inherited'])->getTableName()
: $class->getTableName();
$sqlTableAlias = $this->getSQLTableAlias($tableName, $dqlAlias);
$columnAlias = $this->getSQLColumnAlias($mapping['columnName']);
$quotedColumnName = $this->quoteStrategy->getColumnName($fieldName, $class, $this->platform);
$col = $sqlTableAlias . '.' . $quotedColumnName;
if (isset($mapping['requireSQLConversion'])) {
$type = Type::getType($mapping['type']);
$col = $type->convertToPHPValueSQL($col, $this->platform);
}
$sqlParts[] = $col . ' AS ' . $columnAlias;
$this->scalarResultAliasMap[$resultAlias][] = $columnAlias;
$this->rsm->addFieldResult($dqlAlias, $columnAlias, $fieldName, $class->name);
if (! empty($mapping['enumType'])) {
$this->rsm->addEnumResult($columnAlias, $mapping['enumType']);
}
}
// Add any additional fields of subclasses (excluding inherited fields)
// 1) on Single Table Inheritance: always, since its marginal overhead
// 2) on Class Table Inheritance only if partial objects are disallowed,
// since it requires outer joining subtables.
if ($class->isInheritanceTypeSingleTable() || ! $this->query->getHint(Query::HINT_FORCE_PARTIAL_LOAD)) {
foreach ($class->subClasses as $subClassName) {
$subClass = $this->em->getClassMetadata($subClassName);
$sqlTableAlias = $this->getSQLTableAlias($subClass->getTableName(), $dqlAlias);
foreach ($subClass->fieldMappings as $fieldName => $mapping) {
if (isset($mapping['inherited']) || ($partialFieldSet && ! in_array($fieldName, $partialFieldSet, true))) {
continue;
}
$columnAlias = $this->getSQLColumnAlias($mapping['columnName']);
$quotedColumnName = $this->quoteStrategy->getColumnName($fieldName, $subClass, $this->platform);
$col = $sqlTableAlias . '.' . $quotedColumnName;
if (isset($mapping['requireSQLConversion'])) {
$type = Type::getType($mapping['type']);
$col = $type->convertToPHPValueSQL($col, $this->platform);
}
$sqlParts[] = $col . ' AS ' . $columnAlias;
$this->scalarResultAliasMap[$resultAlias][] = $columnAlias;
$this->rsm->addFieldResult($dqlAlias, $columnAlias, $fieldName, $subClassName);
}
}
}
$sql .= implode(', ', $sqlParts);
}
return $sql;
}
/**
* Walks down a QuantifiedExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\QuantifiedExpression $qExpr
*
* @return string
*
* @not-deprecated
*/
public function walkQuantifiedExpression($qExpr)
{
return ' ' . strtoupper($qExpr->type) . '(' . $this->walkSubselect($qExpr->subselect) . ')';
}
/**
* Walks down a Subselect AST node, thereby generating the appropriate SQL.
*
* @param AST\Subselect $subselect
*
* @return string
*
* @not-deprecated
*/
public function walkSubselect($subselect)
{
$useAliasesBefore = $this->useSqlTableAliases;
$rootAliasesBefore = $this->rootAliases;
$this->rootAliases = []; // reset the rootAliases for the subselect
$this->useSqlTableAliases = true;
$sql = $this->walkSimpleSelectClause($subselect->simpleSelectClause);
$sql .= $this->walkSubselectFromClause($subselect->subselectFromClause);
$sql .= $this->walkWhereClause($subselect->whereClause);
$sql .= $subselect->groupByClause ? $this->walkGroupByClause($subselect->groupByClause) : '';
$sql .= $subselect->havingClause ? $this->walkHavingClause($subselect->havingClause) : '';
$sql .= $subselect->orderByClause ? $this->walkOrderByClause($subselect->orderByClause) : '';
$this->rootAliases = $rootAliasesBefore; // put the main aliases back
$this->useSqlTableAliases = $useAliasesBefore;
return $sql;
}
/**
* Walks down a SubselectFromClause AST node, thereby generating the appropriate SQL.
*
* @param AST\SubselectFromClause $subselectFromClause
*
* @return string
*
* @not-deprecated
*/
public function walkSubselectFromClause($subselectFromClause)
{
$identificationVarDecls = $subselectFromClause->identificationVariableDeclarations;
$sqlParts = [];
foreach ($identificationVarDecls as $subselectIdVarDecl) {
$sqlParts[] = $this->walkIdentificationVariableDeclaration($subselectIdVarDecl);
}
return ' FROM ' . implode(', ', $sqlParts);
}
/**
* Walks down a SimpleSelectClause AST node, thereby generating the appropriate SQL.
*
* @param AST\SimpleSelectClause $simpleSelectClause
*
* @return string
*
* @not-deprecated
*/
public function walkSimpleSelectClause($simpleSelectClause)
{
return 'SELECT' . ($simpleSelectClause->isDistinct ? ' DISTINCT' : '')
. $this->walkSimpleSelectExpression($simpleSelectClause->simpleSelectExpression);
}
/** @return string */
public function walkParenthesisExpression(AST\ParenthesisExpression $parenthesisExpression)
{
return sprintf('(%s)', $parenthesisExpression->expression->dispatch($this));
}
/**
* @param AST\NewObjectExpression $newObjectExpression
* @param string|null $newObjectResultAlias
*
* @return string The SQL.
*/
public function walkNewObject($newObjectExpression, $newObjectResultAlias = null)
{
$sqlSelectExpressions = [];
$objIndex = $newObjectResultAlias ?: $this->newObjectCounter++;
foreach ($newObjectExpression->args as $argIndex => $e) {
$resultAlias = $this->scalarResultCounter++;
$columnAlias = $this->getSQLColumnAlias('sclr');
$fieldType = 'string';
switch (true) {
case $e instanceof AST\NewObjectExpression:
$sqlSelectExpressions[] = $e->dispatch($this);
break;
case $e instanceof AST\Subselect:
$sqlSelectExpressions[] = '(' . $e->dispatch($this) . ') AS ' . $columnAlias;
break;
case $e instanceof AST\PathExpression:
assert($e->field !== null);
$dqlAlias = $e->identificationVariable;
$class = $this->getMetadataForDqlAlias($dqlAlias);
$fieldName = $e->field;
$fieldMapping = $class->fieldMappings[$fieldName];
$fieldType = $fieldMapping['type'];
$col = trim($e->dispatch($this));
if (isset($fieldMapping['requireSQLConversion'])) {
$type = Type::getType($fieldType);
$col = $type->convertToPHPValueSQL($col, $this->platform);
}
$sqlSelectExpressions[] = $col . ' AS ' . $columnAlias;
if (! empty($fieldMapping['enumType'])) {
$this->rsm->addEnumResult($columnAlias, $fieldMapping['enumType']);
}
break;
case $e instanceof AST\Literal:
switch ($e->type) {
case AST\Literal::BOOLEAN:
$fieldType = 'boolean';
break;
case AST\Literal::NUMERIC:
$fieldType = is_float($e->value) ? 'float' : 'integer';
break;
}
$sqlSelectExpressions[] = trim($e->dispatch($this)) . ' AS ' . $columnAlias;
break;
default:
$sqlSelectExpressions[] = trim($e->dispatch($this)) . ' AS ' . $columnAlias;
break;
}
$this->scalarResultAliasMap[$resultAlias] = $columnAlias;
$this->rsm->addScalarResult($columnAlias, $resultAlias, $fieldType);
$this->rsm->newObjectMappings[$columnAlias] = [
'className' => $newObjectExpression->className,
'objIndex' => $objIndex,
'argIndex' => $argIndex,
];
}
return implode(', ', $sqlSelectExpressions);
}
/**
* Walks down a SimpleSelectExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\SimpleSelectExpression $simpleSelectExpression
*
* @return string
*
* @not-deprecated
*/
public function walkSimpleSelectExpression($simpleSelectExpression)
{
$expr = $simpleSelectExpression->expression;
$sql = ' ';
switch (true) {
case $expr instanceof AST\PathExpression:
$sql .= $this->walkPathExpression($expr);
break;
case $expr instanceof AST\Subselect:
$alias = $simpleSelectExpression->fieldIdentificationVariable ?: $this->scalarResultCounter++;
$columnAlias = 'sclr' . $this->aliasCounter++;
$this->scalarResultAliasMap[$alias] = $columnAlias;
$sql .= '(' . $this->walkSubselect($expr) . ') AS ' . $columnAlias;
break;
case $expr instanceof AST\Functions\FunctionNode:
case $expr instanceof AST\SimpleArithmeticExpression:
case $expr instanceof AST\ArithmeticTerm:
case $expr instanceof AST\ArithmeticFactor:
case $expr instanceof AST\Literal:
case $expr instanceof AST\NullIfExpression:
case $expr instanceof AST\CoalesceExpression:
case $expr instanceof AST\GeneralCaseExpression:
case $expr instanceof AST\SimpleCaseExpression:
$alias = $simpleSelectExpression->fieldIdentificationVariable ?: $this->scalarResultCounter++;
$columnAlias = $this->getSQLColumnAlias('sclr');
$this->scalarResultAliasMap[$alias] = $columnAlias;
$sql .= $expr->dispatch($this) . ' AS ' . $columnAlias;
break;
case $expr instanceof AST\ParenthesisExpression:
$sql .= $this->walkParenthesisExpression($expr);
break;
default: // IdentificationVariable
$sql .= $this->walkEntityIdentificationVariable($expr);
break;
}
return $sql;
}
/**
* Walks down an AggregateExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\AggregateExpression $aggExpression
*
* @return string
*
* @not-deprecated
*/
public function walkAggregateExpression($aggExpression)
{
return $aggExpression->functionName . '(' . ($aggExpression->isDistinct ? 'DISTINCT ' : '')
. $this->walkSimpleArithmeticExpression($aggExpression->pathExpression) . ')';
}
/**
* Walks down a GroupByClause AST node, thereby generating the appropriate SQL.
*
* @param AST\GroupByClause $groupByClause
*
* @return string
*
* @not-deprecated
*/
public function walkGroupByClause($groupByClause)
{
$sqlParts = [];
foreach ($groupByClause->groupByItems as $groupByItem) {
$sqlParts[] = $this->walkGroupByItem($groupByItem);
}
return ' GROUP BY ' . implode(', ', $sqlParts);
}
/**
* Walks down a GroupByItem AST node, thereby generating the appropriate SQL.
*
* @param AST\PathExpression|string $groupByItem
*
* @return string
*
* @not-deprecated
*/
public function walkGroupByItem($groupByItem)
{
// StateFieldPathExpression
if (! is_string($groupByItem)) {
return $this->walkPathExpression($groupByItem);
}
// ResultVariable
if (isset($this->queryComponents[$groupByItem]['resultVariable'])) {
$resultVariable = $this->queryComponents[$groupByItem]['resultVariable'];
if ($resultVariable instanceof AST\PathExpression) {
return $this->walkPathExpression($resultVariable);
}
if ($resultVariable instanceof AST\Node && isset($resultVariable->pathExpression)) {
return $this->walkPathExpression($resultVariable->pathExpression);
}
return $this->walkResultVariable($groupByItem);
}
// IdentificationVariable
$sqlParts = [];
foreach ($this->getMetadataForDqlAlias($groupByItem)->fieldNames as $field) {
$item = new AST\PathExpression(AST\PathExpression::TYPE_STATE_FIELD, $groupByItem, $field);
$item->type = AST\PathExpression::TYPE_STATE_FIELD;
$sqlParts[] = $this->walkPathExpression($item);
}
foreach ($this->getMetadataForDqlAlias($groupByItem)->associationMappings as $mapping) {
if ($mapping['isOwningSide'] && $mapping['type'] & ClassMetadata::TO_ONE) {
$item = new AST\PathExpression(AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION, $groupByItem, $mapping['fieldName']);
$item->type = AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION;
$sqlParts[] = $this->walkPathExpression($item);
}
}
return implode(', ', $sqlParts);
}
/**
* Walks down a DeleteClause AST node, thereby generating the appropriate SQL.
*
* @return string
*
* @not-deprecated
*/
public function walkDeleteClause(AST\DeleteClause $deleteClause)
{
$class = $this->em->getClassMetadata($deleteClause->abstractSchemaName);
$tableName = $class->getTableName();
$sql = 'DELETE FROM ' . $this->quoteStrategy->getTableName($class, $this->platform);
$this->setSQLTableAlias($tableName, $tableName, $deleteClause->aliasIdentificationVariable);
$this->rootAliases[] = $deleteClause->aliasIdentificationVariable;
return $sql;
}
/**
* Walks down an UpdateClause AST node, thereby generating the appropriate SQL.
*
* @param AST\UpdateClause $updateClause
*
* @return string
*
* @not-deprecated
*/
public function walkUpdateClause($updateClause)
{
$class = $this->em->getClassMetadata($updateClause->abstractSchemaName);
$tableName = $class->getTableName();
$sql = 'UPDATE ' . $this->quoteStrategy->getTableName($class, $this->platform);
$this->setSQLTableAlias($tableName, $tableName, $updateClause->aliasIdentificationVariable);
$this->rootAliases[] = $updateClause->aliasIdentificationVariable;
return $sql . ' SET ' . implode(', ', array_map([$this, 'walkUpdateItem'], $updateClause->updateItems));
}
/**
* Walks down an UpdateItem AST node, thereby generating the appropriate SQL.
*
* @param AST\UpdateItem $updateItem
*
* @return string
*
* @not-deprecated
*/
public function walkUpdateItem($updateItem)
{
$useTableAliasesBefore = $this->useSqlTableAliases;
$this->useSqlTableAliases = false;
$sql = $this->walkPathExpression($updateItem->pathExpression) . ' = ';
$newValue = $updateItem->newValue;
switch (true) {
case $newValue instanceof AST\Node:
$sql .= $newValue->dispatch($this);
break;
case $newValue === null:
$sql .= 'NULL';
break;
default:
$sql .= $this->conn->quote($newValue);
break;
}
$this->useSqlTableAliases = $useTableAliasesBefore;
return $sql;
}
/**
* Walks down a WhereClause AST node, thereby generating the appropriate SQL.
* WhereClause or not, the appropriate discriminator sql is added.
*
* @param AST\WhereClause $whereClause
*
* @return string
*
* @not-deprecated
*/
public function walkWhereClause($whereClause)
{
$condSql = $whereClause !== null ? $this->walkConditionalExpression($whereClause->conditionalExpression) : '';
$discrSql = $this->generateDiscriminatorColumnConditionSQL($this->rootAliases);
if ($this->em->hasFilters()) {
$filterClauses = [];
foreach ($this->rootAliases as $dqlAlias) {
$class = $this->getMetadataForDqlAlias($dqlAlias);
$tableAlias = $this->getSQLTableAlias($class->table['name'], $dqlAlias);
$filterExpr = $this->generateFilterConditionSQL($class, $tableAlias);
if ($filterExpr) {
$filterClauses[] = $filterExpr;
}
}
if (count($filterClauses)) {
if ($condSql) {
$condSql = '(' . $condSql . ') AND ';
}
$condSql .= implode(' AND ', $filterClauses);
}
}
if ($condSql) {
return ' WHERE ' . (! $discrSql ? $condSql : '(' . $condSql . ') AND ' . $discrSql);
}
if ($discrSql) {
return ' WHERE ' . $discrSql;
}
return '';
}
/**
* Walk down a ConditionalExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\ConditionalExpression|AST\Phase2OptimizableConditional $condExpr
*
* @return string
*
* @not-deprecated
*/
public function walkConditionalExpression($condExpr)
{
// Phase 2 AST optimization: Skip processing of ConditionalExpression
// if only one ConditionalTerm is defined
if (! ($condExpr instanceof AST\ConditionalExpression)) {
return $this->walkConditionalTerm($condExpr);
}
return implode(' OR ', array_map([$this, 'walkConditionalTerm'], $condExpr->conditionalTerms));
}
/**
* Walks down a ConditionalTerm AST node, thereby generating the appropriate SQL.
*
* @param AST\ConditionalTerm|AST\ConditionalFactor|AST\ConditionalPrimary $condTerm
*
* @return string
*
* @not-deprecated
*/
public function walkConditionalTerm($condTerm)
{
// Phase 2 AST optimization: Skip processing of ConditionalTerm
// if only one ConditionalFactor is defined
if (! ($condTerm instanceof AST\ConditionalTerm)) {
return $this->walkConditionalFactor($condTerm);
}
return implode(' AND ', array_map([$this, 'walkConditionalFactor'], $condTerm->conditionalFactors));
}
/**
* Walks down a ConditionalFactor AST node, thereby generating the appropriate SQL.
*
* @param AST\ConditionalFactor|AST\ConditionalPrimary $factor
*
* @return string The SQL.
*
* @not-deprecated
*/
public function walkConditionalFactor($factor)
{
// Phase 2 AST optimization: Skip processing of ConditionalFactor
// if only one ConditionalPrimary is defined
return ! ($factor instanceof AST\ConditionalFactor)
? $this->walkConditionalPrimary($factor)
: ($factor->not ? 'NOT ' : '') . $this->walkConditionalPrimary($factor->conditionalPrimary);
}
/**
* Walks down a ConditionalPrimary AST node, thereby generating the appropriate SQL.
*
* @param AST\ConditionalPrimary $primary
*
* @return string
*
* @not-deprecated
*/
public function walkConditionalPrimary($primary)
{
if ($primary->isSimpleConditionalExpression()) {
return $primary->simpleConditionalExpression->dispatch($this);
}
if ($primary->isConditionalExpression()) {
$condExpr = $primary->conditionalExpression;
return '(' . $this->walkConditionalExpression($condExpr) . ')';
}
}
/**
* Walks down an ExistsExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\ExistsExpression $existsExpr
*
* @return string
*
* @not-deprecated
*/
public function walkExistsExpression($existsExpr)
{
$sql = $existsExpr->not ? 'NOT ' : '';
$sql .= 'EXISTS (' . $this->walkSubselect($existsExpr->subselect) . ')';
return $sql;
}
/**
* Walks down a CollectionMemberExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\CollectionMemberExpression $collMemberExpr
*
* @return string
*
* @not-deprecated
*/
public function walkCollectionMemberExpression($collMemberExpr)
{
$sql = $collMemberExpr->not ? 'NOT ' : '';
$sql .= 'EXISTS (SELECT 1 FROM ';
$entityExpr = $collMemberExpr->entityExpression;
$collPathExpr = $collMemberExpr->collectionValuedPathExpression;
assert($collPathExpr->field !== null);
$fieldName = $collPathExpr->field;
$dqlAlias = $collPathExpr->identificationVariable;
$class = $this->getMetadataForDqlAlias($dqlAlias);
switch (true) {
// InputParameter
case $entityExpr instanceof AST\InputParameter:
$dqlParamKey = $entityExpr->name;
$entitySql = '?';
break;
// SingleValuedAssociationPathExpression | IdentificationVariable
case $entityExpr instanceof AST\PathExpression:
$entitySql = $this->walkPathExpression($entityExpr);
break;
default:
throw new BadMethodCallException('Not implemented');
}
$assoc = $class->associationMappings[$fieldName];
if ($assoc['type'] === ClassMetadata::ONE_TO_MANY) {
$targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
$targetTableAlias = $this->getSQLTableAlias($targetClass->getTableName());
$sourceTableAlias = $this->getSQLTableAlias($class->getTableName(), $dqlAlias);
$sql .= $this->quoteStrategy->getTableName($targetClass, $this->platform) . ' ' . $targetTableAlias . ' WHERE ';
$owningAssoc = $targetClass->associationMappings[$assoc['mappedBy']];
$sqlParts = [];
foreach ($owningAssoc['targetToSourceKeyColumns'] as $targetColumn => $sourceColumn) {
$targetColumn = $this->quoteStrategy->getColumnName($class->fieldNames[$targetColumn], $class, $this->platform);
$sqlParts[] = $sourceTableAlias . '.' . $targetColumn . ' = ' . $targetTableAlias . '.' . $sourceColumn;
}
foreach ($this->quoteStrategy->getIdentifierColumnNames($targetClass, $this->platform) as $targetColumnName) {
if (isset($dqlParamKey)) {
$this->parserResult->addParameterMapping($dqlParamKey, $this->sqlParamIndex++);
}
$sqlParts[] = $targetTableAlias . '.' . $targetColumnName . ' = ' . $entitySql;
}
$sql .= implode(' AND ', $sqlParts);
} else { // many-to-many
$targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
$owningAssoc = $assoc['isOwningSide'] ? $assoc : $targetClass->associationMappings[$assoc['mappedBy']];
$joinTable = $owningAssoc['joinTable'];
// SQL table aliases
$joinTableAlias = $this->getSQLTableAlias($joinTable['name']);
$sourceTableAlias = $this->getSQLTableAlias($class->getTableName(), $dqlAlias);
$sql .= $this->quoteStrategy->getJoinTableName($owningAssoc, $targetClass, $this->platform) . ' ' . $joinTableAlias . ' WHERE ';
$joinColumns = $assoc['isOwningSide'] ? $joinTable['joinColumns'] : $joinTable['inverseJoinColumns'];
$sqlParts = [];
foreach ($joinColumns as $joinColumn) {
$targetColumn = $this->quoteStrategy->getColumnName($class->fieldNames[$joinColumn['referencedColumnName']], $class, $this->platform);
$sqlParts[] = $joinTableAlias . '.' . $joinColumn['name'] . ' = ' . $sourceTableAlias . '.' . $targetColumn;
}
$joinColumns = $assoc['isOwningSide'] ? $joinTable['inverseJoinColumns'] : $joinTable['joinColumns'];
foreach ($joinColumns as $joinColumn) {
if (isset($dqlParamKey)) {
$this->parserResult->addParameterMapping($dqlParamKey, $this->sqlParamIndex++);
}
$sqlParts[] = $joinTableAlias . '.' . $joinColumn['name'] . ' IN (' . $entitySql . ')';
}
$sql .= implode(' AND ', $sqlParts);
}
return $sql . ')';
}
/**
* Walks down an EmptyCollectionComparisonExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\EmptyCollectionComparisonExpression $emptyCollCompExpr
*
* @return string
*
* @not-deprecated
*/
public function walkEmptyCollectionComparisonExpression($emptyCollCompExpr)
{
$sizeFunc = new AST\Functions\SizeFunction('size');
$sizeFunc->collectionPathExpression = $emptyCollCompExpr->expression;
return $sizeFunc->getSql($this) . ($emptyCollCompExpr->not ? ' > 0' : ' = 0');
}
/**
* Walks down a NullComparisonExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\NullComparisonExpression $nullCompExpr
*
* @return string
*
* @not-deprecated
*/
public function walkNullComparisonExpression($nullCompExpr)
{
$expression = $nullCompExpr->expression;
$comparison = ' IS' . ($nullCompExpr->not ? ' NOT' : '') . ' NULL';
// Handle ResultVariable
if (is_string($expression) && isset($this->queryComponents[$expression]['resultVariable'])) {
return $this->walkResultVariable($expression) . $comparison;
}
// Handle InputParameter mapping inclusion to ParserResult
if ($expression instanceof AST\InputParameter) {
return $this->walkInputParameter($expression) . $comparison;
}
return $expression->dispatch($this) . $comparison;
}
/**
* Walks down an InExpression AST node, thereby generating the appropriate SQL.
*
* @deprecated Use {@see walkInListExpression()} or {@see walkInSubselectExpression()} instead.
*
* @param AST\InExpression $inExpr
*
* @return string
*/
public function walkInExpression($inExpr)
{
Deprecation::triggerIfCalledFromOutside(
'doctrine/orm',
'https://github.com/doctrine/orm/pull/10267',
'%s() is deprecated, call walkInListExpression() or walkInSubselectExpression() instead.',
__METHOD__
);
if ($inExpr instanceof AST\InListExpression) {
return $this->walkInListExpression($inExpr);
}
if ($inExpr instanceof AST\InSubselectExpression) {
return $this->walkInSubselectExpression($inExpr);
}
$sql = $this->walkArithmeticExpression($inExpr->expression) . ($inExpr->not ? ' NOT' : '') . ' IN (';
$sql .= $inExpr->subselect
? $this->walkSubselect($inExpr->subselect)
: implode(', ', array_map([$this, 'walkInParameter'], $inExpr->literals));
$sql .= ')';
return $sql;
}
/**
* Walks down an InExpression AST node, thereby generating the appropriate SQL.
*/
public function walkInListExpression(AST\InListExpression $inExpr): string
{
return $this->walkArithmeticExpression($inExpr->expression)
. ($inExpr->not ? ' NOT' : '') . ' IN ('
. implode(', ', array_map([$this, 'walkInParameter'], $inExpr->literals))
. ')';
}
/**
* Walks down an InExpression AST node, thereby generating the appropriate SQL.
*/
public function walkInSubselectExpression(AST\InSubselectExpression $inExpr): string
{
return $this->walkArithmeticExpression($inExpr->expression)
. ($inExpr->not ? ' NOT' : '') . ' IN ('
. $this->walkSubselect($inExpr->subselect)
. ')';
}
/**
* Walks down an InstanceOfExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\InstanceOfExpression $instanceOfExpr
*
* @return string
*
* @throws QueryException
*
* @not-deprecated
*/
public function walkInstanceOfExpression($instanceOfExpr)
{
$sql = '';
$dqlAlias = $instanceOfExpr->identificationVariable;
$discrClass = $class = $this->getMetadataForDqlAlias($dqlAlias);
if ($class->discriminatorColumn) {
$discrClass = $this->em->getClassMetadata($class->rootEntityName);
}
if ($this->useSqlTableAliases) {
$sql .= $this->getSQLTableAlias($discrClass->getTableName(), $dqlAlias) . '.';
}
$sql .= $class->getDiscriminatorColumn()['name'] . ($instanceOfExpr->not ? ' NOT IN ' : ' IN ');
$sql .= $this->getChildDiscriminatorsFromClassMetadata($discrClass, $instanceOfExpr);
return $sql;
}
/**
* @param mixed $inParam
*
* @return string
*
* @not-deprecated
*/
public function walkInParameter($inParam)
{
return $inParam instanceof AST\InputParameter
? $this->walkInputParameter($inParam)
: $this->walkArithmeticExpression($inParam);
}
/**
* Walks down a literal that represents an AST node, thereby generating the appropriate SQL.
*
* @param AST\Literal $literal
*
* @return string
*
* @not-deprecated
*/
public function walkLiteral($literal)
{
switch ($literal->type) {
case AST\Literal::STRING:
return $this->conn->quote($literal->value);
case AST\Literal::BOOLEAN:
return (string) $this->conn->getDatabasePlatform()->convertBooleans(strtolower($literal->value) === 'true');
case AST\Literal::NUMERIC:
return (string) $literal->value;
default:
throw QueryException::invalidLiteral($literal);
}
}
/**
* Walks down a BetweenExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\BetweenExpression $betweenExpr
*
* @return string
*
* @not-deprecated
*/
public function walkBetweenExpression($betweenExpr)
{
$sql = $this->walkArithmeticExpression($betweenExpr->expression);
if ($betweenExpr->not) {
$sql .= ' NOT';
}
$sql .= ' BETWEEN ' . $this->walkArithmeticExpression($betweenExpr->leftBetweenExpression)
. ' AND ' . $this->walkArithmeticExpression($betweenExpr->rightBetweenExpression);
return $sql;
}
/**
* Walks down a LikeExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\LikeExpression $likeExpr
*
* @return string
*
* @not-deprecated
*/
public function walkLikeExpression($likeExpr)
{
$stringExpr = $likeExpr->stringExpression;
if (is_string($stringExpr)) {
if (! isset($this->queryComponents[$stringExpr]['resultVariable'])) {
throw new LogicException(sprintf('No result variable found for string expression "%s".', $stringExpr));
}
$leftExpr = $this->walkResultVariable($stringExpr);
} else {
$leftExpr = $stringExpr->dispatch($this);
}
$sql = $leftExpr . ($likeExpr->not ? ' NOT' : '') . ' LIKE ';
if ($likeExpr->stringPattern instanceof AST\InputParameter) {
$sql .= $this->walkInputParameter($likeExpr->stringPattern);
} elseif ($likeExpr->stringPattern instanceof AST\Functions\FunctionNode) {
$sql .= $this->walkFunction($likeExpr->stringPattern);
} elseif ($likeExpr->stringPattern instanceof AST\PathExpression) {
$sql .= $this->walkPathExpression($likeExpr->stringPattern);
} else {
$sql .= $this->walkLiteral($likeExpr->stringPattern);
}
if ($likeExpr->escapeChar) {
$sql .= ' ESCAPE ' . $this->walkLiteral($likeExpr->escapeChar);
}
return $sql;
}
/**
* Walks down a StateFieldPathExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\PathExpression $stateFieldPathExpression
*
* @return string
*
* @not-deprecated
*/
public function walkStateFieldPathExpression($stateFieldPathExpression)
{
return $this->walkPathExpression($stateFieldPathExpression);
}
/**
* Walks down a ComparisonExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\ComparisonExpression $compExpr
*
* @return string
*
* @not-deprecated
*/
public function walkComparisonExpression($compExpr)
{
$leftExpr = $compExpr->leftExpression;
$rightExpr = $compExpr->rightExpression;
$sql = '';
$sql .= $leftExpr instanceof AST\Node
? $leftExpr->dispatch($this)
: (is_numeric($leftExpr) ? $leftExpr : $this->conn->quote($leftExpr));
$sql .= ' ' . $compExpr->operator . ' ';
$sql .= $rightExpr instanceof AST\Node
? $rightExpr->dispatch($this)
: (is_numeric($rightExpr) ? $rightExpr : $this->conn->quote($rightExpr));
return $sql;
}
/**
* Walks down an InputParameter AST node, thereby generating the appropriate SQL.
*
* @param AST\InputParameter $inputParam
*
* @return string
*
* @not-deprecated
*/
public function walkInputParameter($inputParam)
{
$this->parserResult->addParameterMapping($inputParam->name, $this->sqlParamIndex++);
$parameter = $this->query->getParameter($inputParam->name);
if ($parameter) {
$type = $parameter->getType();
if (Type::hasType($type)) {
return Type::getType($type)->convertToDatabaseValueSQL('?', $this->platform);
}
}
return '?';
}
/**
* Walks down an ArithmeticExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\ArithmeticExpression $arithmeticExpr
*
* @return string
*
* @not-deprecated
*/
public function walkArithmeticExpression($arithmeticExpr)
{
return $arithmeticExpr->isSimpleArithmeticExpression()
? $this->walkSimpleArithmeticExpression($arithmeticExpr->simpleArithmeticExpression)
: '(' . $this->walkSubselect($arithmeticExpr->subselect) . ')';
}
/**
* Walks down an SimpleArithmeticExpression AST node, thereby generating the appropriate SQL.
*
* @param AST\Node|string $simpleArithmeticExpr
*
* @return string
*
* @not-deprecated
*/
public function walkSimpleArithmeticExpression($simpleArithmeticExpr)
{
if (! ($simpleArithmeticExpr instanceof AST\SimpleArithmeticExpression)) {
return $this->walkArithmeticTerm($simpleArithmeticExpr);
}
return implode(' ', array_map([$this, 'walkArithmeticTerm'], $simpleArithmeticExpr->arithmeticTerms));
}
/**
* Walks down an ArithmeticTerm AST node, thereby generating the appropriate SQL.
*
* @param mixed $term
*
* @return string
*
* @not-deprecated
*/
public function walkArithmeticTerm($term)
{
if (is_string($term)) {
return isset($this->queryComponents[$term])
? $this->walkResultVariable($this->queryComponents[$term]['token']->value)
: $term;
}
// Phase 2 AST optimization: Skip processing of ArithmeticTerm
// if only one ArithmeticFactor is defined
if (! ($term instanceof AST\ArithmeticTerm)) {
return $this->walkArithmeticFactor($term);
}
return implode(' ', array_map([$this, 'walkArithmeticFactor'], $term->arithmeticFactors));
}
/**
* Walks down an ArithmeticFactor that represents an AST node, thereby generating the appropriate SQL.
*
* @param mixed $factor
*
* @return string
*
* @not-deprecated
*/
public function walkArithmeticFactor($factor)
{
if (is_string($factor)) {
return isset($this->queryComponents[$factor])
? $this->walkResultVariable($this->queryComponents[$factor]['token']->value)
: $factor;
}
// Phase 2 AST optimization: Skip processing of ArithmeticFactor
// if only one ArithmeticPrimary is defined
if (! ($factor instanceof AST\ArithmeticFactor)) {
return $this->walkArithmeticPrimary($factor);
}
$sign = $factor->isNegativeSigned() ? '-' : ($factor->isPositiveSigned() ? '+' : '');
return $sign . $this->walkArithmeticPrimary($factor->arithmeticPrimary);
}
/**
* Walks down an ArithmeticPrimary that represents an AST node, thereby generating the appropriate SQL.
*
* @param mixed $primary
*
* @return string The SQL.
*
* @not-deprecated
*/
public function walkArithmeticPrimary($primary)
{
if ($primary instanceof AST\SimpleArithmeticExpression) {
return '(' . $this->walkSimpleArithmeticExpression($primary) . ')';
}
if ($primary instanceof AST\Node) {
return $primary->dispatch($this);
}
return $this->walkEntityIdentificationVariable($primary);
}
/**
* Walks down a StringPrimary that represents an AST node, thereby generating the appropriate SQL.
*
* @param mixed $stringPrimary
*
* @return string
*
* @not-deprecated
*/
public function walkStringPrimary($stringPrimary)
{
return is_string($stringPrimary)
? $this->conn->quote($stringPrimary)
: $stringPrimary->dispatch($this);
}
/**
* Walks down a ResultVariable that represents an AST node, thereby generating the appropriate SQL.
*
* @param string $resultVariable
*
* @return string
*
* @not-deprecated
*/
public function walkResultVariable($resultVariable)
{
if (! isset($this->scalarResultAliasMap[$resultVariable])) {
throw new InvalidArgumentException(sprintf('Unknown result variable: %s', $resultVariable));
}
$resultAlias = $this->scalarResultAliasMap[$resultVariable];
if (is_array($resultAlias)) {
return implode(', ', $resultAlias);
}
return $resultAlias;
}
/**
* @return string The list in parentheses of valid child discriminators from the given class
*
* @throws QueryException
*/
private function getChildDiscriminatorsFromClassMetadata(
ClassMetadata $rootClass,
AST\InstanceOfExpression $instanceOfExpr
): string {
$sqlParameterList = [];
$discriminators = [];
foreach ($instanceOfExpr->value as $parameter) {
if ($parameter instanceof AST\InputParameter) {
$this->rsm->discriminatorParameters[$parameter->name] = $parameter->name;
$sqlParameterList[] = $this->walkInParameter($parameter);
continue;
}
$metadata = $this->em->getClassMetadata($parameter);
if ($metadata->getName() !== $rootClass->name && ! $metadata->getReflectionClass()->isSubclassOf($rootClass->name)) {
throw QueryException::instanceOfUnrelatedClass($parameter, $rootClass->name);
}
$discriminators += HierarchyDiscriminatorResolver::resolveDiscriminatorsForClass($metadata, $this->em);
}
foreach (array_keys($discriminators) as $dis) {
$sqlParameterList[] = $this->conn->quote($dis);
}
return '(' . implode(', ', $sqlParameterList) . ')';
}
}

vendor/doctrine/orm/src/Query/SqlWalker.php line 829