vendor/doctrine/orm/lib/Doctrine/ORM/Query/SqlWalker.php line 527

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM\Query;
  7. use BadMethodCallException;
  8. use Doctrine\DBAL\Connection;
  9. use Doctrine\DBAL\LockMode;
  10. use Doctrine\DBAL\Platforms\AbstractPlatform;
  11. use Doctrine\DBAL\Types\Type;
  12. use Doctrine\ORM\EntityManagerInterface;
  13. use Doctrine\ORM\Mapping\ClassMetadata;
  14. use Doctrine\ORM\Mapping\ClassMetadataInfo;
  15. use Doctrine\ORM\Mapping\QuoteStrategy;
  16. use Doctrine\ORM\OptimisticLockException;
  17. use Doctrine\ORM\Query;
  18. use Doctrine\ORM\Utility\HierarchyDiscriminatorResolver;
  19. use Doctrine\ORM\Utility\PersisterHelper;
  21. use function array_diff;
  22. use function array_filter;
  23. use function array_keys;
  24. use function array_map;
  25. use function array_merge;
  26. use function count;
  27. use function implode;
  28. use function in_array;
  29. use function is_array;
  30. use function is_float;
  31. use function is_numeric;
  32. use function is_string;
  33. use function preg_match;
  34. use function reset;
  35. use function sprintf;
  36. use function strtolower;
  37. use function strtoupper;
  38. use function trim;
  40. /**
  41.  * The SqlWalker is a TreeWalker that walks over a DQL AST and constructs
  42.  * the corresponding SQL.
  43.  */
  44. class SqlWalker implements TreeWalker
  45. {
  46.     public const HINT_DISTINCT = 'doctrine.distinct';
  48.     /**
  49.      * Used to mark a query as containing a PARTIAL expression, which needs to be known by SLC.
  50.      */
  51.     public const HINT_PARTIAL = 'doctrine.partial';
  53.     /** @var ResultSetMapping */
  54.     private $rsm;
  56.     /**
  57.      * Counter for generating unique column aliases.
  58.      *
  59.      * @var int
  60.      */
  61.     private $aliasCounter = 0;
  63.     /**
  64.      * Counter for generating unique table aliases.
  65.      *
  66.      * @var int
  67.      */
  68.     private $tableAliasCounter = 0;
  70.     /**
  71.      * Counter for generating unique scalar result.
  72.      *
  73.      * @var int
  74.      */
  75.     private $scalarResultCounter = 1;
  77.     /**
  78.      * Counter for generating unique parameter indexes.
  79.      *
  80.      * @var int
  81.      */
  82.     private $sqlParamIndex = 0;
  84.     /**
  85.      * Counter for generating indexes.
  86.      *
  87.      * @var int
  88.      */
  89.     private $newObjectCounter = 0;
  91.     /** @var ParserResult */
  92.     private $parserResult;
  94.     /** @var EntityManagerInterface */
  95.     private $em;
  97.     /** @var Connection */
  98.     private $conn;
  100.     /** @var Query */
  101.     private $query;
  103.     /** @var mixed[] */
  104.     private $tableAliasMap = [];
  106.     /**
  107.      * Map from result variable names to their SQL column alias names.
  108.      *
  109.      * @psalm-var array<string, string|list<string>>
  110.      */
  111.     private $scalarResultAliasMap = [];
  113.     /**
  114.      * Map from Table-Alias + Column-Name to OrderBy-Direction.
  115.      *
  116.      * @var array<string, string>
  117.      */
  118.     private $orderedColumnsMap = [];
  120.     /**
  121.      * Map from DQL-Alias + Field-Name to SQL Column Alias.
  122.      *
  123.      * @var array<string, array<string, string>>
  124.      */
  125.     private $scalarFields = [];
  127.     /**
  128.      * Map of all components/classes that appear in the DQL query.
  129.      *
  130.      * @psalm-var array<string, array{
  131.      *                metadata: ClassMetadata,
  132.      *                parent: string,
  133.      *                relation: mixed[],
  134.      *                map: mixed,
  135.      *                nestingLevel: int,
  136.      *                token: array
  137.      *            }>
  138.      */
  139.     private $queryComponents;
  141.     /**
  142.      * A list of classes that appear in non-scalar SelectExpressions.
  143.      *
  144.      * @psalm-var list<array{class: ClassMetadata, dqlAlias: string, resultAlias: string}>
  145.      */
  146.     private $selectedClasses = [];
  148.     /**
  149.      * The DQL alias of the root class of the currently traversed query.
  150.      *
  151.      * @psalm-var list<string>
  152.      */
  153.     private $rootAliases = [];
  155.     /**
  156.      * Flag that indicates whether to generate SQL table aliases in the SQL.
  157.      * These should only be generated for SELECT queries, not for UPDATE/DELETE.
  158.      *
  159.      * @var bool
  160.      */
  161.     private $useSqlTableAliases = true;
  163.     /**
  164.      * The database platform abstraction.
  165.      *
  166.      * @var AbstractPlatform
  167.      */
  168.     private $platform;
  170.     /**
  171.      * The quote strategy.
  172.      *
  173.      * @var QuoteStrategy
  174.      */
  175.     private $quoteStrategy;
  177.     /**
  178.      * {@inheritDoc}
  179.      */
  180.     public function __construct($query, $parserResult, array $queryComponents)
  181.     {
  182.         $this->query           = $query;
  183.         $this->parserResult    = $parserResult;
  184.         $this->queryComponents = $queryComponents;
  185.         $this->rsm             = $parserResult->getResultSetMapping();
  186.         $this->em              = $query->getEntityManager();
  187.         $this->conn            = $this->em->getConnection();
  188.         $this->platform        = $this->conn->getDatabasePlatform();
  189.         $this->quoteStrategy   = $this->em->getConfiguration()->getQuoteStrategy();
  190.     }
  192.     /**
  193.      * Gets the Query instance used by the walker.
  194.      *
  195.      * @return Query
  196.      */
  197.     public function getQuery()
  198.     {
  199.         return $this->query;
  200.     }
  202.     /**
  203.      * Gets the Connection used by the walker.
  204.      *
  205.      * @return Connection
  206.      */
  207.     public function getConnection()
  208.     {
  209.         return $this->conn;
  210.     }
  212.     /**
  213.      * Gets the EntityManager used by the walker.
  214.      *
  215.      * @return EntityManagerInterface
  216.      */
  217.     public function getEntityManager()
  218.     {
  219.         return $this->em;
  220.     }
  222.     /**
  223.      * Gets the information about a single query component.
  224.      *
  225.      * @param string $dqlAlias The DQL alias.
  226.      *
  227.      * @return mixed[]
  228.      * @psalm-return array{
  229.      *     metadata: ClassMetadata,
  230.      *     parent: string,
  231.      *     relation: mixed[],
  232.      *     map: mixed,
  233.      *     nestingLevel: int,
  234.      *     token: array
  235.      * }
  236.      */
  237.     public function getQueryComponent($dqlAlias)
  238.     {
  239.         return $this->queryComponents[$dqlAlias];
  240.     }
  242.     /**
  243.      * {@inheritdoc}
  244.      */
  245.     public function getQueryComponents()
  246.     {
  247.         return $this->queryComponents;
  248.     }
  250.     /**
  251.      * {@inheritdoc}
  252.      */
  253.     public function setQueryComponent($dqlAlias, array $queryComponent)
  254.     {
  255.         $requiredKeys = ['metadata', 'parent', 'relation', 'map', 'nestingLevel', 'token'];
  257.         if (array_diff($requiredKeys, array_keys($queryComponent))) {
  258.             throw QueryException::invalidQueryComponent($dqlAlias);
  259.         }
  261.         $this->queryComponents[$dqlAlias] = $queryComponent;
  262.     }
  264.     /**
  265.      * {@inheritdoc}
  266.      */
  267.     public function getExecutor($AST)
  268.     {
  269.         switch (true) {
  270.             case $AST instanceof AST\DeleteStatement:
  271.                 $primaryClass = $this->em->getClassMetadata($AST->deleteClause->abstractSchemaName);
  273.                 return $primaryClass->isInheritanceTypeJoined()
  274.                     ? new Exec\MultiTableDeleteExecutor($AST, $this)
  275.                     : new Exec\SingleTableDeleteUpdateExecutor($AST, $this);
  277.             case $AST instanceof AST\UpdateStatement:
  278.                 $primaryClass = $this->em->getClassMetadata($AST->updateClause->abstractSchemaName);
  280.                 return $primaryClass->isInheritanceTypeJoined()
  281.                     ? new Exec\MultiTableUpdateExecutor($AST, $this)
  282.                     : new Exec\SingleTableDeleteUpdateExecutor($AST, $this);
  284.             default:
  285.                 return new Exec\SingleSelectExecutor($AST, $this);
  286.         }
  287.     }
  289.     /**
  290.      * Generates a unique, short SQL table alias.
  291.      *
  292.      * @param string $tableName Table name
  293.      * @param string $dqlAlias  The DQL alias.
  294.      *
  295.      * @return string Generated table alias.
  296.      */
  297.     public function getSQLTableAlias($tableName, $dqlAlias = '')
  298.     {
  299.         $tableName .= $dqlAlias ? '@[' . $dqlAlias . ']' : '';
  301.         if (! isset($this->tableAliasMap[$tableName])) {
  302.             $this->tableAliasMap[$tableName] = (preg_match('/[a-z]/i', $tableName[0]) ? strtolower($tableName[0]) : 't')
  303.                 . $this->tableAliasCounter++ . '_';
  304.         }
  306.         return $this->tableAliasMap[$tableName];
  307.     }
  309.     /**
  310.      * Forces the SqlWalker to use a specific alias for a table name, rather than
  311.      * generating an alias on its own.
  312.      *
  313.      * @param string $tableName
  314.      * @param string $alias
  315.      * @param string $dqlAlias
  316.      *
  317.      * @return string
  318.      */
  319.     public function setSQLTableAlias($tableName, $alias, $dqlAlias = '')
  320.     {
  321.         $tableName .= $dqlAlias ? '@[' . $dqlAlias . ']' : '';
  323.         $this->tableAliasMap[$tableName] = $alias;
  325.         return $alias;
  326.     }
  328.     /**
  329.      * Gets an SQL column alias for a column name.
  330.      *
  331.      * @param string $columnName
  332.      *
  333.      * @return string
  334.      */
  335.     public function getSQLColumnAlias($columnName)
  336.     {
  337.         return $this->quoteStrategy->getColumnAlias($columnName, $this->aliasCounter++, $this->platform);
  338.     }
  340.     /**
  341.      * Generates the SQL JOINs that are necessary for Class Table Inheritance
  342.      * for the given class.
  343.      *
  344.      * @param ClassMetadata $class    The class for which to generate the joins.
  345.      * @param string        $dqlAlias The DQL alias of the class.
  346.      *
  347.      * @return string The SQL.
  348.      */
  349.     private function generateClassTableInheritanceJoins(
  350.         ClassMetadata $class,
  351.         string $dqlAlias
  352.     ): string {
  353.         $sql = '';
  355.         $baseTableAlias = $this->getSQLTableAlias($class->getTableName(), $dqlAlias);
  357.         // INNER JOIN parent class tables
  358.         foreach ($class->parentClasses as $parentClassName) {
  359.             $parentClass = $this->em->getClassMetadata($parentClassName);
  360.             $tableAlias  = $this->getSQLTableAlias($parentClass->getTableName(), $dqlAlias);
  362.             // If this is a joined association we must use left joins to preserve the correct result.
  363.             $sql .= isset($this->queryComponents[$dqlAlias]['relation']) ? ' LEFT ' : ' INNER ';
  364.             $sql .= 'JOIN ' . $this->quoteStrategy->getTableName($parentClass, $this->platform) . ' ' . $tableAlias . ' ON ';
  366.             $sqlParts = [];
  368.             foreach ($this->quoteStrategy->getIdentifierColumnNames($class, $this->platform) as $columnName) {
  369.                 $sqlParts[] = $baseTableAlias . '.' . $columnName . ' = ' . $tableAlias . '.' . $columnName;
  370.             }
  372.             // Add filters on the root class
  373.             $sqlParts[] = $this->generateFilterConditionSQL($parentClass, $tableAlias);
  375.             $sql .= implode(' AND ', array_filter($sqlParts));
  376.         }
  378.         // Ignore subclassing inclusion if partial objects is disallowed
  379.         if ($this->query->getHint(Query::HINT_FORCE_PARTIAL_LOAD)) {
  380.             return $sql;
  381.         }
  383.         // LEFT JOIN child class tables
  384.         foreach ($class->subClasses as $subClassName) {
  385.             $subClass   = $this->em->getClassMetadata($subClassName);
  386.             $tableAlias = $this->getSQLTableAlias($subClass->getTableName(), $dqlAlias);
  388.             $sql .= ' LEFT JOIN ' . $this->quoteStrategy->getTableName($subClass, $this->platform) . ' ' . $tableAlias . ' ON ';
  390.             $sqlParts = [];
  392.             foreach ($this->quoteStrategy->getIdentifierColumnNames($subClass, $this->platform) as $columnName) {
  393.                 $sqlParts[] = $baseTableAlias . '.' . $columnName . ' = ' . $tableAlias . '.' . $columnName;
  394.             }
  396.             $sql .= implode(' AND ', $sqlParts);
  397.         }
  399.         return $sql;
  400.     }
  402.     private function generateOrderedCollectionOrderByItems(): string
  403.     {
  404.         $orderedColumns = [];
  406.         foreach ($this->selectedClasses as $selectedClass) {
  407.             $dqlAlias = $selectedClass['dqlAlias'];
  408.             $qComp    = $this->queryComponents[$dqlAlias];
  410.             if (! isset($qComp['relation']['orderBy'])) {
  411.                 continue;
  412.             }
  414.             $persister = $this->em->getUnitOfWork()->getEntityPersister($qComp['metadata']->name);
  416.             foreach ($qComp['relation']['orderBy'] as $fieldName => $orientation) {
  417.                 $columnName = $this->quoteStrategy->getColumnName($fieldName, $qComp['metadata'], $this->platform);
  418.                 $tableName  = $qComp['metadata']->isInheritanceTypeJoined()
  419.                     ? $persister->getOwningTable($fieldName)
  420.                     : $qComp['metadata']->getTableName();
  422.                 $orderedColumn = $this->getSQLTableAlias($tableName, $dqlAlias) . '.' . $columnName;
  424.                 // OrderByClause should replace an ordered relation. see - DDC-2475
  425.                 if (isset($this->orderedColumnsMap[$orderedColumn])) {
  426.                     continue;
  427.                 }
  429.                 $this->orderedColumnsMap[$orderedColumn] = $orientation;
  430.                 $orderedColumns[]                        = $orderedColumn . ' ' . $orientation;
  431.             }
  432.         }
  434.         return implode(', ', $orderedColumns);
  435.     }
  437.     /**
  438.      * Generates a discriminator column SQL condition for the class with the given DQL alias.
  439.      *
  440.      * @psalm-param list<string> $dqlAliases List of root DQL aliases to inspect for discriminator restrictions.
  441.      */
  442.     private function generateDiscriminatorColumnConditionSQL(array $dqlAliases): string
  443.     {
  444.         $sqlParts = [];
  446.         foreach ($dqlAliases as $dqlAlias) {
  447.             $class = $this->queryComponents[$dqlAlias]['metadata'];
  449.             if (! $class->isInheritanceTypeSingleTable()) {
  450.                 continue;
  451.             }
  453.             $conn   = $this->em->getConnection();
  454.             $values = [];
  456.             if ($class->discriminatorValue !== null) { // discriminators can be 0
  457.                 $values[] = $conn->quote($class->discriminatorValue);
  458.             }
  460.             foreach ($class->subClasses as $subclassName) {
  461.                 $values[] = $conn->quote($this->em->getClassMetadata($subclassName)->discriminatorValue);
  462.             }
  464.             $sqlTableAlias = $this->useSqlTableAliases
  465.                 ? $this->getSQLTableAlias($class->getTableName(), $dqlAlias) . '.'
  466.                 : '';
  468.             $sqlParts[] = $sqlTableAlias . $class->getDiscriminatorColumn()['name'] . ' IN (' . implode(', ', $values) . ')';
  469.         }
  471.         $sql = implode(' AND ', $sqlParts);
  473.         return count($sqlParts) > 1 ? '(' . $sql . ')' : $sql;
  474.     }
  476.     /**
  477.      * Generates the filter SQL for a given entity and table alias.
  478.      *
  479.      * @param ClassMetadata $targetEntity     Metadata of the target entity.
  480.      * @param string        $targetTableAlias The table alias of the joined/selected table.
  481.      *
  482.      * @return string The SQL query part to add to a query.
  483.      */
  484.     private function generateFilterConditionSQL(
  485.         ClassMetadata $targetEntity,
  486.         string $targetTableAlias
  487.     ): string {
  488.         if (! $this->em->hasFilters()) {
  489.             return '';
  490.         }
  492.         switch ($targetEntity->inheritanceType) {
  493.             case ClassMetadata::INHERITANCE_TYPE_NONE:
  494.                 break;
  495.             case ClassMetadata::INHERITANCE_TYPE_JOINED:
  496.                 // The classes in the inheritance will be added to the query one by one,
  497.                 // but only the root node is getting filtered
  498.                 if ($targetEntity->name !== $targetEntity->rootEntityName) {
  499.                     return '';
  500.                 }
  502.                 break;
  503.             case ClassMetadata::INHERITANCE_TYPE_SINGLE_TABLE:
  504.                 // With STI the table will only be queried once, make sure that the filters
  505.                 // are added to the root entity
  506.                 $targetEntity = $this->em->getClassMetadata($targetEntity->rootEntityName);
  507.                 break;
  508.             default:
  509.                 //@todo: throw exception?
  510.                 return '';
  511.         }
  513.         $filterClauses = [];
  514.         foreach ($this->em->getFilters()->getEnabledFilters() as $filter) {
  515.             $filterExpr = $filter->addFilterConstraint($targetEntity, $targetTableAlias);
  516.             if ($filterExpr !== '') {
  517.                 $filterClauses[] = '(' . $filterExpr . ')';
  518.             }
  519.         }
  521.         return implode(' AND ', $filterClauses);
  522.     }
  524.     /**
  525.      * {@inheritdoc}
  526.      */
  527.     public function walkSelectStatement(AST\SelectStatement $AST)
  528.     {
  529.         $limit    = $this->query->getMaxResults();
  530.         $offset   = $this->query->getFirstResult();
  531.         $lockMode = $this->query->getHint(Query::HINT_LOCK_MODE) ?: LockMode::NONE;
  532.         $sql      = $this->walkSelectClause($AST->selectClause)
  533.             . $this->walkFromClause($AST->fromClause)
  534.             . $this->walkWhereClause($AST->whereClause);
  536.         if ($AST->groupByClause) {
  537.             $sql .= $this->walkGroupByClause($AST->groupByClause);
  538.         }
  540.         if ($AST->havingClause) {
  541.             $sql .= $this->walkHavingClause($AST->havingClause);
  542.         }
  544.         if ($AST->orderByClause) {
  545.             $sql .= $this->walkOrderByClause($AST->orderByClause);
  546.         }
  548.         $orderBySql = $this->generateOrderedCollectionOrderByItems();
  549.         if (! $AST->orderByClause && $orderBySql) {
  550.             $sql .= ' ORDER BY ' . $orderBySql;
  551.         }
  553.         if ($limit !== null || $offset !== null) {
  554.             $sql = $this->platform->modifyLimitQuery($sql, $limit, $offset ?? 0);
  555.         }
  557.         if ($lockMode === LockMode::NONE) {
  558.             return $sql;
  559.         }
  561.         if ($lockMode === LockMode::PESSIMISTIC_READ) {
  562.             return $sql . ' ' . $this->platform->getReadLockSQL();
  563.         }
  565.         if ($lockMode === LockMode::PESSIMISTIC_WRITE) {
  566.             return $sql . ' ' . $this->platform->getWriteLockSQL();
  567.         }
  569.         if ($lockMode !== LockMode::OPTIMISTIC) {
  570.             throw QueryException::invalidLockMode();
  571.         }
  573.         foreach ($this->selectedClasses as $selectedClass) {
  574.             if (! $selectedClass['class']->isVersioned) {
  575.                 throw OptimisticLockException::lockFailed($selectedClass['class']->name);
  576.             }
  577.         }
  579.         return $sql;
  580.     }
  582.     /**
  583.      * {@inheritdoc}
  584.      */
  585.     public function walkUpdateStatement(AST\UpdateStatement $AST)
  586.     {
  587.         $this->useSqlTableAliases = false;
  588.         $this->rsm->isSelect      = false;
  590.         return $this->walkUpdateClause($AST->updateClause)
  591.             . $this->walkWhereClause($AST->whereClause);
  592.     }
  594.     /**
  595.      * {@inheritdoc}
  596.      */
  597.     public function walkDeleteStatement(AST\DeleteStatement $AST)
  598.     {
  599.         $this->useSqlTableAliases = false;
  600.         $this->rsm->isSelect      = false;
  602.         return $this->walkDeleteClause($AST->deleteClause)
  603.             . $this->walkWhereClause($AST->whereClause);
  604.     }
  606.     /**
  607.      * Walks down an IdentificationVariable AST node, thereby generating the appropriate SQL.
  608.      * This one differs of ->walkIdentificationVariable() because it generates the entity identifiers.
  609.      *
  610.      * @param string $identVariable
  611.      *
  612.      * @return string
  613.      */
  614.     public function walkEntityIdentificationVariable($identVariable)
  615.     {
  616.         $class      = $this->queryComponents[$identVariable]['metadata'];
  617.         $tableAlias = $this->getSQLTableAlias($class->getTableName(), $identVariable);
  618.         $sqlParts   = [];
  620.         foreach ($this->quoteStrategy->getIdentifierColumnNames($class, $this->platform) as $columnName) {
  621.             $sqlParts[] = $tableAlias . '.' . $columnName;
  622.         }
  624.         return implode(', ', $sqlParts);
  625.     }
  627.     /**
  628.      * Walks down an IdentificationVariable (no AST node associated), thereby generating the SQL.
  629.      *
  630.      * @param string $identificationVariable
  631.      * @param string $fieldName
  632.      *
  633.      * @return string The SQL.
  634.      */
  635.     public function walkIdentificationVariable($identificationVariable, $fieldName = null)
  636.     {
  637.         $class = $this->queryComponents[$identificationVariable]['metadata'];
  639.         if (
  640.             $fieldName !== null && $class->isInheritanceTypeJoined() &&
  641.             isset($class->fieldMappings[$fieldName]['inherited'])
  642.         ) {
  643.             $class = $this->em->getClassMetadata($class->fieldMappings[$fieldName]['inherited']);
  644.         }
  646.         return $this->getSQLTableAlias($class->getTableName(), $identificationVariable);
  647.     }
  649.     /**
  650.      * {@inheritdoc}
  651.      */
  652.     public function walkPathExpression($pathExpr)
  653.     {
  654.         $sql = '';
  656.         switch ($pathExpr->type) {
  657.             case AST\PathExpression::TYPE_STATE_FIELD:
  658.                 $fieldName = $pathExpr->field;
  659.                 $dqlAlias  = $pathExpr->identificationVariable;
  660.                 $class     = $this->queryComponents[$dqlAlias]['metadata'];
  662.                 if ($this->useSqlTableAliases) {
  663.                     $sql .= $this->walkIdentificationVariable($dqlAlias, $fieldName) . '.';
  664.                 }
  666.                 $sql .= $this->quoteStrategy->getColumnName($fieldName, $class, $this->platform);
  667.                 break;
  669.             case AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION:
  670.                 // 1- the owning side:
  671.                 //    Just use the foreign key, i.e. u.group_id
  672.                 $fieldName = $pathExpr->field;
  673.                 $dqlAlias  = $pathExpr->identificationVariable;
  674.                 $class     = $this->queryComponents[$dqlAlias]['metadata'];
  676.                 if (isset($class->associationMappings[$fieldName]['inherited'])) {
  677.                     $class = $this->em->getClassMetadata($class->associationMappings[$fieldName]['inherited']);
  678.                 }
  680.                 $assoc = $class->associationMappings[$fieldName];
  682.                 if (! $assoc['isOwningSide']) {
  683.                     throw QueryException::associationPathInverseSideNotSupported($pathExpr);
  684.                 }
  686.                 // COMPOSITE KEYS NOT (YET?) SUPPORTED
  687.                 if (count($assoc['sourceToTargetKeyColumns']) > 1) {
  688.                     throw QueryException::associationPathCompositeKeyNotSupported();
  689.                 }
  691.                 if ($this->useSqlTableAliases) {
  692.                     $sql .= $this->getSQLTableAlias($class->getTableName(), $dqlAlias) . '.';
  693.                 }
  695.                 $sql .= reset($assoc['targetToSourceKeyColumns']);
  696.                 break;
  698.             default:
  699.                 throw QueryException::invalidPathExpression($pathExpr);
  700.         }
  702.         return $sql;
  703.     }
  705.     /**
  706.      * {@inheritdoc}
  707.      */
  708.     public function walkSelectClause($selectClause)
  709.     {
  710.         $sql                  = 'SELECT ' . ($selectClause->isDistinct ? 'DISTINCT ' : '');
  711.         $sqlSelectExpressions = array_filter(array_map([$this, 'walkSelectExpression'], $selectClause->selectExpressions));
  713.         if ($this->query->getHint(Query::HINT_INTERNAL_ITERATION) === true && $selectClause->isDistinct) {
  714.             $this->query->setHint(self::HINT_DISTINCT, true);
  715.         }
  717.         $addMetaColumns = ! $this->query->getHint(Query::HINT_FORCE_PARTIAL_LOAD) &&
  718.             $this->query->getHydrationMode() === Query::HYDRATE_OBJECT
  719.             || $this->query->getHint(Query::HINT_INCLUDE_META_COLUMNS);
  721.         foreach ($this->selectedClasses as $selectedClass) {
  722.             $class       = $selectedClass['class'];
  723.             $dqlAlias    = $selectedClass['dqlAlias'];
  724.             $resultAlias = $selectedClass['resultAlias'];
  726.             // Register as entity or joined entity result
  727.             if ($this->queryComponents[$dqlAlias]['relation'] === null) {
  728.                 $this->rsm->addEntityResult($class->name, $dqlAlias, $resultAlias);
  729.             } else {
  730.                 $this->rsm->addJoinedEntityResult(
  731.                     $class->name,
  732.                     $dqlAlias,
  733.                     $this->queryComponents[$dqlAlias]['parent'],
  734.                     $this->queryComponents[$dqlAlias]['relation']['fieldName']
  735.                 );
  736.             }
  738.             if ($class->isInheritanceTypeSingleTable() || $class->isInheritanceTypeJoined()) {
  739.                 // Add discriminator columns to SQL
  740.                 $rootClass   = $this->em->getClassMetadata($class->rootEntityName);
  741.                 $tblAlias    = $this->getSQLTableAlias($rootClass->getTableName(), $dqlAlias);
  742.                 $discrColumn = $rootClass->getDiscriminatorColumn();
  743.                 $columnAlias = $this->getSQLColumnAlias($discrColumn['name']);
  745.                 $sqlSelectExpressions[] = $tblAlias . '.' . $discrColumn['name'] . ' AS ' . $columnAlias;
  747.                 $this->rsm->setDiscriminatorColumn($dqlAlias, $columnAlias);
  748.                 $this->rsm->addMetaResult($dqlAlias, $columnAlias, $discrColumn['fieldName'], false, $discrColumn['type']);
  749.             }
  751.             // Add foreign key columns to SQL, if necessary
  752.             if (! $addMetaColumns && ! $class->containsForeignIdentifier) {
  753.                 continue;
  754.             }
  756.             // Add foreign key columns of class and also parent classes
  757.             foreach ($class->associationMappings as $assoc) {
  758.                 if (
  759.                     ! ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE)
  760.                     || ( ! $addMetaColumns && ! isset($assoc['id']))
  761.                 ) {
  762.                     continue;
  763.                 }
  765.                 $targetClass   = $this->em->getClassMetadata($assoc['targetEntity']);
  766.                 $isIdentifier  = (isset($assoc['id']) && $assoc['id'] === true);
  767.                 $owningClass   = isset($assoc['inherited']) ? $this->em->getClassMetadata($assoc['inherited']) : $class;
  768.                 $sqlTableAlias = $this->getSQLTableAlias($owningClass->getTableName(), $dqlAlias);
  770.                 foreach ($assoc['joinColumns'] as $joinColumn) {
  771.                     $columnName  = $joinColumn['name'];
  772.                     $columnAlias = $this->getSQLColumnAlias($columnName);
  773.                     $columnType  = PersisterHelper::getTypeOfColumn($joinColumn['referencedColumnName'], $targetClass, $this->em);
  775.                     $quotedColumnName       = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
  776.                     $sqlSelectExpressions[] = $sqlTableAlias . '.' . $quotedColumnName . ' AS ' . $columnAlias;
  778.                     $this->rsm->addMetaResult($dqlAlias, $columnAlias, $columnName, $isIdentifier, $columnType);
  779.                 }
  780.             }
  782.             // Add foreign key columns to SQL, if necessary
  783.             if (! $addMetaColumns) {
  784.                 continue;
  785.             }
  787.             // Add foreign key columns of subclasses
  788.             foreach ($class->subClasses as $subClassName) {
  789.                 $subClass      = $this->em->getClassMetadata($subClassName);
  790.                 $sqlTableAlias = $this->getSQLTableAlias($subClass->getTableName(), $dqlAlias);
  792.                 foreach ($subClass->associationMappings as $assoc) {
  793.                     // Skip if association is inherited
  794.                     if (isset($assoc['inherited'])) {
  795.                         continue;
  796.                     }
  798.                     if ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE) {
  799.                         $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  801.                         foreach ($assoc['joinColumns'] as $joinColumn) {
  802.                             $columnName  = $joinColumn['name'];
  803.                             $columnAlias = $this->getSQLColumnAlias($columnName);
  804.                             $columnType  = PersisterHelper::getTypeOfColumn($joinColumn['referencedColumnName'], $targetClass, $this->em);
  806.                             $quotedColumnName       = $this->quoteStrategy->getJoinColumnName($joinColumn, $subClass, $this->platform);
  807.                             $sqlSelectExpressions[] = $sqlTableAlias . '.' . $quotedColumnName . ' AS ' . $columnAlias;
  809.                             $this->rsm->addMetaResult($dqlAlias, $columnAlias, $columnName, $subClass->isIdentifier($columnName), $columnType);
  810.                         }
  811.                     }
  812.                 }
  813.             }
  814.         }
  816.         return $sql . implode(', ', $sqlSelectExpressions);
  817.     }
  819.     /**
  820.      * {@inheritdoc}
  821.      */
  822.     public function walkFromClause($fromClause)
  823.     {
  824.         $identificationVarDecls = $fromClause->identificationVariableDeclarations;
  825.         $sqlParts               = [];
  827.         foreach ($identificationVarDecls as $identificationVariableDecl) {
  828.             $sqlParts[] = $this->walkIdentificationVariableDeclaration($identificationVariableDecl);
  829.         }
  831.         return ' FROM ' . implode(', ', $sqlParts);
  832.     }
  834.     /**
  835.      * Walks down a IdentificationVariableDeclaration AST node, thereby generating the appropriate SQL.
  836.      *
  837.      * @param AST\IdentificationVariableDeclaration $identificationVariableDecl
  838.      *
  839.      * @return string
  840.      */
  841.     public function walkIdentificationVariableDeclaration($identificationVariableDecl)
  842.     {
  843.         $sql = $this->walkRangeVariableDeclaration($identificationVariableDecl->rangeVariableDeclaration);
  845.         if ($identificationVariableDecl->indexBy) {
  846.             $this->walkIndexBy($identificationVariableDecl->indexBy);
  847.         }
  849.         foreach ($identificationVariableDecl->joins as $join) {
  850.             $sql .= $this->walkJoin($join);
  851.         }
  853.         return $sql;
  854.     }
  856.     /**
  857.      * Walks down a IndexBy AST node.
  858.      *
  859.      * @param AST\IndexBy $indexBy
  860.      *
  861.      * @return void
  862.      */
  863.     public function walkIndexBy($indexBy)
  864.     {
  865.         $pathExpression = $indexBy->singleValuedPathExpression;
  866.         $alias          = $pathExpression->identificationVariable;
  868.         switch ($pathExpression->type) {
  869.             case AST\PathExpression::TYPE_STATE_FIELD:
  870.                 $field = $pathExpression->field;
  871.                 break;
  873.             case AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION:
  874.                 // Just use the foreign key, i.e. u.group_id
  875.                 $fieldName = $pathExpression->field;
  876.                 $class     = $this->queryComponents[$alias]['metadata'];
  878.                 if (isset($class->associationMappings[$fieldName]['inherited'])) {
  879.                     $class = $this->em->getClassMetadata($class->associationMappings[$fieldName]['inherited']);
  880.                 }
  882.                 $association = $class->associationMappings[$fieldName];
  884.                 if (! $association['isOwningSide']) {
  885.                     throw QueryException::associationPathInverseSideNotSupported($pathExpression);
  886.                 }
  888.                 if (count($association['sourceToTargetKeyColumns']) > 1) {
  889.                     throw QueryException::associationPathCompositeKeyNotSupported();
  890.                 }
  892.                 $field = reset($association['targetToSourceKeyColumns']);
  893.                 break;
  895.             default:
  896.                 throw QueryException::invalidPathExpression($pathExpression);
  897.         }
  899.         if (isset($this->scalarFields[$alias][$field])) {
  900.             $this->rsm->addIndexByScalar($this->scalarFields[$alias][$field]);
  902.             return;
  903.         }
  905.         $this->rsm->addIndexBy($alias, $field);
  906.     }
  908.     /**
  909.      * Walks down a RangeVariableDeclaration AST node, thereby generating the appropriate SQL.
  910.      *
  911.      * @param AST\RangeVariableDeclaration $rangeVariableDeclaration
  912.      *
  913.      * @return string
  914.      */
  915.     public function walkRangeVariableDeclaration($rangeVariableDeclaration)
  916.     {
  917.         return $this->generateRangeVariableDeclarationSQL($rangeVariableDeclaration, false);
  918.     }
  920.     /**
  921.      * Generate appropriate SQL for RangeVariableDeclaration AST node
  922.      */
  923.     private function generateRangeVariableDeclarationSQL(
  924.         AST\RangeVariableDeclaration $rangeVariableDeclaration,
  925.         bool $buildNestedJoins
  926.     ): string {
  927.         $class    = $this->em->getClassMetadata($rangeVariableDeclaration->abstractSchemaName);
  928.         $dqlAlias = $rangeVariableDeclaration->aliasIdentificationVariable;
  930.         if ($rangeVariableDeclaration->isRoot) {
  931.             $this->rootAliases[] = $dqlAlias;
  932.         }
  934.         $sql = $this->platform->appendLockHint(
  935.             $this->quoteStrategy->getTableName($class, $this->platform) . ' ' .
  936.             $this->getSQLTableAlias($class->getTableName(), $dqlAlias),
  937.             $this->query->getHint(Query::HINT_LOCK_MODE) ?: LockMode::NONE
  938.         );
  940.         if (! $class->isInheritanceTypeJoined()) {
  941.             return $sql;
  942.         }
  944.         $classTableInheritanceJoins = $this->generateClassTableInheritanceJoins($class, $dqlAlias);
  946.         if (! $buildNestedJoins) {
  947.             return $sql . $classTableInheritanceJoins;
  948.         }
  950.         return $classTableInheritanceJoins === '' ? $sql : '(' . $sql . $classTableInheritanceJoins . ')';
  951.     }
  953.     /**
  954.      * Walks down a JoinAssociationDeclaration AST node, thereby generating the appropriate SQL.
  955.      *
  956.      * @param AST\JoinAssociationDeclaration $joinAssociationDeclaration
  957.      * @param int                            $joinType
  958.      * @param AST\ConditionalExpression      $condExpr
  959.      *
  960.      * @return string
  961.      *
  962.      * @throws QueryException
  963.      */
  964.     public function walkJoinAssociationDeclaration($joinAssociationDeclaration, $joinType = AST\Join::JOIN_TYPE_INNER, $condExpr = null)
  965.     {
  966.         $sql = '';
  968.         $associationPathExpression = $joinAssociationDeclaration->joinAssociationPathExpression;
  969.         $joinedDqlAlias            = $joinAssociationDeclaration->aliasIdentificationVariable;
  970.         $indexBy                   = $joinAssociationDeclaration->indexBy;
  972.         $relation        = $this->queryComponents[$joinedDqlAlias]['relation'];
  973.         $targetClass     = $this->em->getClassMetadata($relation['targetEntity']);
  974.         $sourceClass     = $this->em->getClassMetadata($relation['sourceEntity']);
  975.         $targetTableName = $this->quoteStrategy->getTableName($targetClass, $this->platform);
  977.         $targetTableAlias = $this->getSQLTableAlias($targetClass->getTableName(), $joinedDqlAlias);
  978.         $sourceTableAlias = $this->getSQLTableAlias($sourceClass->getTableName(), $associationPathExpression->identificationVariable);
  980.         // Ensure we got the owning side, since it has all mapping info
  981.         $assoc = ! $relation['isOwningSide'] ? $targetClass->associationMappings[$relation['mappedBy']] : $relation;
  983.         if ($this->query->getHint(Query::HINT_INTERNAL_ITERATION) === true && (! $this->query->getHint(self::HINT_DISTINCT) || isset($this->selectedClasses[$joinedDqlAlias]))) {
  984.             if ($relation['type'] === ClassMetadata::ONE_TO_MANY || $relation['type'] === ClassMetadata::MANY_TO_MANY) {
  985.                 throw QueryException::iterateWithFetchJoinNotAllowed($assoc);
  986.             }
  987.         }
  989.         $targetTableJoin = null;
  991.         // This condition is not checking ClassMetadata::MANY_TO_ONE, because by definition it cannot
  992.         // be the owning side and previously we ensured that $assoc is always the owning side of the associations.
  993.         // The owning side is necessary at this point because only it contains the JoinColumn information.
  994.         switch (true) {
  995.             case $assoc['type'] & ClassMetadata::TO_ONE:
  996.                 $conditions = [];
  998.                 foreach ($assoc['joinColumns'] as $joinColumn) {
  999.                     $quotedSourceColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $targetClass, $this->platform);
  1000.                     $quotedTargetColumn = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $targetClass, $this->platform);
  1002.                     if ($relation['isOwningSide']) {
  1003.                         $conditions[] = $sourceTableAlias . '.' . $quotedSourceColumn . ' = ' . $targetTableAlias . '.' . $quotedTargetColumn;
  1005.                         continue;
  1006.                     }
  1008.                     $conditions[] = $sourceTableAlias . '.' . $quotedTargetColumn . ' = ' . $targetTableAlias . '.' . $quotedSourceColumn;
  1009.                 }
  1011.                 // Apply remaining inheritance restrictions
  1012.                 $discrSql = $this->generateDiscriminatorColumnConditionSQL([$joinedDqlAlias]);
  1014.                 if ($discrSql) {
  1015.                     $conditions[] = $discrSql;
  1016.                 }
  1018.                 // Apply the filters
  1019.                 $filterExpr = $this->generateFilterConditionSQL($targetClass, $targetTableAlias);
  1021.                 if ($filterExpr) {
  1022.                     $conditions[] = $filterExpr;
  1023.                 }
  1025.                 $targetTableJoin = [
  1026.                     'table' => $targetTableName . ' ' . $targetTableAlias,
  1027.                     'condition' => implode(' AND ', $conditions),
  1028.                 ];
  1029.                 break;
  1031.             case $assoc['type'] === ClassMetadata::MANY_TO_MANY:
  1032.                 // Join relation table
  1033.                 $joinTable      = $assoc['joinTable'];
  1034.                 $joinTableAlias = $this->getSQLTableAlias($joinTable['name'], $joinedDqlAlias);
  1035.                 $joinTableName  = $this->quoteStrategy->getJoinTableName($assoc, $sourceClass, $this->platform);
  1037.                 $conditions      = [];
  1038.                 $relationColumns = $relation['isOwningSide']
  1039.                     ? $assoc['joinTable']['joinColumns']
  1040.                     : $assoc['joinTable']['inverseJoinColumns'];
  1042.                 foreach ($relationColumns as $joinColumn) {
  1043.                     $quotedSourceColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $targetClass, $this->platform);
  1044.                     $quotedTargetColumn = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $targetClass, $this->platform);
  1046.                     $conditions[] = $sourceTableAlias . '.' . $quotedTargetColumn . ' = ' . $joinTableAlias . '.' . $quotedSourceColumn;
  1047.                 }
  1049.                 $sql .= $joinTableName . ' ' . $joinTableAlias . ' ON ' . implode(' AND ', $conditions);
  1051.                 // Join target table
  1052.                 $sql .= $joinType === AST\Join::JOIN_TYPE_LEFT || $joinType === AST\Join::JOIN_TYPE_LEFTOUTER ? ' LEFT JOIN ' : ' INNER JOIN ';
  1054.                 $conditions      = [];
  1055.                 $relationColumns = $relation['isOwningSide']
  1056.                     ? $assoc['joinTable']['inverseJoinColumns']
  1057.                     : $assoc['joinTable']['joinColumns'];
  1059.                 foreach ($relationColumns as $joinColumn) {
  1060.                     $quotedSourceColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $targetClass, $this->platform);
  1061.                     $quotedTargetColumn = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $targetClass, $this->platform);
  1063.                     $conditions[] = $targetTableAlias . '.' . $quotedTargetColumn . ' = ' . $joinTableAlias . '.' . $quotedSourceColumn;
  1064.                 }
  1066.                 // Apply remaining inheritance restrictions
  1067.                 $discrSql = $this->generateDiscriminatorColumnConditionSQL([$joinedDqlAlias]);
  1069.                 if ($discrSql) {
  1070.                     $conditions[] = $discrSql;
  1071.                 }
  1073.                 // Apply the filters
  1074.                 $filterExpr = $this->generateFilterConditionSQL($targetClass, $targetTableAlias);
  1076.                 if ($filterExpr) {
  1077.                     $conditions[] = $filterExpr;
  1078.                 }
  1080.                 $targetTableJoin = [
  1081.                     'table' => $targetTableName . ' ' . $targetTableAlias,
  1082.                     'condition' => implode(' AND ', $conditions),
  1083.                 ];
  1084.                 break;
  1086.             default:
  1087.                 throw new BadMethodCallException('Type of association must be one of *_TO_ONE or MANY_TO_MANY');
  1088.         }
  1090.         // Handle WITH clause
  1091.         $withCondition = $condExpr === null ? '' : ('(' . $this->walkConditionalExpression($condExpr) . ')');
  1093.         if ($targetClass->isInheritanceTypeJoined()) {
  1094.             $ctiJoins = $this->generateClassTableInheritanceJoins($targetClass, $joinedDqlAlias);
  1095.             // If we have WITH condition, we need to build nested joins for target class table and cti joins
  1096.             if ($withCondition && $ctiJoins) {
  1097.                 $sql .= '(' . $targetTableJoin['table'] . $ctiJoins . ') ON ' . $targetTableJoin['condition'];
  1098.             } else {
  1099.                 $sql .= $targetTableJoin['table'] . ' ON ' . $targetTableJoin['condition'] . $ctiJoins;
  1100.             }
  1101.         } else {
  1102.             $sql .= $targetTableJoin['table'] . ' ON ' . $targetTableJoin['condition'];
  1103.         }
  1105.         if ($withCondition) {
  1106.             $sql .= ' AND ' . $withCondition;
  1107.         }
  1109.         // Apply the indexes
  1110.         if ($indexBy) {
  1111.             // For Many-To-One or One-To-One associations this obviously makes no sense, but is ignored silently.
  1112.             $this->walkIndexBy($indexBy);
  1113.         } elseif (isset($relation['indexBy'])) {
  1114.             $this->rsm->addIndexBy($joinedDqlAlias, $relation['indexBy']);
  1115.         }
  1117.         return $sql;
  1118.     }
  1120.     /**
  1121.      * {@inheritdoc}
  1122.      */
  1123.     public function walkFunction($function)
  1124.     {
  1125.         return $function->getSql($this);
  1126.     }
  1128.     /**
  1129.      * {@inheritdoc}
  1130.      */
  1131.     public function walkOrderByClause($orderByClause)
  1132.     {
  1133.         $orderByItems = array_map([$this, 'walkOrderByItem'], $orderByClause->orderByItems);
  1135.         $collectionOrderByItems = $this->generateOrderedCollectionOrderByItems();
  1136.         if ($collectionOrderByItems !== '') {
  1137.             $orderByItems = array_merge($orderByItems, (array) $collectionOrderByItems);
  1138.         }
  1140.         return ' ORDER BY ' . implode(', ', $orderByItems);
  1141.     }
  1143.     /**
  1144.      * {@inheritdoc}
  1145.      */
  1146.     public function walkOrderByItem($orderByItem)
  1147.     {
  1148.         $type = strtoupper($orderByItem->type);
  1149.         $expr = $orderByItem->expression;
  1150.         $sql  = $expr instanceof AST\Node
  1151.             ? $expr->dispatch($this)
  1152.             : $this->walkResultVariable($this->queryComponents[$expr]['token']['value']);
  1154.         $this->orderedColumnsMap[$sql] = $type;
  1156.         if ($expr instanceof AST\Subselect) {
  1157.             return '(' . $sql . ') ' . $type;
  1158.         }
  1160.         return $sql . ' ' . $type;
  1161.     }
  1163.     /**
  1164.      * {@inheritdoc}
  1165.      */
  1166.     public function walkHavingClause($havingClause)
  1167.     {
  1168.         return ' HAVING ' . $this->walkConditionalExpression($havingClause->conditionalExpression);
  1169.     }
  1171.     /**
  1172.      * {@inheritdoc}
  1173.      */
  1174.     public function walkJoin($join)
  1175.     {
  1176.         $joinType        = $join->joinType;
  1177.         $joinDeclaration = $join->joinAssociationDeclaration;
  1179.         $sql = $joinType === AST\Join::JOIN_TYPE_LEFT || $joinType === AST\Join::JOIN_TYPE_LEFTOUTER
  1180.             ? ' LEFT JOIN '
  1181.             : ' INNER JOIN ';
  1183.         switch (true) {
  1184.             case $joinDeclaration instanceof AST\RangeVariableDeclaration:
  1185.                 $class      = $this->em->getClassMetadata($joinDeclaration->abstractSchemaName);
  1186.                 $dqlAlias   = $joinDeclaration->aliasIdentificationVariable;
  1187.                 $tableAlias = $this->getSQLTableAlias($class->table['name'], $dqlAlias);
  1188.                 $conditions = [];
  1190.                 if ($join->conditionalExpression) {
  1191.                     $conditions[] = '(' . $this->walkConditionalExpression($join->conditionalExpression) . ')';
  1192.                 }
  1194.                 $isUnconditionalJoin = $conditions === [];
  1195.                 $condExprConjunction = $class->isInheritanceTypeJoined() && $joinType !== AST\Join::JOIN_TYPE_LEFT && $joinType !== AST\Join::JOIN_TYPE_LEFTOUTER && $isUnconditionalJoin
  1196.                     ? ' AND '
  1197.                     : ' ON ';
  1199.                 $sql .= $this->generateRangeVariableDeclarationSQL($joinDeclaration, ! $isUnconditionalJoin);
  1201.                 // Apply remaining inheritance restrictions
  1202.                 $discrSql = $this->generateDiscriminatorColumnConditionSQL([$dqlAlias]);
  1204.                 if ($discrSql) {
  1205.                     $conditions[] = $discrSql;
  1206.                 }
  1208.                 // Apply the filters
  1209.                 $filterExpr = $this->generateFilterConditionSQL($class, $tableAlias);
  1211.                 if ($filterExpr) {
  1212.                     $conditions[] = $filterExpr;
  1213.                 }
  1215.                 if ($conditions) {
  1216.                     $sql .= $condExprConjunction . implode(' AND ', $conditions);
  1217.                 }
  1219.                 break;
  1221.             case $joinDeclaration instanceof AST\JoinAssociationDeclaration:
  1222.                 $sql .= $this->walkJoinAssociationDeclaration($joinDeclaration, $joinType, $join->conditionalExpression);
  1223.                 break;
  1224.         }
  1226.         return $sql;
  1227.     }
  1229.     /**
  1230.      * Walks down a CoalesceExpression AST node and generates the corresponding SQL.
  1231.      *
  1232.      * @param AST\CoalesceExpression $coalesceExpression
  1233.      *
  1234.      * @return string The SQL.
  1235.      */
  1236.     public function walkCoalesceExpression($coalesceExpression)
  1237.     {
  1238.         $sql = 'COALESCE(';
  1240.         $scalarExpressions = [];
  1242.         foreach ($coalesceExpression->scalarExpressions as $scalarExpression) {
  1243.             $scalarExpressions[] = $this->walkSimpleArithmeticExpression($scalarExpression);
  1244.         }
  1246.         return $sql . implode(', ', $scalarExpressions) . ')';
  1247.     }
  1249.     /**
  1250.      * Walks down a NullIfExpression AST node and generates the corresponding SQL.
  1251.      *
  1252.      * @param AST\NullIfExpression $nullIfExpression
  1253.      *
  1254.      * @return string The SQL.
  1255.      */
  1256.     public function walkNullIfExpression($nullIfExpression)
  1257.     {
  1258.         $firstExpression = is_string($nullIfExpression->firstExpression)
  1259.             ? $this->conn->quote($nullIfExpression->firstExpression)
  1260.             : $this->walkSimpleArithmeticExpression($nullIfExpression->firstExpression);
  1262.         $secondExpression = is_string($nullIfExpression->secondExpression)
  1263.             ? $this->conn->quote($nullIfExpression->secondExpression)
  1264.             : $this->walkSimpleArithmeticExpression($nullIfExpression->secondExpression);
  1266.         return 'NULLIF(' . $firstExpression . ', ' . $secondExpression . ')';
  1267.     }
  1269.     /**
  1270.      * Walks down a GeneralCaseExpression AST node and generates the corresponding SQL.
  1271.      *
  1272.      * @return string The SQL.
  1273.      */
  1274.     public function walkGeneralCaseExpression(AST\GeneralCaseExpression $generalCaseExpression)
  1275.     {
  1276.         $sql = 'CASE';
  1278.         foreach ($generalCaseExpression->whenClauses as $whenClause) {
  1279.             $sql .= ' WHEN ' . $this->walkConditionalExpression($whenClause->caseConditionExpression);
  1280.             $sql .= ' THEN ' . $this->walkSimpleArithmeticExpression($whenClause->thenScalarExpression);
  1281.         }
  1283.         $sql .= ' ELSE ' . $this->walkSimpleArithmeticExpression($generalCaseExpression->elseScalarExpression) . ' END';
  1285.         return $sql;
  1286.     }
  1288.     /**
  1289.      * Walks down a SimpleCaseExpression AST node and generates the corresponding SQL.
  1290.      *
  1291.      * @param AST\SimpleCaseExpression $simpleCaseExpression
  1292.      *
  1293.      * @return string The SQL.
  1294.      */
  1295.     public function walkSimpleCaseExpression($simpleCaseExpression)
  1296.     {
  1297.         $sql = 'CASE ' . $this->walkStateFieldPathExpression($simpleCaseExpression->caseOperand);
  1299.         foreach ($simpleCaseExpression->simpleWhenClauses as $simpleWhenClause) {
  1300.             $sql .= ' WHEN ' . $this->walkSimpleArithmeticExpression($simpleWhenClause->caseScalarExpression);
  1301.             $sql .= ' THEN ' . $this->walkSimpleArithmeticExpression($simpleWhenClause->thenScalarExpression);
  1302.         }
  1304.         $sql .= ' ELSE ' . $this->walkSimpleArithmeticExpression($simpleCaseExpression->elseScalarExpression) . ' END';
  1306.         return $sql;
  1307.     }
  1309.     /**
  1310.      * {@inheritdoc}
  1311.      */
  1312.     public function walkSelectExpression($selectExpression)
  1313.     {
  1314.         $sql    = '';
  1315.         $expr   = $selectExpression->expression;
  1316.         $hidden = $selectExpression->hiddenAliasResultVariable;
  1318.         switch (true) {
  1319.             case $expr instanceof AST\PathExpression:
  1320.                 if ($expr->type !== AST\PathExpression::TYPE_STATE_FIELD) {
  1321.                     throw QueryException::invalidPathExpression($expr);
  1322.                 }
  1324.                 $fieldName = $expr->field;
  1325.                 $dqlAlias  = $expr->identificationVariable;
  1326.                 $qComp     = $this->queryComponents[$dqlAlias];
  1327.                 $class     = $qComp['metadata'];
  1329.                 $resultAlias = $selectExpression->fieldIdentificationVariable ?: $fieldName;
  1330.                 $tableName   = $class->isInheritanceTypeJoined()
  1331.                     ? $this->em->getUnitOfWork()->getEntityPersister($class->name)->getOwningTable($fieldName)
  1332.                     : $class->getTableName();
  1334.                 $sqlTableAlias = $this->getSQLTableAlias($tableName, $dqlAlias);
  1335.                 $fieldMapping  = $class->fieldMappings[$fieldName];
  1336.                 $columnName    = $this->quoteStrategy->getColumnName($fieldName, $class, $this->platform);
  1337.                 $columnAlias   = $this->getSQLColumnAlias($fieldMapping['columnName']);
  1338.                 $col           = $sqlTableAlias . '.' . $columnName;
  1340.                 if (isset($fieldMapping['requireSQLConversion'])) {
  1341.                     $type = Type::getType($fieldMapping['type']);
  1342.                     $col  = $type->convertToPHPValueSQL($col, $this->conn->getDatabasePlatform());
  1343.                 }
  1345.                 $sql .= $col . ' AS ' . $columnAlias;
  1347.                 $this->scalarResultAliasMap[$resultAlias] = $columnAlias;
  1349.                 if (! $hidden) {
  1350.                     $this->rsm->addScalarResult($columnAlias, $resultAlias, $fieldMapping['type']);
  1351.                     $this->scalarFields[$dqlAlias][$fieldName] = $columnAlias;
  1352.                 }
  1354.                 break;
  1356.             case $expr instanceof AST\AggregateExpression:
  1357.             case $expr instanceof AST\Functions\FunctionNode:
  1358.             case $expr instanceof AST\SimpleArithmeticExpression:
  1359.             case $expr instanceof AST\ArithmeticTerm:
  1360.             case $expr instanceof AST\ArithmeticFactor:
  1361.             case $expr instanceof AST\ParenthesisExpression:
  1362.             case $expr instanceof AST\Literal:
  1363.             case $expr instanceof AST\NullIfExpression:
  1364.             case $expr instanceof AST\CoalesceExpression:
  1365.             case $expr instanceof AST\GeneralCaseExpression:
  1366.             case $expr instanceof AST\SimpleCaseExpression:
  1367.                 $columnAlias = $this->getSQLColumnAlias('sclr');
  1368.                 $resultAlias = $selectExpression->fieldIdentificationVariable ?: $this->scalarResultCounter++;
  1370.                 $sql .= $expr->dispatch($this) . ' AS ' . $columnAlias;
  1372.                 $this->scalarResultAliasMap[$resultAlias] = $columnAlias;
  1374.                 if ($hidden) {
  1375.                     break;
  1376.                 }
  1378.                 if (! $expr instanceof Query\AST\TypedExpression) {
  1379.                     // Conceptually we could resolve field type here by traverse through AST to retrieve field type,
  1380.                     // but this is not a feasible solution; assume 'string'.
  1381.                     $this->rsm->addScalarResult($columnAlias, $resultAlias, 'string');
  1383.                     break;
  1384.                 }
  1386.                 $this->rsm->addScalarResult($columnAlias, $resultAlias, $expr->getReturnType()->getName());
  1388.                 break;
  1390.             case $expr instanceof AST\Subselect:
  1391.                 $columnAlias = $this->getSQLColumnAlias('sclr');
  1392.                 $resultAlias = $selectExpression->fieldIdentificationVariable ?: $this->scalarResultCounter++;
  1394.                 $sql .= '(' . $this->walkSubselect($expr) . ') AS ' . $columnAlias;
  1396.                 $this->scalarResultAliasMap[$resultAlias] = $columnAlias;
  1398.                 if (! $hidden) {
  1399.                     // We cannot resolve field type here; assume 'string'.
  1400.                     $this->rsm->addScalarResult($columnAlias, $resultAlias, 'string');
  1401.                 }
  1403.                 break;
  1405.             case $expr instanceof AST\NewObjectExpression:
  1406.                 $sql .= $this->walkNewObject($expr, $selectExpression->fieldIdentificationVariable);
  1407.                 break;
  1409.             default:
  1410.                 // IdentificationVariable or PartialObjectExpression
  1411.                 if ($expr instanceof AST\PartialObjectExpression) {
  1412.                     $this->query->setHint(self::HINT_PARTIAL, true);
  1414.                     $dqlAlias        = $expr->identificationVariable;
  1415.                     $partialFieldSet = $expr->partialFieldSet;
  1416.                 } else {
  1417.                     $dqlAlias        = $expr;
  1418.                     $partialFieldSet = [];
  1419.                 }
  1421.                 $queryComp   = $this->queryComponents[$dqlAlias];
  1422.                 $class       = $queryComp['metadata'];
  1423.                 $resultAlias = $selectExpression->fieldIdentificationVariable ?: null;
  1425.                 if (! isset($this->selectedClasses[$dqlAlias])) {
  1426.                     $this->selectedClasses[$dqlAlias] = [
  1427.                         'class'       => $class,
  1428.                         'dqlAlias'    => $dqlAlias,
  1429.                         'resultAlias' => $resultAlias,
  1430.                     ];
  1431.                 }
  1433.                 $sqlParts = [];
  1435.                 // Select all fields from the queried class
  1436.                 foreach ($class->fieldMappings as $fieldName => $mapping) {
  1437.                     if ($partialFieldSet && ! in_array($fieldName, $partialFieldSet, true)) {
  1438.                         continue;
  1439.                     }
  1441.                     $tableName = isset($mapping['inherited'])
  1442.                         ? $this->em->getClassMetadata($mapping['inherited'])->getTableName()
  1443.                         : $class->getTableName();
  1445.                     $sqlTableAlias    = $this->getSQLTableAlias($tableName, $dqlAlias);
  1446.                     $columnAlias      = $this->getSQLColumnAlias($mapping['columnName']);
  1447.                     $quotedColumnName = $this->quoteStrategy->getColumnName($fieldName, $class, $this->platform);
  1449.                     $col = $sqlTableAlias . '.' . $quotedColumnName;
  1451.                     if (isset($mapping['requireSQLConversion'])) {
  1452.                         $type = Type::getType($mapping['type']);
  1453.                         $col  = $type->convertToPHPValueSQL($col, $this->platform);
  1454.                     }
  1456.                     $sqlParts[] = $col . ' AS ' . $columnAlias;
  1458.                     $this->scalarResultAliasMap[$resultAlias][] = $columnAlias;
  1460.                     $this->rsm->addFieldResult($dqlAlias, $columnAlias, $fieldName, $class->name);
  1461.                 }
  1463.                 // Add any additional fields of subclasses (excluding inherited fields)
  1464.                 // 1) on Single Table Inheritance: always, since its marginal overhead
  1465.                 // 2) on Class Table Inheritance only if partial objects are disallowed,
  1466.                 //    since it requires outer joining subtables.
  1467.                 if ($class->isInheritanceTypeSingleTable() || ! $this->query->getHint(Query::HINT_FORCE_PARTIAL_LOAD)) {
  1468.                     foreach ($class->subClasses as $subClassName) {
  1469.                         $subClass      = $this->em->getClassMetadata($subClassName);
  1470.                         $sqlTableAlias = $this->getSQLTableAlias($subClass->getTableName(), $dqlAlias);
  1472.                         foreach ($subClass->fieldMappings as $fieldName => $mapping) {
  1473.                             if (isset($mapping['inherited']) || ($partialFieldSet && ! in_array($fieldName, $partialFieldSet, true))) {
  1474.                                 continue;
  1475.                             }
  1477.                             $columnAlias      = $this->getSQLColumnAlias($mapping['columnName']);
  1478.                             $quotedColumnName = $this->quoteStrategy->getColumnName($fieldName, $subClass, $this->platform);
  1480.                             $col = $sqlTableAlias . '.' . $quotedColumnName;
  1482.                             if (isset($mapping['requireSQLConversion'])) {
  1483.                                 $type = Type::getType($mapping['type']);
  1484.                                 $col  = $type->convertToPHPValueSQL($col, $this->platform);
  1485.                             }
  1487.                             $sqlParts[] = $col . ' AS ' . $columnAlias;
  1489.                             $this->scalarResultAliasMap[$resultAlias][] = $columnAlias;
  1491.                             $this->rsm->addFieldResult($dqlAlias, $columnAlias, $fieldName, $subClassName);
  1492.                         }
  1493.                     }
  1494.                 }
  1496.                 $sql .= implode(', ', $sqlParts);
  1497.         }
  1499.         return $sql;
  1500.     }
  1502.     /**
  1503.      * {@inheritdoc}
  1504.      */
  1505.     public function walkQuantifiedExpression($qExpr)
  1506.     {
  1507.         return ' ' . strtoupper($qExpr->type) . '(' . $this->walkSubselect($qExpr->subselect) . ')';
  1508.     }
  1510.     /**
  1511.      * {@inheritdoc}
  1512.      */
  1513.     public function walkSubselect($subselect)
  1514.     {
  1515.         $useAliasesBefore  = $this->useSqlTableAliases;
  1516.         $rootAliasesBefore = $this->rootAliases;
  1518.         $this->rootAliases        = []; // reset the rootAliases for the subselect
  1519.         $this->useSqlTableAliases = true;
  1521.         $sql  = $this->walkSimpleSelectClause($subselect->simpleSelectClause);
  1522.         $sql .= $this->walkSubselectFromClause($subselect->subselectFromClause);
  1523.         $sql .= $this->walkWhereClause($subselect->whereClause);
  1525.         $sql .= $subselect->groupByClause ? $this->walkGroupByClause($subselect->groupByClause) : '';
  1526.         $sql .= $subselect->havingClause ? $this->walkHavingClause($subselect->havingClause) : '';
  1527.         $sql .= $subselect->orderByClause ? $this->walkOrderByClause($subselect->orderByClause) : '';
  1529.         $this->rootAliases        = $rootAliasesBefore; // put the main aliases back
  1530.         $this->useSqlTableAliases = $useAliasesBefore;
  1532.         return $sql;
  1533.     }
  1535.     /**
  1536.      * {@inheritdoc}
  1537.      */
  1538.     public function walkSubselectFromClause($subselectFromClause)
  1539.     {
  1540.         $identificationVarDecls = $subselectFromClause->identificationVariableDeclarations;
  1541.         $sqlParts               = [];
  1543.         foreach ($identificationVarDecls as $subselectIdVarDecl) {
  1544.             $sqlParts[] = $this->walkIdentificationVariableDeclaration($subselectIdVarDecl);
  1545.         }
  1547.         return ' FROM ' . implode(', ', $sqlParts);
  1548.     }
  1550.     /**
  1551.      * {@inheritdoc}
  1552.      */
  1553.     public function walkSimpleSelectClause($simpleSelectClause)
  1554.     {
  1555.         return 'SELECT' . ($simpleSelectClause->isDistinct ? ' DISTINCT' : '')
  1556.             . $this->walkSimpleSelectExpression($simpleSelectClause->simpleSelectExpression);
  1557.     }
  1559.     /**
  1560.      * @return string
  1561.      */
  1562.     public function walkParenthesisExpression(AST\ParenthesisExpression $parenthesisExpression)
  1563.     {
  1564.         return sprintf('(%s)', $parenthesisExpression->expression->dispatch($this));
  1565.     }
  1567.     /**
  1568.      * @param AST\NewObjectExpression $newObjectExpression
  1569.      * @param string|null             $newObjectResultAlias
  1570.      *
  1571.      * @return string The SQL.
  1572.      */
  1573.     public function walkNewObject($newObjectExpression, $newObjectResultAlias = null)
  1574.     {
  1575.         $sqlSelectExpressions = [];
  1576.         $objIndex             = $newObjectResultAlias ?: $this->newObjectCounter++;
  1578.         foreach ($newObjectExpression->args as $argIndex => $e) {
  1579.             $resultAlias = $this->scalarResultCounter++;
  1580.             $columnAlias = $this->getSQLColumnAlias('sclr');
  1581.             $fieldType   = 'string';
  1583.             switch (true) {
  1584.                 case $e instanceof AST\NewObjectExpression:
  1585.                     $sqlSelectExpressions[] = $e->dispatch($this);
  1586.                     break;
  1588.                 case $e instanceof AST\Subselect:
  1589.                     $sqlSelectExpressions[] = '(' . $e->dispatch($this) . ') AS ' . $columnAlias;
  1590.                     break;
  1592.                 case $e instanceof AST\PathExpression:
  1593.                     $dqlAlias     = $e->identificationVariable;
  1594.                     $qComp        = $this->queryComponents[$dqlAlias];
  1595.                     $class        = $qComp['metadata'];
  1596.                     $fieldType    = $class->fieldMappings[$e->field]['type'];
  1597.                     $fieldName    = $e->field;
  1598.                     $fieldMapping = $class->fieldMappings[$fieldName];
  1599.                     $col          = trim($e->dispatch($this));
  1601.                     if (isset($fieldMapping['requireSQLConversion'])) {
  1602.                         $type = Type::getType($fieldType);
  1603.                         $col  = $type->convertToPHPValueSQL($col, $this->platform);
  1604.                     }
  1606.                     $sqlSelectExpressions[] = $col . ' AS ' . $columnAlias;
  1607.                     break;
  1609.                 case $e instanceof AST\Literal:
  1610.                     switch ($e->type) {
  1611.                         case AST\Literal::BOOLEAN:
  1612.                             $fieldType = 'boolean';
  1613.                             break;
  1615.                         case AST\Literal::NUMERIC:
  1616.                             $fieldType = is_float($e->value) ? 'float' : 'integer';
  1617.                             break;
  1618.                     }
  1620.                     $sqlSelectExpressions[] = trim($e->dispatch($this)) . ' AS ' . $columnAlias;
  1621.                     break;
  1623.                 default:
  1624.                     $sqlSelectExpressions[] = trim($e->dispatch($this)) . ' AS ' . $columnAlias;
  1625.                     break;
  1626.             }
  1628.             $this->scalarResultAliasMap[$resultAlias] = $columnAlias;
  1629.             $this->rsm->addScalarResult($columnAlias, $resultAlias, $fieldType);
  1631.             $this->rsm->newObjectMappings[$columnAlias] = [
  1632.                 'className' => $newObjectExpression->className,
  1633.                 'objIndex'  => $objIndex,
  1634.                 'argIndex'  => $argIndex,
  1635.             ];
  1636.         }
  1638.         return implode(', ', $sqlSelectExpressions);
  1639.     }
  1641.     /**
  1642.      * {@inheritdoc}
  1643.      */
  1644.     public function walkSimpleSelectExpression($simpleSelectExpression)
  1645.     {
  1646.         $expr = $simpleSelectExpression->expression;
  1647.         $sql  = ' ';
  1649.         switch (true) {
  1650.             case $expr instanceof AST\PathExpression:
  1651.                 $sql .= $this->walkPathExpression($expr);
  1652.                 break;
  1654.             case $expr instanceof AST\Subselect:
  1655.                 $alias = $simpleSelectExpression->fieldIdentificationVariable ?: $this->scalarResultCounter++;
  1657.                 $columnAlias                        = 'sclr' . $this->aliasCounter++;
  1658.                 $this->scalarResultAliasMap[$alias] = $columnAlias;
  1660.                 $sql .= '(' . $this->walkSubselect($expr) . ') AS ' . $columnAlias;
  1661.                 break;
  1663.             case $expr instanceof AST\Functions\FunctionNode:
  1664.             case $expr instanceof AST\SimpleArithmeticExpression:
  1665.             case $expr instanceof AST\ArithmeticTerm:
  1666.             case $expr instanceof AST\ArithmeticFactor:
  1667.             case $expr instanceof AST\Literal:
  1668.             case $expr instanceof AST\NullIfExpression:
  1669.             case $expr instanceof AST\CoalesceExpression:
  1670.             case $expr instanceof AST\GeneralCaseExpression:
  1671.             case $expr instanceof AST\SimpleCaseExpression:
  1672.                 $alias = $simpleSelectExpression->fieldIdentificationVariable ?: $this->scalarResultCounter++;
  1674.                 $columnAlias                        = $this->getSQLColumnAlias('sclr');
  1675.                 $this->scalarResultAliasMap[$alias] = $columnAlias;
  1677.                 $sql .= $expr->dispatch($this) . ' AS ' . $columnAlias;
  1678.                 break;
  1680.             case $expr instanceof AST\ParenthesisExpression:
  1681.                 $sql .= $this->walkParenthesisExpression($expr);
  1682.                 break;
  1684.             default: // IdentificationVariable
  1685.                 $sql .= $this->walkEntityIdentificationVariable($expr);
  1686.                 break;
  1687.         }
  1689.         return $sql;
  1690.     }
  1692.     /**
  1693.      * {@inheritdoc}
  1694.      */
  1695.     public function walkAggregateExpression($aggExpression)
  1696.     {
  1697.         return $aggExpression->functionName . '(' . ($aggExpression->isDistinct ? 'DISTINCT ' : '')
  1698.             . $this->walkSimpleArithmeticExpression($aggExpression->pathExpression) . ')';
  1699.     }
  1701.     /**
  1702.      * {@inheritdoc}
  1703.      */
  1704.     public function walkGroupByClause($groupByClause)
  1705.     {
  1706.         $sqlParts = [];
  1708.         foreach ($groupByClause->groupByItems as $groupByItem) {
  1709.             $sqlParts[] = $this->walkGroupByItem($groupByItem);
  1710.         }
  1712.         return ' GROUP BY ' . implode(', ', $sqlParts);
  1713.     }
  1715.     /**
  1716.      * {@inheritdoc}
  1717.      */
  1718.     public function walkGroupByItem($groupByItem)
  1719.     {
  1720.         // StateFieldPathExpression
  1721.         if (! is_string($groupByItem)) {
  1722.             return $this->walkPathExpression($groupByItem);
  1723.         }
  1725.         // ResultVariable
  1726.         if (isset($this->queryComponents[$groupByItem]['resultVariable'])) {
  1727.             $resultVariable = $this->queryComponents[$groupByItem]['resultVariable'];
  1729.             if ($resultVariable instanceof AST\PathExpression) {
  1730.                 return $this->walkPathExpression($resultVariable);
  1731.             }
  1733.             if (isset($resultVariable->pathExpression)) {
  1734.                 return $this->walkPathExpression($resultVariable->pathExpression);
  1735.             }
  1737.             return $this->walkResultVariable($groupByItem);
  1738.         }
  1740.         // IdentificationVariable
  1741.         $sqlParts = [];
  1743.         foreach ($this->queryComponents[$groupByItem]['metadata']->fieldNames as $field) {
  1744.             $item       = new AST\PathExpression(AST\PathExpression::TYPE_STATE_FIELD, $groupByItem, $field);
  1745.             $item->type = AST\PathExpression::TYPE_STATE_FIELD;
  1747.             $sqlParts[] = $this->walkPathExpression($item);
  1748.         }
  1750.         foreach ($this->queryComponents[$groupByItem]['metadata']->associationMappings as $mapping) {
  1751.             if ($mapping['isOwningSide'] && $mapping['type'] & ClassMetadataInfo::TO_ONE) {
  1752.                 $item       = new AST\PathExpression(AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION, $groupByItem, $mapping['fieldName']);
  1753.                 $item->type = AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION;
  1755.                 $sqlParts[] = $this->walkPathExpression($item);
  1756.             }
  1757.         }
  1759.         return implode(', ', $sqlParts);
  1760.     }
  1762.     /**
  1763.      * {@inheritdoc}
  1764.      */
  1765.     public function walkDeleteClause(AST\DeleteClause $deleteClause)
  1766.     {
  1767.         $class     = $this->em->getClassMetadata($deleteClause->abstractSchemaName);
  1768.         $tableName = $class->getTableName();
  1769.         $sql       = 'DELETE FROM ' . $this->quoteStrategy->getTableName($class, $this->platform);
  1771.         $this->setSQLTableAlias($tableName, $tableName, $deleteClause->aliasIdentificationVariable);
  1772.         $this->rootAliases[] = $deleteClause->aliasIdentificationVariable;
  1774.         return $sql;
  1775.     }
  1777.     /**
  1778.      * {@inheritdoc}
  1779.      */
  1780.     public function walkUpdateClause($updateClause)
  1781.     {
  1782.         $class     = $this->em->getClassMetadata($updateClause->abstractSchemaName);
  1783.         $tableName = $class->getTableName();
  1784.         $sql       = 'UPDATE ' . $this->quoteStrategy->getTableName($class, $this->platform);
  1786.         $this->setSQLTableAlias($tableName, $tableName, $updateClause->aliasIdentificationVariable);
  1787.         $this->rootAliases[] = $updateClause->aliasIdentificationVariable;
  1789.         return $sql . ' SET ' . implode(', ', array_map([$this, 'walkUpdateItem'], $updateClause->updateItems));
  1790.     }
  1792.     /**
  1793.      * {@inheritdoc}
  1794.      */
  1795.     public function walkUpdateItem($updateItem)
  1796.     {
  1797.         $useTableAliasesBefore    = $this->useSqlTableAliases;
  1798.         $this->useSqlTableAliases = false;
  1800.         $sql      = $this->walkPathExpression($updateItem->pathExpression) . ' = ';
  1801.         $newValue = $updateItem->newValue;
  1803.         switch (true) {
  1804.             case $newValue instanceof AST\Node:
  1805.                 $sql .= $newValue->dispatch($this);
  1806.                 break;
  1808.             case $newValue === null:
  1809.                 $sql .= 'NULL';
  1810.                 break;
  1812.             default:
  1813.                 $sql .= $this->conn->quote($newValue);
  1814.                 break;
  1815.         }
  1817.         $this->useSqlTableAliases = $useTableAliasesBefore;
  1819.         return $sql;
  1820.     }
  1822.     /**
  1823.      * {@inheritdoc}
  1824.      */
  1825.     public function walkWhereClause($whereClause)
  1826.     {
  1827.         $condSql  = $whereClause !== null ? $this->walkConditionalExpression($whereClause->conditionalExpression) : '';
  1828.         $discrSql = $this->generateDiscriminatorColumnConditionSQL($this->rootAliases);
  1830.         if ($this->em->hasFilters()) {
  1831.             $filterClauses = [];
  1832.             foreach ($this->rootAliases as $dqlAlias) {
  1833.                 $class      = $this->queryComponents[$dqlAlias]['metadata'];
  1834.                 $tableAlias = $this->getSQLTableAlias($class->table['name'], $dqlAlias);
  1836.                 $filterExpr = $this->generateFilterConditionSQL($class, $tableAlias);
  1837.                 if ($filterExpr) {
  1838.                     $filterClauses[] = $filterExpr;
  1839.                 }
  1840.             }
  1842.             if (count($filterClauses)) {
  1843.                 if ($condSql) {
  1844.                     $condSql = '(' . $condSql . ') AND ';
  1845.                 }
  1847.                 $condSql .= implode(' AND ', $filterClauses);
  1848.             }
  1849.         }
  1851.         if ($condSql) {
  1852.             return ' WHERE ' . (! $discrSql ? $condSql : '(' . $condSql . ') AND ' . $discrSql);
  1853.         }
  1855.         if ($discrSql) {
  1856.             return ' WHERE ' . $discrSql;
  1857.         }
  1859.         return '';
  1860.     }
  1862.     /**
  1863.      * {@inheritdoc}
  1864.      */
  1865.     public function walkConditionalExpression($condExpr)
  1866.     {
  1867.         // Phase 2 AST optimization: Skip processing of ConditionalExpression
  1868.         // if only one ConditionalTerm is defined
  1869.         if (! ($condExpr instanceof AST\ConditionalExpression)) {
  1870.             return $this->walkConditionalTerm($condExpr);
  1871.         }
  1873.         return implode(' OR ', array_map([$this, 'walkConditionalTerm'], $condExpr->conditionalTerms));
  1874.     }
  1876.     /**
  1877.      * {@inheritdoc}
  1878.      */
  1879.     public function walkConditionalTerm($condTerm)
  1880.     {
  1881.         // Phase 2 AST optimization: Skip processing of ConditionalTerm
  1882.         // if only one ConditionalFactor is defined
  1883.         if (! ($condTerm instanceof AST\ConditionalTerm)) {
  1884.             return $this->walkConditionalFactor($condTerm);
  1885.         }
  1887.         return implode(' AND ', array_map([$this, 'walkConditionalFactor'], $condTerm->conditionalFactors));
  1888.     }
  1890.     /**
  1891.      * {@inheritdoc}
  1892.      */
  1893.     public function walkConditionalFactor($factor)
  1894.     {
  1895.         // Phase 2 AST optimization: Skip processing of ConditionalFactor
  1896.         // if only one ConditionalPrimary is defined
  1897.         return ! ($factor instanceof AST\ConditionalFactor)
  1898.             ? $this->walkConditionalPrimary($factor)
  1899.             : ($factor->not ? 'NOT ' : '') . $this->walkConditionalPrimary($factor->conditionalPrimary);
  1900.     }
  1902.     /**
  1903.      * {@inheritdoc}
  1904.      */
  1905.     public function walkConditionalPrimary($primary)
  1906.     {
  1907.         if ($primary->isSimpleConditionalExpression()) {
  1908.             return $primary->simpleConditionalExpression->dispatch($this);
  1909.         }
  1911.         if ($primary->isConditionalExpression()) {
  1912.             $condExpr = $primary->conditionalExpression;
  1914.             return '(' . $this->walkConditionalExpression($condExpr) . ')';
  1915.         }
  1916.     }
  1918.     /**
  1919.      * {@inheritdoc}
  1920.      */
  1921.     public function walkExistsExpression($existsExpr)
  1922.     {
  1923.         $sql = $existsExpr->not ? 'NOT ' : '';
  1925.         $sql .= 'EXISTS (' . $this->walkSubselect($existsExpr->subselect) . ')';
  1927.         return $sql;
  1928.     }
  1930.     /**
  1931.      * {@inheritdoc}
  1932.      */
  1933.     public function walkCollectionMemberExpression($collMemberExpr)
  1934.     {
  1935.         $sql  = $collMemberExpr->not ? 'NOT ' : '';
  1936.         $sql .= 'EXISTS (SELECT 1 FROM ';
  1938.         $entityExpr   = $collMemberExpr->entityExpression;
  1939.         $collPathExpr = $collMemberExpr->collectionValuedPathExpression;
  1941.         $fieldName = $collPathExpr->field;
  1942.         $dqlAlias  = $collPathExpr->identificationVariable;
  1944.         $class = $this->queryComponents[$dqlAlias]['metadata'];
  1946.         switch (true) {
  1947.             // InputParameter
  1948.             case $entityExpr instanceof AST\InputParameter:
  1949.                 $dqlParamKey = $entityExpr->name;
  1950.                 $entitySql   = '?';
  1951.                 break;
  1953.             // SingleValuedAssociationPathExpression | IdentificationVariable
  1954.             case $entityExpr instanceof AST\PathExpression:
  1955.                 $entitySql = $this->walkPathExpression($entityExpr);
  1956.                 break;
  1958.             default:
  1959.                 throw new BadMethodCallException('Not implemented');
  1960.         }
  1962.         $assoc = $class->associationMappings[$fieldName];
  1964.         if ($assoc['type'] === ClassMetadata::ONE_TO_MANY) {
  1965.             $targetClass      = $this->em->getClassMetadata($assoc['targetEntity']);
  1966.             $targetTableAlias = $this->getSQLTableAlias($targetClass->getTableName());
  1967.             $sourceTableAlias = $this->getSQLTableAlias($class->getTableName(), $dqlAlias);
  1969.             $sql .= $this->quoteStrategy->getTableName($targetClass, $this->platform) . ' ' . $targetTableAlias . ' WHERE ';
  1971.             $owningAssoc = $targetClass->associationMappings[$assoc['mappedBy']];
  1972.             $sqlParts    = [];
  1974.             foreach ($owningAssoc['targetToSourceKeyColumns'] as $targetColumn => $sourceColumn) {
  1975.                 $targetColumn = $this->quoteStrategy->getColumnName($class->fieldNames[$targetColumn], $class, $this->platform);
  1977.                 $sqlParts[] = $sourceTableAlias . '.' . $targetColumn . ' = ' . $targetTableAlias . '.' . $sourceColumn;
  1978.             }
  1980.             foreach ($this->quoteStrategy->getIdentifierColumnNames($targetClass, $this->platform) as $targetColumnName) {
  1981.                 if (isset($dqlParamKey)) {
  1982.                     $this->parserResult->addParameterMapping($dqlParamKey, $this->sqlParamIndex++);
  1983.                 }
  1985.                 $sqlParts[] = $targetTableAlias . '.' . $targetColumnName . ' = ' . $entitySql;
  1986.             }
  1988.             $sql .= implode(' AND ', $sqlParts);
  1989.         } else { // many-to-many
  1990.             $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  1992.             $owningAssoc = $assoc['isOwningSide'] ? $assoc : $targetClass->associationMappings[$assoc['mappedBy']];
  1993.             $joinTable   = $owningAssoc['joinTable'];
  1995.             // SQL table aliases
  1996.             $joinTableAlias   = $this->getSQLTableAlias($joinTable['name']);
  1997.             $sourceTableAlias = $this->getSQLTableAlias($class->getTableName(), $dqlAlias);
  1999.             $sql .= $this->quoteStrategy->getJoinTableName($owningAssoc, $targetClass, $this->platform) . ' ' . $joinTableAlias . ' WHERE ';
  2001.             $joinColumns = $assoc['isOwningSide'] ? $joinTable['joinColumns'] : $joinTable['inverseJoinColumns'];
  2002.             $sqlParts    = [];
  2004.             foreach ($joinColumns as $joinColumn) {
  2005.                 $targetColumn = $this->quoteStrategy->getColumnName($class->fieldNames[$joinColumn['referencedColumnName']], $class, $this->platform);
  2007.                 $sqlParts[] = $joinTableAlias . '.' . $joinColumn['name'] . ' = ' . $sourceTableAlias . '.' . $targetColumn;
  2008.             }
  2010.             $joinColumns = $assoc['isOwningSide'] ? $joinTable['inverseJoinColumns'] : $joinTable['joinColumns'];
  2012.             foreach ($joinColumns as $joinColumn) {
  2013.                 if (isset($dqlParamKey)) {
  2014.                     $this->parserResult->addParameterMapping($dqlParamKey, $this->sqlParamIndex++);
  2015.                 }
  2017.                 $sqlParts[] = $joinTableAlias . '.' . $joinColumn['name'] . ' IN (' . $entitySql . ')';
  2018.             }
  2020.             $sql .= implode(' AND ', $sqlParts);
  2021.         }
  2023.         return $sql . ')';
  2024.     }
  2026.     /**
  2027.      * {@inheritdoc}
  2028.      */
  2029.     public function walkEmptyCollectionComparisonExpression($emptyCollCompExpr)
  2030.     {
  2031.         $sizeFunc                           = new AST\Functions\SizeFunction('size');
  2032.         $sizeFunc->collectionPathExpression = $emptyCollCompExpr->expression;
  2034.         return $sizeFunc->getSql($this) . ($emptyCollCompExpr->not ? ' > 0' : ' = 0');
  2035.     }
  2037.     /**
  2038.      * {@inheritdoc}
  2039.      */
  2040.     public function walkNullComparisonExpression($nullCompExpr)
  2041.     {
  2042.         $expression = $nullCompExpr->expression;
  2043.         $comparison = ' IS' . ($nullCompExpr->not ? ' NOT' : '') . ' NULL';
  2045.         // Handle ResultVariable
  2046.         if (is_string($expression) && isset($this->queryComponents[$expression]['resultVariable'])) {
  2047.             return $this->walkResultVariable($expression) . $comparison;
  2048.         }
  2050.         // Handle InputParameter mapping inclusion to ParserResult
  2051.         if ($expression instanceof AST\InputParameter) {
  2052.             return $this->walkInputParameter($expression) . $comparison;
  2053.         }
  2055.         return $expression->dispatch($this) . $comparison;
  2056.     }
  2058.     /**
  2059.      * {@inheritdoc}
  2060.      */
  2061.     public function walkInExpression($inExpr)
  2062.     {
  2063.         $sql = $this->walkArithmeticExpression($inExpr->expression) . ($inExpr->not ? ' NOT' : '') . ' IN (';
  2065.         $sql .= $inExpr->subselect
  2066.             ? $this->walkSubselect($inExpr->subselect)
  2067.             : implode(', ', array_map([$this, 'walkInParameter'], $inExpr->literals));
  2069.         $sql .= ')';
  2071.         return $sql;
  2072.     }
  2074.     /**
  2075.      * {@inheritdoc}
  2076.      *
  2077.      * @throws QueryException
  2078.      */
  2079.     public function walkInstanceOfExpression($instanceOfExpr)
  2080.     {
  2081.         $sql = '';
  2083.         $dqlAlias   = $instanceOfExpr->identificationVariable;
  2084.         $discrClass = $class = $this->queryComponents[$dqlAlias]['metadata'];
  2086.         if ($class->discriminatorColumn) {
  2087.             $discrClass = $this->em->getClassMetadata($class->rootEntityName);
  2088.         }
  2090.         if ($this->useSqlTableAliases) {
  2091.             $sql .= $this->getSQLTableAlias($discrClass->getTableName(), $dqlAlias) . '.';
  2092.         }
  2094.         $sql .= $class->getDiscriminatorColumn()['name'] . ($instanceOfExpr->not ? ' NOT IN ' : ' IN ');
  2095.         $sql .= $this->getChildDiscriminatorsFromClassMetadata($discrClass, $instanceOfExpr);
  2097.         return $sql;
  2098.     }
  2100.     /**
  2101.      * @param mixed $inParam
  2102.      *
  2103.      * @return string
  2104.      */
  2105.     public function walkInParameter($inParam)
  2106.     {
  2107.         return $inParam instanceof AST\InputParameter
  2108.             ? $this->walkInputParameter($inParam)
  2109.             : $this->walkArithmeticExpression($inParam);
  2110.     }
  2112.     /**
  2113.      * {@inheritdoc}
  2114.      */
  2115.     public function walkLiteral($literal)
  2116.     {
  2117.         switch ($literal->type) {
  2118.             case AST\Literal::STRING:
  2119.                 return $this->conn->quote($literal->value);
  2121.             case AST\Literal::BOOLEAN:
  2122.                 return (string) $this->conn->getDatabasePlatform()->convertBooleans(strtolower($literal->value) === 'true');
  2124.             case AST\Literal::NUMERIC:
  2125.                 return (string) $literal->value;
  2127.             default:
  2128.                 throw QueryException::invalidLiteral($literal);
  2129.         }
  2130.     }
  2132.     /**
  2133.      * {@inheritdoc}
  2134.      */
  2135.     public function walkBetweenExpression($betweenExpr)
  2136.     {
  2137.         $sql = $this->walkArithmeticExpression($betweenExpr->expression);
  2139.         if ($betweenExpr->not) {
  2140.             $sql .= ' NOT';
  2141.         }
  2143.         $sql .= ' BETWEEN ' . $this->walkArithmeticExpression($betweenExpr->leftBetweenExpression)
  2144.             . ' AND ' . $this->walkArithmeticExpression($betweenExpr->rightBetweenExpression);
  2146.         return $sql;
  2147.     }
  2149.     /**
  2150.      * {@inheritdoc}
  2151.      */
  2152.     public function walkLikeExpression($likeExpr)
  2153.     {
  2154.         $stringExpr = $likeExpr->stringExpression;
  2155.         $leftExpr   = is_string($stringExpr) && isset($this->queryComponents[$stringExpr]['resultVariable'])
  2156.             ? $this->walkResultVariable($stringExpr)
  2157.             : $stringExpr->dispatch($this);
  2159.         $sql = $leftExpr . ($likeExpr->not ? ' NOT' : '') . ' LIKE ';
  2161.         if ($likeExpr->stringPattern instanceof AST\InputParameter) {
  2162.             $sql .= $this->walkInputParameter($likeExpr->stringPattern);
  2163.         } elseif ($likeExpr->stringPattern instanceof AST\Functions\FunctionNode) {
  2164.             $sql .= $this->walkFunction($likeExpr->stringPattern);
  2165.         } elseif ($likeExpr->stringPattern instanceof AST\PathExpression) {
  2166.             $sql .= $this->walkPathExpression($likeExpr->stringPattern);
  2167.         } else {
  2168.             $sql .= $this->walkLiteral($likeExpr->stringPattern);
  2169.         }
  2171.         if ($likeExpr->escapeChar) {
  2172.             $sql .= ' ESCAPE ' . $this->walkLiteral($likeExpr->escapeChar);
  2173.         }
  2175.         return $sql;
  2176.     }
  2178.     /**
  2179.      * {@inheritdoc}
  2180.      */
  2181.     public function walkStateFieldPathExpression($stateFieldPathExpression)
  2182.     {
  2183.         return $this->walkPathExpression($stateFieldPathExpression);
  2184.     }
  2186.     /**
  2187.      * {@inheritdoc}
  2188.      */
  2189.     public function walkComparisonExpression($compExpr)
  2190.     {
  2191.         $leftExpr  = $compExpr->leftExpression;
  2192.         $rightExpr = $compExpr->rightExpression;
  2193.         $sql       = '';
  2195.         $sql .= $leftExpr instanceof AST\Node
  2196.             ? $leftExpr->dispatch($this)
  2197.             : (is_numeric($leftExpr) ? $leftExpr : $this->conn->quote($leftExpr));
  2199.         $sql .= ' ' . $compExpr->operator . ' ';
  2201.         $sql .= $rightExpr instanceof AST\Node
  2202.             ? $rightExpr->dispatch($this)
  2203.             : (is_numeric($rightExpr) ? $rightExpr : $this->conn->quote($rightExpr));
  2205.         return $sql;
  2206.     }
  2208.     /**
  2209.      * {@inheritdoc}
  2210.      */
  2211.     public function walkInputParameter($inputParam)
  2212.     {
  2213.         $this->parserResult->addParameterMapping($inputParam->name, $this->sqlParamIndex++);
  2215.         $parameter = $this->query->getParameter($inputParam->name);
  2217.         if ($parameter) {
  2218.             $type = $parameter->getType();
  2219.             if (Type::hasType($type)) {
  2220.                 return Type::getType($type)->convertToDatabaseValueSQL('?', $this->platform);
  2221.             }
  2222.         }
  2224.         return '?';
  2225.     }
  2227.     /**
  2228.      * {@inheritdoc}
  2229.      */
  2230.     public function walkArithmeticExpression($arithmeticExpr)
  2231.     {
  2232.         return $arithmeticExpr->isSimpleArithmeticExpression()
  2233.             ? $this->walkSimpleArithmeticExpression($arithmeticExpr->simpleArithmeticExpression)
  2234.             : '(' . $this->walkSubselect($arithmeticExpr->subselect) . ')';
  2235.     }
  2237.     /**
  2238.      * {@inheritdoc}
  2239.      */
  2240.     public function walkSimpleArithmeticExpression($simpleArithmeticExpr)
  2241.     {
  2242.         if (! ($simpleArithmeticExpr instanceof AST\SimpleArithmeticExpression)) {
  2243.             return $this->walkArithmeticTerm($simpleArithmeticExpr);
  2244.         }
  2246.         return implode(' ', array_map([$this, 'walkArithmeticTerm'], $simpleArithmeticExpr->arithmeticTerms));
  2247.     }
  2249.     /**
  2250.      * {@inheritdoc}
  2251.      */
  2252.     public function walkArithmeticTerm($term)
  2253.     {
  2254.         if (is_string($term)) {
  2255.             return isset($this->queryComponents[$term])
  2256.                 ? $this->walkResultVariable($this->queryComponents[$term]['token']['value'])
  2257.                 : $term;
  2258.         }
  2260.         // Phase 2 AST optimization: Skip processing of ArithmeticTerm
  2261.         // if only one ArithmeticFactor is defined
  2262.         if (! ($term instanceof AST\ArithmeticTerm)) {
  2263.             return $this->walkArithmeticFactor($term);
  2264.         }
  2266.         return implode(' ', array_map([$this, 'walkArithmeticFactor'], $term->arithmeticFactors));
  2267.     }
  2269.     /**
  2270.      * {@inheritdoc}
  2271.      */
  2272.     public function walkArithmeticFactor($factor)
  2273.     {
  2274.         if (is_string($factor)) {
  2275.             return isset($this->queryComponents[$factor])
  2276.                 ? $this->walkResultVariable($this->queryComponents[$factor]['token']['value'])
  2277.                 : $factor;
  2278.         }
  2280.         // Phase 2 AST optimization: Skip processing of ArithmeticFactor
  2281.         // if only one ArithmeticPrimary is defined
  2282.         if (! ($factor instanceof AST\ArithmeticFactor)) {
  2283.             return $this->walkArithmeticPrimary($factor);
  2284.         }
  2286.         $sign = $factor->isNegativeSigned() ? '-' : ($factor->isPositiveSigned() ? '+' : '');
  2288.         return $sign . $this->walkArithmeticPrimary($factor->arithmeticPrimary);
  2289.     }
  2291.     /**
  2292.      * Walks down an ArithmeticPrimary that represents an AST node, thereby generating the appropriate SQL.
  2293.      *
  2294.      * @param mixed $primary
  2295.      *
  2296.      * @return string The SQL.
  2297.      */
  2298.     public function walkArithmeticPrimary($primary)
  2299.     {
  2300.         if ($primary instanceof AST\SimpleArithmeticExpression) {
  2301.             return '(' . $this->walkSimpleArithmeticExpression($primary) . ')';
  2302.         }
  2304.         if ($primary instanceof AST\Node) {
  2305.             return $primary->dispatch($this);
  2306.         }
  2308.         return $this->walkEntityIdentificationVariable($primary);
  2309.     }
  2311.     /**
  2312.      * {@inheritdoc}
  2313.      */
  2314.     public function walkStringPrimary($stringPrimary)
  2315.     {
  2316.         return is_string($stringPrimary)
  2317.             ? $this->conn->quote($stringPrimary)
  2318.             : $stringPrimary->dispatch($this);
  2319.     }
  2321.     /**
  2322.      * {@inheritdoc}
  2323.      */
  2324.     public function walkResultVariable($resultVariable)
  2325.     {
  2326.         $resultAlias = $this->scalarResultAliasMap[$resultVariable];
  2328.         if (is_array($resultAlias)) {
  2329.             return implode(', ', $resultAlias);
  2330.         }
  2332.         return $resultAlias;
  2333.     }
  2335.     /**
  2336.      * @return string The list in parentheses of valid child discriminators from the given class
  2337.      *
  2338.      * @throws QueryException
  2339.      */
  2340.     private function getChildDiscriminatorsFromClassMetadata(
  2341.         ClassMetadataInfo $rootClass,
  2342.         AST\InstanceOfExpression $instanceOfExpr
  2343.     ): string {
  2344.         $sqlParameterList = [];
  2345.         $discriminators   = [];
  2346.         foreach ($instanceOfExpr->value as $parameter) {
  2347.             if ($parameter instanceof AST\InputParameter) {
  2348.                 $this->rsm->discriminatorParameters[$parameter->name] = $parameter->name;
  2349.                 $sqlParameterList[]                                   = $this->walkInParameter($parameter);
  2350.                 continue;
  2351.             }
  2353.             $metadata = $this->em->getClassMetadata($parameter);
  2355.             if ($metadata->getName() !== $rootClass->name && ! $metadata->getReflectionClass()->isSubclassOf($rootClass->name)) {
  2356.                 throw QueryException::instanceOfUnrelatedClass($parameter, $rootClass->name);
  2357.             }
  2359.             $discriminators += HierarchyDiscriminatorResolver::resolveDiscriminatorsForClass($metadata, $this->em);
  2360.         }
  2362.         foreach (array_keys($discriminators) as $dis) {
  2363.             $sqlParameterList[] = $this->conn->quote($dis);
  2364.         }
  2366.         return '(' . implode(', ', $sqlParameterList) . ')';
  2367.     }
  2368. }