vendor/doctrine/orm/lib/Doctrine/ORM/Query/Parser.php line 2908

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM\Query;
  7. use Doctrine\Common\Lexer\AbstractLexer;
  8. use Doctrine\Deprecations\Deprecation;
  9. use Doctrine\ORM\EntityManagerInterface;
  10. use Doctrine\ORM\Mapping\ClassMetadata;
  11. use Doctrine\ORM\Query;
  12. use Doctrine\ORM\Query\AST\AggregateExpression;
  13. use Doctrine\ORM\Query\AST\ArithmeticExpression;
  14. use Doctrine\ORM\Query\AST\ArithmeticFactor;
  15. use Doctrine\ORM\Query\AST\ArithmeticTerm;
  16. use Doctrine\ORM\Query\AST\BetweenExpression;
  17. use Doctrine\ORM\Query\AST\CoalesceExpression;
  18. use Doctrine\ORM\Query\AST\CollectionMemberExpression;
  19. use Doctrine\ORM\Query\AST\ComparisonExpression;
  20. use Doctrine\ORM\Query\AST\ConditionalPrimary;
  21. use Doctrine\ORM\Query\AST\DeleteClause;
  22. use Doctrine\ORM\Query\AST\DeleteStatement;
  23. use Doctrine\ORM\Query\AST\EmptyCollectionComparisonExpression;
  24. use Doctrine\ORM\Query\AST\ExistsExpression;
  25. use Doctrine\ORM\Query\AST\FromClause;
  26. use Doctrine\ORM\Query\AST\Functions;
  27. use Doctrine\ORM\Query\AST\Functions\FunctionNode;
  28. use Doctrine\ORM\Query\AST\GeneralCaseExpression;
  29. use Doctrine\ORM\Query\AST\GroupByClause;
  30. use Doctrine\ORM\Query\AST\HavingClause;
  31. use Doctrine\ORM\Query\AST\IdentificationVariableDeclaration;
  32. use Doctrine\ORM\Query\AST\IndexBy;
  33. use Doctrine\ORM\Query\AST\InExpression;
  34. use Doctrine\ORM\Query\AST\InputParameter;
  35. use Doctrine\ORM\Query\AST\InstanceOfExpression;
  36. use Doctrine\ORM\Query\AST\Join;
  37. use Doctrine\ORM\Query\AST\JoinAssociationPathExpression;
  38. use Doctrine\ORM\Query\AST\LikeExpression;
  39. use Doctrine\ORM\Query\AST\Literal;
  40. use Doctrine\ORM\Query\AST\NewObjectExpression;
  41. use Doctrine\ORM\Query\AST\Node;
  42. use Doctrine\ORM\Query\AST\NullComparisonExpression;
  43. use Doctrine\ORM\Query\AST\NullIfExpression;
  44. use Doctrine\ORM\Query\AST\OrderByClause;
  45. use Doctrine\ORM\Query\AST\OrderByItem;
  46. use Doctrine\ORM\Query\AST\PartialObjectExpression;
  47. use Doctrine\ORM\Query\AST\PathExpression;
  48. use Doctrine\ORM\Query\AST\QuantifiedExpression;
  49. use Doctrine\ORM\Query\AST\RangeVariableDeclaration;
  50. use Doctrine\ORM\Query\AST\SelectClause;
  51. use Doctrine\ORM\Query\AST\SelectExpression;
  52. use Doctrine\ORM\Query\AST\SelectStatement;
  53. use Doctrine\ORM\Query\AST\SimpleArithmeticExpression;
  54. use Doctrine\ORM\Query\AST\SimpleSelectClause;
  55. use Doctrine\ORM\Query\AST\SimpleSelectExpression;
  56. use Doctrine\ORM\Query\AST\SimpleWhenClause;
  57. use Doctrine\ORM\Query\AST\Subselect;
  58. use Doctrine\ORM\Query\AST\SubselectFromClause;
  59. use Doctrine\ORM\Query\AST\UpdateClause;
  60. use Doctrine\ORM\Query\AST\UpdateItem;
  61. use Doctrine\ORM\Query\AST\UpdateStatement;
  62. use Doctrine\ORM\Query\AST\WhenClause;
  63. use Doctrine\ORM\Query\AST\WhereClause;
  64. use LogicException;
  65. use ReflectionClass;
  67. use function array_intersect;
  68. use function array_search;
  69. use function assert;
  70. use function call_user_func;
  71. use function class_exists;
  72. use function count;
  73. use function explode;
  74. use function implode;
  75. use function in_array;
  76. use function interface_exists;
  77. use function is_string;
  78. use function sprintf;
  79. use function str_contains;
  80. use function strlen;
  81. use function strpos;
  82. use function strrpos;
  83. use function strtolower;
  84. use function substr;
  86. /**
  87.  * An LL(*) recursive-descent parser for the context-free grammar of the Doctrine Query Language.
  88.  * Parses a DQL query, reports any errors in it, and generates an AST.
  89.  *
  90.  * @psalm-import-type Token from AbstractLexer
  91.  * @psalm-type QueryComponent = array{
  92.  *                 metadata?: ClassMetadata<object>,
  93.  *                 parent?: string|null,
  94.  *                 relation?: mixed[]|null,
  95.  *                 map?: string|null,
  96.  *                 resultVariable?: AST\Node|string,
  97.  *                 nestingLevel: int,
  98.  *                 token: Token,
  99.  *             }
  100.  */
  101. class Parser
  102. {
  103.     /**
  104.      * @readonly Maps BUILT-IN string function names to AST class names.
  105.      * @psalm-var array<string, class-string<Functions\FunctionNode>>
  106.      */
  107.     private static $stringFunctions = [
  108.         'concat'    => Functions\ConcatFunction::class,
  109.         'substring' => Functions\SubstringFunction::class,
  110.         'trim'      => Functions\TrimFunction::class,
  111.         'lower'     => Functions\LowerFunction::class,
  112.         'upper'     => Functions\UpperFunction::class,
  113.         'identity'  => Functions\IdentityFunction::class,
  114.     ];
  116.     /**
  117.      * @readonly Maps BUILT-IN numeric function names to AST class names.
  118.      * @psalm-var array<string, class-string<Functions\FunctionNode>>
  119.      */
  120.     private static $numericFunctions = [
  121.         'length'    => Functions\LengthFunction::class,
  122.         'locate'    => Functions\LocateFunction::class,
  123.         'abs'       => Functions\AbsFunction::class,
  124.         'sqrt'      => Functions\SqrtFunction::class,
  125.         'mod'       => Functions\ModFunction::class,
  126.         'size'      => Functions\SizeFunction::class,
  127.         'date_diff' => Functions\DateDiffFunction::class,
  128.         'bit_and'   => Functions\BitAndFunction::class,
  129.         'bit_or'    => Functions\BitOrFunction::class,
  131.         // Aggregate functions
  132.         'min'       => Functions\MinFunction::class,
  133.         'max'       => Functions\MaxFunction::class,
  134.         'avg'       => Functions\AvgFunction::class,
  135.         'sum'       => Functions\SumFunction::class,
  136.         'count'     => Functions\CountFunction::class,
  137.     ];
  139.     /**
  140.      * @readonly Maps BUILT-IN datetime function names to AST class names.
  141.      * @psalm-var array<string, class-string<Functions\FunctionNode>>
  142.      */
  143.     private static $datetimeFunctions = [
  144.         'current_date'      => Functions\CurrentDateFunction::class,
  145.         'current_time'      => Functions\CurrentTimeFunction::class,
  146.         'current_timestamp' => Functions\CurrentTimestampFunction::class,
  147.         'date_add'          => Functions\DateAddFunction::class,
  148.         'date_sub'          => Functions\DateSubFunction::class,
  149.     ];
  151.     /*
  152.      * Expressions that were encountered during parsing of identifiers and expressions
  153.      * and still need to be validated.
  154.      */
  156.     /** @psalm-var list<array{token: Token|null, expression: mixed, nestingLevel: int}> */
  157.     private $deferredIdentificationVariables = [];
  159.     /** @psalm-var list<array{token: Token|null, expression: AST\PartialObjectExpression, nestingLevel: int}> */
  160.     private $deferredPartialObjectExpressions = [];
  162.     /** @psalm-var list<array{token: Token|null, expression: AST\PathExpression, nestingLevel: int}> */
  163.     private $deferredPathExpressions = [];
  165.     /** @psalm-var list<array{token: Token|null, expression: mixed, nestingLevel: int}> */
  166.     private $deferredResultVariables = [];
  168.     /** @psalm-var list<array{token: Token|null, expression: AST\NewObjectExpression, nestingLevel: int}> */
  169.     private $deferredNewObjectExpressions = [];
  171.     /**
  172.      * The lexer.
  173.      *
  174.      * @var Lexer
  175.      */
  176.     private $lexer;
  178.     /**
  179.      * The parser result.
  180.      *
  181.      * @var ParserResult
  182.      */
  183.     private $parserResult;
  185.     /**
  186.      * The EntityManager.
  187.      *
  188.      * @var EntityManagerInterface
  189.      */
  190.     private $em;
  192.     /**
  193.      * The Query to parse.
  194.      *
  195.      * @var Query
  196.      */
  197.     private $query;
  199.     /**
  200.      * Map of declared query components in the parsed query.
  201.      *
  202.      * @psalm-var array<string, QueryComponent>
  203.      */
  204.     private $queryComponents = [];
  206.     /**
  207.      * Keeps the nesting level of defined ResultVariables.
  208.      *
  209.      * @var int
  210.      */
  211.     private $nestingLevel = 0;
  213.     /**
  214.      * Any additional custom tree walkers that modify the AST.
  215.      *
  216.      * @psalm-var list<class-string<TreeWalker>>
  217.      */
  218.     private $customTreeWalkers = [];
  220.     /**
  221.      * The custom last tree walker, if any, that is responsible for producing the output.
  222.      *
  223.      * @var class-string<SqlWalker>|null
  224.      */
  225.     private $customOutputWalker;
  227.     /** @psalm-var array<string, AST\SelectExpression> */
  228.     private $identVariableExpressions = [];
  230.     /**
  231.      * Creates a new query parser object.
  232.      *
  233.      * @param Query $query The Query to parse.
  234.      */
  235.     public function __construct(Query $query)
  236.     {
  237.         $this->query        = $query;
  238.         $this->em           = $query->getEntityManager();
  239.         $this->lexer        = new Lexer((string) $query->getDQL());
  240.         $this->parserResult = new ParserResult();
  241.     }
  243.     /**
  244.      * Sets a custom tree walker that produces output.
  245.      * This tree walker will be run last over the AST, after any other walkers.
  246.      *
  247.      * @param string $className
  248.      * @psalm-param class-string<SqlWalker> $className
  249.      *
  250.      * @return void
  251.      */
  252.     public function setCustomOutputTreeWalker($className)
  253.     {
  254.         $this->customOutputWalker = $className;
  255.     }
  257.     /**
  258.      * Adds a custom tree walker for modifying the AST.
  259.      *
  260.      * @param string $className
  261.      * @psalm-param class-string<TreeWalker> $className
  262.      *
  263.      * @return void
  264.      */
  265.     public function addCustomTreeWalker($className)
  266.     {
  267.         $this->customTreeWalkers[] = $className;
  268.     }
  270.     /**
  271.      * Gets the lexer used by the parser.
  272.      *
  273.      * @return Lexer
  274.      */
  275.     public function getLexer()
  276.     {
  277.         return $this->lexer;
  278.     }
  280.     /**
  281.      * Gets the ParserResult that is being filled with information during parsing.
  282.      *
  283.      * @return ParserResult
  284.      */
  285.     public function getParserResult()
  286.     {
  287.         return $this->parserResult;
  288.     }
  290.     /**
  291.      * Gets the EntityManager used by the parser.
  292.      *
  293.      * @return EntityManagerInterface
  294.      */
  295.     public function getEntityManager()
  296.     {
  297.         return $this->em;
  298.     }
  300.     /**
  301.      * Parses and builds AST for the given Query.
  302.      *
  303.      * @return SelectStatement|UpdateStatement|DeleteStatement
  304.      */
  305.     public function getAST()
  306.     {
  307.         // Parse & build AST
  308.         $AST = $this->QueryLanguage();
  310.         // Process any deferred validations of some nodes in the AST.
  311.         // This also allows post-processing of the AST for modification purposes.
  312.         $this->processDeferredIdentificationVariables();
  314.         if ($this->deferredPartialObjectExpressions) {
  315.             $this->processDeferredPartialObjectExpressions();
  316.         }
  318.         if ($this->deferredPathExpressions) {
  319.             $this->processDeferredPathExpressions();
  320.         }
  322.         if ($this->deferredResultVariables) {
  323.             $this->processDeferredResultVariables();
  324.         }
  326.         if ($this->deferredNewObjectExpressions) {
  327.             $this->processDeferredNewObjectExpressions($AST);
  328.         }
  330.         $this->processRootEntityAliasSelected();
  332.         // TODO: Is there a way to remove this? It may impact the mixed hydration resultset a lot!
  333.         $this->fixIdentificationVariableOrder($AST);
  335.         return $AST;
  336.     }
  338.     /**
  339.      * Attempts to match the given token with the current lookahead token.
  340.      *
  341.      * If they match, updates the lookahead token; otherwise raises a syntax
  342.      * error.
  343.      *
  344.      * @param int $token The token type.
  345.      *
  346.      * @return void
  347.      *
  348.      * @throws QueryException If the tokens don't match.
  349.      */
  350.     public function match($token)
  351.     {
  352.         $lookaheadType = $this->lexer->lookahead['type'] ?? null;
  354.         // Short-circuit on first condition, usually types match
  355.         if ($lookaheadType === $token) {
  356.             $this->lexer->moveNext();
  358.             return;
  359.         }
  361.         // If parameter is not identifier (1-99) must be exact match
  362.         if ($token < Lexer::T_IDENTIFIER) {
  363.             $this->syntaxError($this->lexer->getLiteral($token));
  364.         }
  366.         // If parameter is keyword (200+) must be exact match
  367.         if ($token > Lexer::T_IDENTIFIER) {
  368.             $this->syntaxError($this->lexer->getLiteral($token));
  369.         }
  371.         // If parameter is T_IDENTIFIER, then matches T_IDENTIFIER (100) and keywords (200+)
  372.         if ($token === Lexer::T_IDENTIFIER && $lookaheadType < Lexer::T_IDENTIFIER) {
  373.             $this->syntaxError($this->lexer->getLiteral($token));
  374.         }
  376.         $this->lexer->moveNext();
  377.     }
  379.     /**
  380.      * Frees this parser, enabling it to be reused.
  381.      *
  382.      * @param bool $deep     Whether to clean peek and reset errors.
  383.      * @param int  $position Position to reset.
  384.      *
  385.      * @return void
  386.      */
  387.     public function free($deep = false, $position = 0)
  388.     {
  389.         // WARNING! Use this method with care. It resets the scanner!
  390.         $this->lexer->resetPosition($position);
  392.         // Deep = true cleans peek and also any previously defined errors
  393.         if ($deep) {
  394.             $this->lexer->resetPeek();
  395.         }
  397.         $this->lexer->token     = null;
  398.         $this->lexer->lookahead = null;
  399.     }
  401.     /**
  402.      * Parses a query string.
  403.      *
  404.      * @return ParserResult
  405.      */
  406.     public function parse()
  407.     {
  408.         $AST = $this->getAST();
  410.         $customWalkers = $this->query->getHint(Query::HINT_CUSTOM_TREE_WALKERS);
  411.         if ($customWalkers !== false) {
  412.             $this->customTreeWalkers = $customWalkers;
  413.         }
  415.         $customOutputWalker = $this->query->getHint(Query::HINT_CUSTOM_OUTPUT_WALKER);
  416.         if ($customOutputWalker !== false) {
  417.             $this->customOutputWalker = $customOutputWalker;
  418.         }
  420.         // Run any custom tree walkers over the AST
  421.         if ($this->customTreeWalkers) {
  422.             $treeWalkerChain = new TreeWalkerChain($this->query, $this->parserResult, $this->queryComponents);
  424.             foreach ($this->customTreeWalkers as $walker) {
  425.                 $treeWalkerChain->addTreeWalker($walker);
  426.             }
  428.             switch (true) {
  429.                 case $AST instanceof AST\UpdateStatement:
  430.                     $treeWalkerChain->walkUpdateStatement($AST);
  431.                     break;
  433.                 case $AST instanceof AST\DeleteStatement:
  434.                     $treeWalkerChain->walkDeleteStatement($AST);
  435.                     break;
  437.                 case $AST instanceof AST\SelectStatement:
  438.                 default:
  439.                     $treeWalkerChain->walkSelectStatement($AST);
  440.             }
  442.             $this->queryComponents = $treeWalkerChain->getQueryComponents();
  443.         }
  445.         $outputWalkerClass = $this->customOutputWalker ?: SqlWalker::class;
  446.         $outputWalker      = new $outputWalkerClass($this->query, $this->parserResult, $this->queryComponents);
  448.         // Assign an SQL executor to the parser result
  449.         $this->parserResult->setSqlExecutor($outputWalker->getExecutor($AST));
  451.         return $this->parserResult;
  452.     }
  454.     /**
  455.      * Fixes order of identification variables.
  456.      *
  457.      * They have to appear in the select clause in the same order as the
  458.      * declarations (from ... x join ... y join ... z ...) appear in the query
  459.      * as the hydration process relies on that order for proper operation.
  460.      *
  461.      * @param AST\SelectStatement|AST\DeleteStatement|AST\UpdateStatement $AST
  462.      */
  463.     private function fixIdentificationVariableOrder(Node $AST): void
  464.     {
  465.         if (count($this->identVariableExpressions) <= 1) {
  466.             return;
  467.         }
  469.         assert($AST instanceof AST\SelectStatement);
  471.         foreach ($this->queryComponents as $dqlAlias => $qComp) {
  472.             if (! isset($this->identVariableExpressions[$dqlAlias])) {
  473.                 continue;
  474.             }
  476.             $expr = $this->identVariableExpressions[$dqlAlias];
  477.             $key  = array_search($expr, $AST->selectClause->selectExpressions, true);
  479.             unset($AST->selectClause->selectExpressions[$key]);
  481.             $AST->selectClause->selectExpressions[] = $expr;
  482.         }
  483.     }
  485.     /**
  486.      * Generates a new syntax error.
  487.      *
  488.      * @param string       $expected Expected string.
  489.      * @param mixed[]|null $token    Got token.
  490.      * @psalm-param Token|null $token
  491.      *
  492.      * @return void
  493.      * @psalm-return no-return
  494.      *
  495.      * @throws QueryException
  496.      */
  497.     public function syntaxError($expected = '', $token = null)
  498.     {
  499.         if ($token === null) {
  500.             $token = $this->lexer->lookahead;
  501.         }
  503.         $tokenPos = $token['position'] ?? '-1';
  505.         $message  = sprintf('line 0, col %d: Error: ', $tokenPos);
  506.         $message .= $expected !== '' ? sprintf('Expected %s, got ', $expected) : 'Unexpected ';
  507.         $message .= $this->lexer->lookahead === null ? 'end of string.' : sprintf("'%s'", $token['value']);
  509.         throw QueryException::syntaxError($message, QueryException::dqlError($this->query->getDQL() ?? ''));
  510.     }
  512.     /**
  513.      * Generates a new semantical error.
  514.      *
  515.      * @param string       $message Optional message.
  516.      * @param mixed[]|null $token   Optional token.
  517.      * @psalm-param Token|null $token
  518.      *
  519.      * @return void
  520.      * @psalm-return no-return
  521.      *
  522.      * @throws QueryException
  523.      */
  524.     public function semanticalError($message = '', $token = null)
  525.     {
  526.         if ($token === null) {
  527.             $token = $this->lexer->lookahead ?? ['position' => 0];
  528.         }
  530.         // Minimum exposed chars ahead of token
  531.         $distance = 12;
  533.         // Find a position of a final word to display in error string
  534.         $dql    = $this->query->getDQL();
  535.         $length = strlen($dql);
  536.         $pos    = $token['position'] + $distance;
  537.         $pos    = strpos($dql, ' ', $length > $pos ? $pos : $length);
  538.         $length = $pos !== false ? $pos - $token['position'] : $distance;
  540.         $tokenPos = $token['position'] > 0 ? $token['position'] : '-1';
  541.         $tokenStr = substr($dql, $token['position'], $length);
  543.         // Building informative message
  544.         $message = 'line 0, col ' . $tokenPos . " near '" . $tokenStr . "': Error: " . $message;
  546.         throw QueryException::semanticalError($message, QueryException::dqlError($this->query->getDQL()));
  547.     }
  549.     /**
  550.      * Peeks beyond the matched closing parenthesis and returns the first token after that one.
  551.      *
  552.      * @param bool $resetPeek Reset peek after finding the closing parenthesis.
  553.      *
  554.      * @return mixed[]
  555.      * @psalm-return array{value: string, type: int|null|string, position: int}|null
  556.      */
  557.     private function peekBeyondClosingParenthesis(bool $resetPeek = true): ?array
  558.     {
  559.         $token        = $this->lexer->peek();
  560.         $numUnmatched = 1;
  562.         while ($numUnmatched > 0 && $token !== null) {
  563.             switch ($token['type']) {
  564.                 case Lexer::T_OPEN_PARENTHESIS:
  565.                     ++$numUnmatched;
  566.                     break;
  568.                 case Lexer::T_CLOSE_PARENTHESIS:
  569.                     --$numUnmatched;
  570.                     break;
  572.                 default:
  573.                     // Do nothing
  574.             }
  576.             $token = $this->lexer->peek();
  577.         }
  579.         if ($resetPeek) {
  580.             $this->lexer->resetPeek();
  581.         }
  583.         return $token;
  584.     }
  586.     /**
  587.      * Checks if the given token indicates a mathematical operator.
  588.      *
  589.      * @psalm-param Token|null $token
  590.      */
  591.     private function isMathOperator(?array $token): bool
  592.     {
  593.         return $token !== null && in_array($token['type'], [Lexer::T_PLUS, Lexer::T_MINUS, Lexer::T_DIVIDE, Lexer::T_MULTIPLY], true);
  594.     }
  596.     /**
  597.      * Checks if the next-next (after lookahead) token starts a function.
  598.      *
  599.      * @return bool TRUE if the next-next tokens start a function, FALSE otherwise.
  600.      */
  601.     private function isFunction(): bool
  602.     {
  603.         $lookaheadType = $this->lexer->lookahead['type'];
  604.         $peek          = $this->lexer->peek();
  606.         $this->lexer->resetPeek();
  608.         return $lookaheadType >= Lexer::T_IDENTIFIER && $peek !== null && $peek['type'] === Lexer::T_OPEN_PARENTHESIS;
  609.     }
  611.     /**
  612.      * Checks whether the given token type indicates an aggregate function.
  613.      *
  614.      * @psalm-param Lexer::T_* $tokenType
  615.      *
  616.      * @return bool TRUE if the token type is an aggregate function, FALSE otherwise.
  617.      */
  618.     private function isAggregateFunction(int $tokenType): bool
  619.     {
  620.         return in_array(
  621.             $tokenType,
  622.             [Lexer::T_AVG, Lexer::T_MIN, Lexer::T_MAX, Lexer::T_SUM, Lexer::T_COUNT],
  623.             true
  624.         );
  625.     }
  627.     /**
  628.      * Checks whether the current lookahead token of the lexer has the type T_ALL, T_ANY or T_SOME.
  629.      */
  630.     private function isNextAllAnySome(): bool
  631.     {
  632.         return in_array(
  633.             $this->lexer->lookahead['type'],
  634.             [Lexer::T_ALL, Lexer::T_ANY, Lexer::T_SOME],
  635.             true
  636.         );
  637.     }
  639.     /**
  640.      * Validates that the given <tt>IdentificationVariable</tt> is semantically correct.
  641.      * It must exist in query components list.
  642.      */
  643.     private function processDeferredIdentificationVariables(): void
  644.     {
  645.         foreach ($this->deferredIdentificationVariables as $deferredItem) {
  646.             $identVariable = $deferredItem['expression'];
  648.             // Check if IdentificationVariable exists in queryComponents
  649.             if (! isset($this->queryComponents[$identVariable])) {
  650.                 $this->semanticalError(
  651.                     sprintf("'%s' is not defined.", $identVariable),
  652.                     $deferredItem['token']
  653.                 );
  654.             }
  656.             $qComp = $this->queryComponents[$identVariable];
  658.             // Check if queryComponent points to an AbstractSchemaName or a ResultVariable
  659.             if (! isset($qComp['metadata'])) {
  660.                 $this->semanticalError(
  661.                     sprintf("'%s' does not point to a Class.", $identVariable),
  662.                     $deferredItem['token']
  663.                 );
  664.             }
  666.             // Validate if identification variable nesting level is lower or equal than the current one
  667.             if ($qComp['nestingLevel'] > $deferredItem['nestingLevel']) {
  668.                 $this->semanticalError(
  669.                     sprintf("'%s' is used outside the scope of its declaration.", $identVariable),
  670.                     $deferredItem['token']
  671.                 );
  672.             }
  673.         }
  674.     }
  676.     /**
  677.      * Validates that the given <tt>NewObjectExpression</tt>.
  678.      */
  679.     private function processDeferredNewObjectExpressions(SelectStatement $AST): void
  680.     {
  681.         foreach ($this->deferredNewObjectExpressions as $deferredItem) {
  682.             $expression    = $deferredItem['expression'];
  683.             $token         = $deferredItem['token'];
  684.             $className     = $expression->className;
  685.             $args          = $expression->args;
  686.             $fromClassName = $AST->fromClause->identificationVariableDeclarations[0]->rangeVariableDeclaration->abstractSchemaName ?? null;
  688.             // If the namespace is not given then assumes the first FROM entity namespace
  689.             if (! str_contains($className, '\\') && ! class_exists($className) && str_contains($fromClassName, '\\')) {
  690.                 $namespace = substr($fromClassName, 0, strrpos($fromClassName, '\\'));
  691.                 $fqcn      = $namespace . '\\' . $className;
  693.                 if (class_exists($fqcn)) {
  694.                     $expression->className = $fqcn;
  695.                     $className             = $fqcn;
  696.                 }
  697.             }
  699.             if (! class_exists($className)) {
  700.                 $this->semanticalError(sprintf('Class "%s" is not defined.', $className), $token);
  701.             }
  703.             $class = new ReflectionClass($className);
  705.             if (! $class->isInstantiable()) {
  706.                 $this->semanticalError(sprintf('Class "%s" can not be instantiated.', $className), $token);
  707.             }
  709.             if ($class->getConstructor() === null) {
  710.                 $this->semanticalError(sprintf('Class "%s" has not a valid constructor.', $className), $token);
  711.             }
  713.             if ($class->getConstructor()->getNumberOfRequiredParameters() > count($args)) {
  714.                 $this->semanticalError(sprintf('Number of arguments does not match with "%s" constructor declaration.', $className), $token);
  715.             }
  716.         }
  717.     }
  719.     /**
  720.      * Validates that the given <tt>PartialObjectExpression</tt> is semantically correct.
  721.      * It must exist in query components list.
  722.      */
  723.     private function processDeferredPartialObjectExpressions(): void
  724.     {
  725.         foreach ($this->deferredPartialObjectExpressions as $deferredItem) {
  726.             $expr  = $deferredItem['expression'];
  727.             $class = $this->getMetadataForDqlAlias($expr->identificationVariable);
  729.             foreach ($expr->partialFieldSet as $field) {
  730.                 if (isset($class->fieldMappings[$field])) {
  731.                     continue;
  732.                 }
  734.                 if (
  735.                     isset($class->associationMappings[$field]) &&
  736.                     $class->associationMappings[$field]['isOwningSide'] &&
  737.                     $class->associationMappings[$field]['type'] & ClassMetadata::TO_ONE
  738.                 ) {
  739.                     continue;
  740.                 }
  742.                 $this->semanticalError(sprintf(
  743.                     "There is no mapped field named '%s' on class %s.",
  744.                     $field,
  745.                     $class->name
  746.                 ), $deferredItem['token']);
  747.             }
  749.             if (array_intersect($class->identifier, $expr->partialFieldSet) !== $class->identifier) {
  750.                 $this->semanticalError(
  751.                     'The partial field selection of class ' . $class->name . ' must contain the identifier.',
  752.                     $deferredItem['token']
  753.                 );
  754.             }
  755.         }
  756.     }
  758.     /**
  759.      * Validates that the given <tt>ResultVariable</tt> is semantically correct.
  760.      * It must exist in query components list.
  761.      */
  762.     private function processDeferredResultVariables(): void
  763.     {
  764.         foreach ($this->deferredResultVariables as $deferredItem) {
  765.             $resultVariable = $deferredItem['expression'];
  767.             // Check if ResultVariable exists in queryComponents
  768.             if (! isset($this->queryComponents[$resultVariable])) {
  769.                 $this->semanticalError(
  770.                     sprintf("'%s' is not defined.", $resultVariable),
  771.                     $deferredItem['token']
  772.                 );
  773.             }
  775.             $qComp = $this->queryComponents[$resultVariable];
  777.             // Check if queryComponent points to an AbstractSchemaName or a ResultVariable
  778.             if (! isset($qComp['resultVariable'])) {
  779.                 $this->semanticalError(
  780.                     sprintf("'%s' does not point to a ResultVariable.", $resultVariable),
  781.                     $deferredItem['token']
  782.                 );
  783.             }
  785.             // Validate if identification variable nesting level is lower or equal than the current one
  786.             if ($qComp['nestingLevel'] > $deferredItem['nestingLevel']) {
  787.                 $this->semanticalError(
  788.                     sprintf("'%s' is used outside the scope of its declaration.", $resultVariable),
  789.                     $deferredItem['token']
  790.                 );
  791.             }
  792.         }
  793.     }
  795.     /**
  796.      * Validates that the given <tt>PathExpression</tt> is semantically correct for grammar rules:
  797.      *
  798.      * AssociationPathExpression             ::= CollectionValuedPathExpression | SingleValuedAssociationPathExpression
  799.      * SingleValuedPathExpression            ::= StateFieldPathExpression | SingleValuedAssociationPathExpression
  800.      * StateFieldPathExpression              ::= IdentificationVariable "." StateField
  801.      * SingleValuedAssociationPathExpression ::= IdentificationVariable "." SingleValuedAssociationField
  802.      * CollectionValuedPathExpression        ::= IdentificationVariable "." CollectionValuedAssociationField
  803.      */
  804.     private function processDeferredPathExpressions(): void
  805.     {
  806.         foreach ($this->deferredPathExpressions as $deferredItem) {
  807.             $pathExpression = $deferredItem['expression'];
  809.             $class = $this->getMetadataForDqlAlias($pathExpression->identificationVariable);
  811.             $field = $pathExpression->field;
  812.             if ($field === null) {
  813.                 $field = $pathExpression->field = $class->identifier[0];
  814.             }
  816.             // Check if field or association exists
  817.             if (! isset($class->associationMappings[$field]) && ! isset($class->fieldMappings[$field])) {
  818.                 $this->semanticalError(
  819.                     'Class ' . $class->name . ' has no field or association named ' . $field,
  820.                     $deferredItem['token']
  821.                 );
  822.             }
  824.             $fieldType = AST\PathExpression::TYPE_STATE_FIELD;
  826.             if (isset($class->associationMappings[$field])) {
  827.                 $assoc = $class->associationMappings[$field];
  829.                 $fieldType = $assoc['type'] & ClassMetadata::TO_ONE
  830.                     ? AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION
  831.                     : AST\PathExpression::TYPE_COLLECTION_VALUED_ASSOCIATION;
  832.             }
  834.             // Validate if PathExpression is one of the expected types
  835.             $expectedType = $pathExpression->expectedType;
  837.             if (! ($expectedType & $fieldType)) {
  838.                 // We need to recognize which was expected type(s)
  839.                 $expectedStringTypes = [];
  841.                 // Validate state field type
  842.                 if ($expectedType & AST\PathExpression::TYPE_STATE_FIELD) {
  843.                     $expectedStringTypes[] = 'StateFieldPathExpression';
  844.                 }
  846.                 // Validate single valued association (*-to-one)
  847.                 if ($expectedType & AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION) {
  848.                     $expectedStringTypes[] = 'SingleValuedAssociationField';
  849.                 }
  851.                 // Validate single valued association (*-to-many)
  852.                 if ($expectedType & AST\PathExpression::TYPE_COLLECTION_VALUED_ASSOCIATION) {
  853.                     $expectedStringTypes[] = 'CollectionValuedAssociationField';
  854.                 }
  856.                 // Build the error message
  857.                 $semanticalError  = 'Invalid PathExpression. ';
  858.                 $semanticalError .= count($expectedStringTypes) === 1
  859.                     ? 'Must be a ' . $expectedStringTypes[0] . '.'
  860.                     : implode(' or ', $expectedStringTypes) . ' expected.';
  862.                 $this->semanticalError($semanticalError, $deferredItem['token']);
  863.             }
  865.             // We need to force the type in PathExpression
  866.             $pathExpression->type = $fieldType;
  867.         }
  868.     }
  870.     private function processRootEntityAliasSelected(): void
  871.     {
  872.         if (! count($this->identVariableExpressions)) {
  873.             return;
  874.         }
  876.         foreach ($this->identVariableExpressions as $dqlAlias => $expr) {
  877.             if (isset($this->queryComponents[$dqlAlias]) && ! isset($this->queryComponents[$dqlAlias]['parent'])) {
  878.                 return;
  879.             }
  880.         }
  882.         $this->semanticalError('Cannot select entity through identification variables without choosing at least one root entity alias.');
  883.     }
  885.     /**
  886.      * QueryLanguage ::= SelectStatement | UpdateStatement | DeleteStatement
  887.      *
  888.      * @return SelectStatement|UpdateStatement|DeleteStatement
  889.      */
  890.     public function QueryLanguage()
  891.     {
  892.         $statement = null;
  894.         $this->lexer->moveNext();
  896.         switch ($this->lexer->lookahead['type'] ?? null) {
  897.             case Lexer::T_SELECT:
  898.                 $statement = $this->SelectStatement();
  899.                 break;
  901.             case Lexer::T_UPDATE:
  902.                 $statement = $this->UpdateStatement();
  903.                 break;
  905.             case Lexer::T_DELETE:
  906.                 $statement = $this->DeleteStatement();
  907.                 break;
  909.             default:
  910.                 $this->syntaxError('SELECT, UPDATE or DELETE');
  911.                 break;
  912.         }
  914.         // Check for end of string
  915.         if ($this->lexer->lookahead !== null) {
  916.             $this->syntaxError('end of string');
  917.         }
  919.         return $statement;
  920.     }
  922.     /**
  923.      * SelectStatement ::= SelectClause FromClause [WhereClause] [GroupByClause] [HavingClause] [OrderByClause]
  924.      *
  925.      * @return SelectStatement
  926.      */
  927.     public function SelectStatement()
  928.     {
  929.         $selectStatement = new AST\SelectStatement($this->SelectClause(), $this->FromClause());
  931.         $selectStatement->whereClause   = $this->lexer->isNextToken(Lexer::T_WHERE) ? $this->WhereClause() : null;
  932.         $selectStatement->groupByClause = $this->lexer->isNextToken(Lexer::T_GROUP) ? $this->GroupByClause() : null;
  933.         $selectStatement->havingClause  = $this->lexer->isNextToken(Lexer::T_HAVING) ? $this->HavingClause() : null;
  934.         $selectStatement->orderByClause = $this->lexer->isNextToken(Lexer::T_ORDER) ? $this->OrderByClause() : null;
  936.         return $selectStatement;
  937.     }
  939.     /**
  940.      * UpdateStatement ::= UpdateClause [WhereClause]
  941.      *
  942.      * @return UpdateStatement
  943.      */
  944.     public function UpdateStatement()
  945.     {
  946.         $updateStatement = new AST\UpdateStatement($this->UpdateClause());
  948.         $updateStatement->whereClause = $this->lexer->isNextToken(Lexer::T_WHERE) ? $this->WhereClause() : null;
  950.         return $updateStatement;
  951.     }
  953.     /**
  954.      * DeleteStatement ::= DeleteClause [WhereClause]
  955.      *
  956.      * @return DeleteStatement
  957.      */
  958.     public function DeleteStatement()
  959.     {
  960.         $deleteStatement = new AST\DeleteStatement($this->DeleteClause());
  962.         $deleteStatement->whereClause = $this->lexer->isNextToken(Lexer::T_WHERE) ? $this->WhereClause() : null;
  964.         return $deleteStatement;
  965.     }
  967.     /**
  968.      * IdentificationVariable ::= identifier
  969.      *
  970.      * @return string
  971.      */
  972.     public function IdentificationVariable()
  973.     {
  974.         $this->match(Lexer::T_IDENTIFIER);
  976.         $identVariable = $this->lexer->token['value'];
  978.         $this->deferredIdentificationVariables[] = [
  979.             'expression'   => $identVariable,
  980.             'nestingLevel' => $this->nestingLevel,
  981.             'token'        => $this->lexer->token,
  982.         ];
  984.         return $identVariable;
  985.     }
  987.     /**
  988.      * AliasIdentificationVariable = identifier
  989.      *
  990.      * @return string
  991.      */
  992.     public function AliasIdentificationVariable()
  993.     {
  994.         $this->match(Lexer::T_IDENTIFIER);
  996.         $aliasIdentVariable = $this->lexer->token['value'];
  997.         $exists             = isset($this->queryComponents[$aliasIdentVariable]);
  999.         if ($exists) {
  1000.             $this->semanticalError(
  1001.                 sprintf("'%s' is already defined.", $aliasIdentVariable),
  1002.                 $this->lexer->token
  1003.             );
  1004.         }
  1006.         return $aliasIdentVariable;
  1007.     }
  1009.     /**
  1010.      * AbstractSchemaName ::= fully_qualified_name | aliased_name | identifier
  1011.      *
  1012.      * @return string
  1013.      */
  1014.     public function AbstractSchemaName()
  1015.     {
  1016.         if ($this->lexer->isNextToken(Lexer::T_FULLY_QUALIFIED_NAME)) {
  1017.             $this->match(Lexer::T_FULLY_QUALIFIED_NAME);
  1019.             return $this->lexer->token['value'];
  1020.         }
  1022.         if ($this->lexer->isNextToken(Lexer::T_IDENTIFIER)) {
  1023.             $this->match(Lexer::T_IDENTIFIER);
  1025.             return $this->lexer->token['value'];
  1026.         }
  1028.         $this->match(Lexer::T_ALIASED_NAME);
  1030.         Deprecation::trigger(
  1031.             'doctrine/orm',
  1032.             'https://github.com/doctrine/orm/issues/8818',
  1033.             'Short namespace aliases such as "%s" are deprecated and will be removed in Doctrine ORM 3.0.',
  1034.             $this->lexer->token['value']
  1035.         );
  1037.         [$namespaceAlias, $simpleClassName] = explode(':', $this->lexer->token['value']);
  1039.         return $this->em->getConfiguration()->getEntityNamespace($namespaceAlias) . '\\' . $simpleClassName;
  1040.     }
  1042.     /**
  1043.      * Validates an AbstractSchemaName, making sure the class exists.
  1044.      *
  1045.      * @param string $schemaName The name to validate.
  1046.      *
  1047.      * @throws QueryException if the name does not exist.
  1048.      */
  1049.     private function validateAbstractSchemaName(string $schemaName): void
  1050.     {
  1051.         if (! (class_exists($schemaName, true) || interface_exists($schemaName, true))) {
  1052.             $this->semanticalError(
  1053.                 sprintf("Class '%s' is not defined.", $schemaName),
  1054.                 $this->lexer->token
  1055.             );
  1056.         }
  1057.     }
  1059.     /**
  1060.      * AliasResultVariable ::= identifier
  1061.      *
  1062.      * @return string
  1063.      */
  1064.     public function AliasResultVariable()
  1065.     {
  1066.         $this->match(Lexer::T_IDENTIFIER);
  1068.         $resultVariable = $this->lexer->token['value'];
  1069.         $exists         = isset($this->queryComponents[$resultVariable]);
  1071.         if ($exists) {
  1072.             $this->semanticalError(
  1073.                 sprintf("'%s' is already defined.", $resultVariable),
  1074.                 $this->lexer->token
  1075.             );
  1076.         }
  1078.         return $resultVariable;
  1079.     }
  1081.     /**
  1082.      * ResultVariable ::= identifier
  1083.      *
  1084.      * @return string
  1085.      */
  1086.     public function ResultVariable()
  1087.     {
  1088.         $this->match(Lexer::T_IDENTIFIER);
  1090.         $resultVariable = $this->lexer->token['value'];
  1092.         // Defer ResultVariable validation
  1093.         $this->deferredResultVariables[] = [
  1094.             'expression'   => $resultVariable,
  1095.             'nestingLevel' => $this->nestingLevel,
  1096.             'token'        => $this->lexer->token,
  1097.         ];
  1099.         return $resultVariable;
  1100.     }
  1102.     /**
  1103.      * JoinAssociationPathExpression ::= IdentificationVariable "." (CollectionValuedAssociationField | SingleValuedAssociationField)
  1104.      *
  1105.      * @return JoinAssociationPathExpression
  1106.      */
  1107.     public function JoinAssociationPathExpression()
  1108.     {
  1109.         $identVariable = $this->IdentificationVariable();
  1111.         if (! isset($this->queryComponents[$identVariable])) {
  1112.             $this->semanticalError(
  1113.                 'Identification Variable ' . $identVariable . ' used in join path expression but was not defined before.'
  1114.             );
  1115.         }
  1117.         $this->match(Lexer::T_DOT);
  1118.         $this->match(Lexer::T_IDENTIFIER);
  1120.         assert($this->lexer->token !== null);
  1121.         $field = $this->lexer->token['value'];
  1123.         // Validate association field
  1124.         $class = $this->getMetadataForDqlAlias($identVariable);
  1126.         if (! $class->hasAssociation($field)) {
  1127.             $this->semanticalError('Class ' . $class->name . ' has no association named ' . $field);
  1128.         }
  1130.         return new AST\JoinAssociationPathExpression($identVariable, $field);
  1131.     }
  1133.     /**
  1134.      * Parses an arbitrary path expression and defers semantical validation
  1135.      * based on expected types.
  1136.      *
  1137.      * PathExpression ::= IdentificationVariable {"." identifier}*
  1138.      *
  1139.      * @param int $expectedTypes
  1140.      * @psalm-param int-mask-of<PathExpression::TYPE_*> $expectedTypes
  1141.      *
  1142.      * @return PathExpression
  1143.      */
  1144.     public function PathExpression($expectedTypes)
  1145.     {
  1146.         $identVariable = $this->IdentificationVariable();
  1147.         $field         = null;
  1149.         if ($this->lexer->isNextToken(Lexer::T_DOT)) {
  1150.             $this->match(Lexer::T_DOT);
  1151.             $this->match(Lexer::T_IDENTIFIER);
  1153.             $field = $this->lexer->token['value'];
  1155.             while ($this->lexer->isNextToken(Lexer::T_DOT)) {
  1156.                 $this->match(Lexer::T_DOT);
  1157.                 $this->match(Lexer::T_IDENTIFIER);
  1158.                 $field .= '.' . $this->lexer->token['value'];
  1159.             }
  1160.         }
  1162.         // Creating AST node
  1163.         $pathExpr = new AST\PathExpression($expectedTypes, $identVariable, $field);
  1165.         // Defer PathExpression validation if requested to be deferred
  1166.         $this->deferredPathExpressions[] = [
  1167.             'expression'   => $pathExpr,
  1168.             'nestingLevel' => $this->nestingLevel,
  1169.             'token'        => $this->lexer->token,
  1170.         ];
  1172.         return $pathExpr;
  1173.     }
  1175.     /**
  1176.      * AssociationPathExpression ::= CollectionValuedPathExpression | SingleValuedAssociationPathExpression
  1177.      *
  1178.      * @return PathExpression
  1179.      */
  1180.     public function AssociationPathExpression()
  1181.     {
  1182.         return $this->PathExpression(
  1183.             AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION |
  1184.             AST\PathExpression::TYPE_COLLECTION_VALUED_ASSOCIATION
  1185.         );
  1186.     }
  1188.     /**
  1189.      * SingleValuedPathExpression ::= StateFieldPathExpression | SingleValuedAssociationPathExpression
  1190.      *
  1191.      * @return PathExpression
  1192.      */
  1193.     public function SingleValuedPathExpression()
  1194.     {
  1195.         return $this->PathExpression(
  1196.             AST\PathExpression::TYPE_STATE_FIELD |
  1197.             AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION
  1198.         );
  1199.     }
  1201.     /**
  1202.      * StateFieldPathExpression ::= IdentificationVariable "." StateField
  1203.      *
  1204.      * @return PathExpression
  1205.      */
  1206.     public function StateFieldPathExpression()
  1207.     {
  1208.         return $this->PathExpression(AST\PathExpression::TYPE_STATE_FIELD);
  1209.     }
  1211.     /**
  1212.      * SingleValuedAssociationPathExpression ::= IdentificationVariable "." SingleValuedAssociationField
  1213.      *
  1214.      * @return PathExpression
  1215.      */
  1216.     public function SingleValuedAssociationPathExpression()
  1217.     {
  1218.         return $this->PathExpression(AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION);
  1219.     }
  1221.     /**
  1222.      * CollectionValuedPathExpression ::= IdentificationVariable "." CollectionValuedAssociationField
  1223.      *
  1224.      * @return PathExpression
  1225.      */
  1226.     public function CollectionValuedPathExpression()
  1227.     {
  1228.         return $this->PathExpression(AST\PathExpression::TYPE_COLLECTION_VALUED_ASSOCIATION);
  1229.     }
  1231.     /**
  1232.      * SelectClause ::= "SELECT" ["DISTINCT"] SelectExpression {"," SelectExpression}
  1233.      *
  1234.      * @return SelectClause
  1235.      */
  1236.     public function SelectClause()
  1237.     {
  1238.         $isDistinct = false;
  1239.         $this->match(Lexer::T_SELECT);
  1241.         // Check for DISTINCT
  1242.         if ($this->lexer->isNextToken(Lexer::T_DISTINCT)) {
  1243.             $this->match(Lexer::T_DISTINCT);
  1245.             $isDistinct = true;
  1246.         }
  1248.         // Process SelectExpressions (1..N)
  1249.         $selectExpressions   = [];
  1250.         $selectExpressions[] = $this->SelectExpression();
  1252.         while ($this->lexer->isNextToken(Lexer::T_COMMA)) {
  1253.             $this->match(Lexer::T_COMMA);
  1255.             $selectExpressions[] = $this->SelectExpression();
  1256.         }
  1258.         return new AST\SelectClause($selectExpressions, $isDistinct);
  1259.     }
  1261.     /**
  1262.      * SimpleSelectClause ::= "SELECT" ["DISTINCT"] SimpleSelectExpression
  1263.      *
  1264.      * @return SimpleSelectClause
  1265.      */
  1266.     public function SimpleSelectClause()
  1267.     {
  1268.         $isDistinct = false;
  1269.         $this->match(Lexer::T_SELECT);
  1271.         if ($this->lexer->isNextToken(Lexer::T_DISTINCT)) {
  1272.             $this->match(Lexer::T_DISTINCT);
  1274.             $isDistinct = true;
  1275.         }
  1277.         return new AST\SimpleSelectClause($this->SimpleSelectExpression(), $isDistinct);
  1278.     }
  1280.     /**
  1281.      * UpdateClause ::= "UPDATE" AbstractSchemaName ["AS"] AliasIdentificationVariable "SET" UpdateItem {"," UpdateItem}*
  1282.      *
  1283.      * @return UpdateClause
  1284.      */
  1285.     public function UpdateClause()
  1286.     {
  1287.         $this->match(Lexer::T_UPDATE);
  1288.         assert($this->lexer->lookahead !== null);
  1290.         $token              = $this->lexer->lookahead;
  1291.         $abstractSchemaName = $this->AbstractSchemaName();
  1293.         $this->validateAbstractSchemaName($abstractSchemaName);
  1295.         if ($this->lexer->isNextToken(Lexer::T_AS)) {
  1296.             $this->match(Lexer::T_AS);
  1297.         }
  1299.         $aliasIdentificationVariable = $this->AliasIdentificationVariable();
  1301.         $class = $this->em->getClassMetadata($abstractSchemaName);
  1303.         // Building queryComponent
  1304.         $queryComponent = [
  1305.             'metadata'     => $class,
  1306.             'parent'       => null,
  1307.             'relation'     => null,
  1308.             'map'          => null,
  1309.             'nestingLevel' => $this->nestingLevel,
  1310.             'token'        => $token,
  1311.         ];
  1313.         $this->queryComponents[$aliasIdentificationVariable] = $queryComponent;
  1315.         $this->match(Lexer::T_SET);
  1317.         $updateItems   = [];
  1318.         $updateItems[] = $this->UpdateItem();
  1320.         while ($this->lexer->isNextToken(Lexer::T_COMMA)) {
  1321.             $this->match(Lexer::T_COMMA);
  1323.             $updateItems[] = $this->UpdateItem();
  1324.         }
  1326.         $updateClause                              = new AST\UpdateClause($abstractSchemaName, $updateItems);
  1327.         $updateClause->aliasIdentificationVariable = $aliasIdentificationVariable;
  1329.         return $updateClause;
  1330.     }
  1332.     /**
  1333.      * DeleteClause ::= "DELETE" ["FROM"] AbstractSchemaName ["AS"] AliasIdentificationVariable
  1334.      *
  1335.      * @return DeleteClause
  1336.      */
  1337.     public function DeleteClause()
  1338.     {
  1339.         $this->match(Lexer::T_DELETE);
  1341.         if ($this->lexer->isNextToken(Lexer::T_FROM)) {
  1342.             $this->match(Lexer::T_FROM);
  1343.         }
  1345.         assert($this->lexer->lookahead !== null);
  1346.         $token              = $this->lexer->lookahead;
  1347.         $abstractSchemaName = $this->AbstractSchemaName();
  1349.         $this->validateAbstractSchemaName($abstractSchemaName);
  1351.         $deleteClause = new AST\DeleteClause($abstractSchemaName);
  1353.         if ($this->lexer->isNextToken(Lexer::T_AS)) {
  1354.             $this->match(Lexer::T_AS);
  1355.         }
  1357.         $aliasIdentificationVariable = $this->lexer->isNextToken(Lexer::T_IDENTIFIER)
  1358.             ? $this->AliasIdentificationVariable()
  1359.             : 'alias_should_have_been_set';
  1361.         $deleteClause->aliasIdentificationVariable = $aliasIdentificationVariable;
  1362.         $class                                     = $this->em->getClassMetadata($deleteClause->abstractSchemaName);
  1364.         // Building queryComponent
  1365.         $queryComponent = [
  1366.             'metadata'     => $class,
  1367.             'parent'       => null,
  1368.             'relation'     => null,
  1369.             'map'          => null,
  1370.             'nestingLevel' => $this->nestingLevel,
  1371.             'token'        => $token,
  1372.         ];
  1374.         $this->queryComponents[$aliasIdentificationVariable] = $queryComponent;
  1376.         return $deleteClause;
  1377.     }
  1379.     /**
  1380.      * FromClause ::= "FROM" IdentificationVariableDeclaration {"," IdentificationVariableDeclaration}*
  1381.      *
  1382.      * @return FromClause
  1383.      */
  1384.     public function FromClause()
  1385.     {
  1386.         $this->match(Lexer::T_FROM);
  1388.         $identificationVariableDeclarations   = [];
  1389.         $identificationVariableDeclarations[] = $this->IdentificationVariableDeclaration();
  1391.         while ($this->lexer->isNextToken(Lexer::T_COMMA)) {
  1392.             $this->match(Lexer::T_COMMA);
  1394.             $identificationVariableDeclarations[] = $this->IdentificationVariableDeclaration();
  1395.         }
  1397.         return new AST\FromClause($identificationVariableDeclarations);
  1398.     }
  1400.     /**
  1401.      * SubselectFromClause ::= "FROM" SubselectIdentificationVariableDeclaration {"," SubselectIdentificationVariableDeclaration}*
  1402.      *
  1403.      * @return SubselectFromClause
  1404.      */
  1405.     public function SubselectFromClause()
  1406.     {
  1407.         $this->match(Lexer::T_FROM);
  1409.         $identificationVariables   = [];
  1410.         $identificationVariables[] = $this->SubselectIdentificationVariableDeclaration();
  1412.         while ($this->lexer->isNextToken(Lexer::T_COMMA)) {
  1413.             $this->match(Lexer::T_COMMA);
  1415.             $identificationVariables[] = $this->SubselectIdentificationVariableDeclaration();
  1416.         }
  1418.         return new AST\SubselectFromClause($identificationVariables);
  1419.     }
  1421.     /**
  1422.      * WhereClause ::= "WHERE" ConditionalExpression
  1423.      *
  1424.      * @return WhereClause
  1425.      */
  1426.     public function WhereClause()
  1427.     {
  1428.         $this->match(Lexer::T_WHERE);
  1430.         return new AST\WhereClause($this->ConditionalExpression());
  1431.     }
  1433.     /**
  1434.      * HavingClause ::= "HAVING" ConditionalExpression
  1435.      *
  1436.      * @return HavingClause
  1437.      */
  1438.     public function HavingClause()
  1439.     {
  1440.         $this->match(Lexer::T_HAVING);
  1442.         return new AST\HavingClause($this->ConditionalExpression());
  1443.     }
  1445.     /**
  1446.      * GroupByClause ::= "GROUP" "BY" GroupByItem {"," GroupByItem}*
  1447.      *
  1448.      * @return GroupByClause
  1449.      */
  1450.     public function GroupByClause()
  1451.     {
  1452.         $this->match(Lexer::T_GROUP);
  1453.         $this->match(Lexer::T_BY);
  1455.         $groupByItems = [$this->GroupByItem()];
  1457.         while ($this->lexer->isNextToken(Lexer::T_COMMA)) {
  1458.             $this->match(Lexer::T_COMMA);
  1460.             $groupByItems[] = $this->GroupByItem();
  1461.         }
  1463.         return new AST\GroupByClause($groupByItems);
  1464.     }
  1466.     /**
  1467.      * OrderByClause ::= "ORDER" "BY" OrderByItem {"," OrderByItem}*
  1468.      *
  1469.      * @return OrderByClause
  1470.      */
  1471.     public function OrderByClause()
  1472.     {
  1473.         $this->match(Lexer::T_ORDER);
  1474.         $this->match(Lexer::T_BY);
  1476.         $orderByItems   = [];
  1477.         $orderByItems[] = $this->OrderByItem();
  1479.         while ($this->lexer->isNextToken(Lexer::T_COMMA)) {
  1480.             $this->match(Lexer::T_COMMA);
  1482.             $orderByItems[] = $this->OrderByItem();
  1483.         }
  1485.         return new AST\OrderByClause($orderByItems);
  1486.     }
  1488.     /**
  1489.      * Subselect ::= SimpleSelectClause SubselectFromClause [WhereClause] [GroupByClause] [HavingClause] [OrderByClause]
  1490.      *
  1491.      * @return Subselect
  1492.      */
  1493.     public function Subselect()
  1494.     {
  1495.         // Increase query nesting level
  1496.         $this->nestingLevel++;
  1498.         $subselect = new AST\Subselect($this->SimpleSelectClause(), $this->SubselectFromClause());
  1500.         $subselect->whereClause   = $this->lexer->isNextToken(Lexer::T_WHERE) ? $this->WhereClause() : null;
  1501.         $subselect->groupByClause = $this->lexer->isNextToken(Lexer::T_GROUP) ? $this->GroupByClause() : null;
  1502.         $subselect->havingClause  = $this->lexer->isNextToken(Lexer::T_HAVING) ? $this->HavingClause() : null;
  1503.         $subselect->orderByClause = $this->lexer->isNextToken(Lexer::T_ORDER) ? $this->OrderByClause() : null;
  1505.         // Decrease query nesting level
  1506.         $this->nestingLevel--;
  1508.         return $subselect;
  1509.     }
  1511.     /**
  1512.      * UpdateItem ::= SingleValuedPathExpression "=" NewValue
  1513.      *
  1514.      * @return UpdateItem
  1515.      */
  1516.     public function UpdateItem()
  1517.     {
  1518.         $pathExpr = $this->SingleValuedPathExpression();
  1520.         $this->match(Lexer::T_EQUALS);
  1522.         return new AST\UpdateItem($pathExpr, $this->NewValue());
  1523.     }
  1525.     /**
  1526.      * GroupByItem ::= IdentificationVariable | ResultVariable | SingleValuedPathExpression
  1527.      *
  1528.      * @return string|PathExpression
  1529.      */
  1530.     public function GroupByItem()
  1531.     {
  1532.         // We need to check if we are in a IdentificationVariable or SingleValuedPathExpression
  1533.         $glimpse = $this->lexer->glimpse();
  1535.         if ($glimpse !== null && $glimpse['type'] === Lexer::T_DOT) {
  1536.             return $this->SingleValuedPathExpression();
  1537.         }
  1539.         // Still need to decide between IdentificationVariable or ResultVariable
  1540.         $lookaheadValue = $this->lexer->lookahead['value'];
  1542.         if (! isset($this->queryComponents[$lookaheadValue])) {
  1543.             $this->semanticalError('Cannot group by undefined identification or result variable.');
  1544.         }
  1546.         return isset($this->queryComponents[$lookaheadValue]['metadata'])
  1547.             ? $this->IdentificationVariable()
  1548.             : $this->ResultVariable();
  1549.     }
  1551.     /**
  1552.      * OrderByItem ::= (
  1553.      *      SimpleArithmeticExpression | SingleValuedPathExpression | CaseExpression |
  1554.      *      ScalarExpression | ResultVariable | FunctionDeclaration
  1555.      * ) ["ASC" | "DESC"]
  1556.      *
  1557.      * @return OrderByItem
  1558.      */
  1559.     public function OrderByItem()
  1560.     {
  1561.         $this->lexer->peek(); // lookahead => '.'
  1562.         $this->lexer->peek(); // lookahead => token after '.'
  1564.         $peek = $this->lexer->peek(); // lookahead => token after the token after the '.'
  1566.         $this->lexer->resetPeek();
  1568.         $glimpse = $this->lexer->glimpse();
  1570.         switch (true) {
  1571.             case $this->isMathOperator($peek):
  1572.                 $expr = $this->SimpleArithmeticExpression();
  1573.                 break;
  1575.             case $glimpse !== null && $glimpse['type'] === Lexer::T_DOT:
  1576.                 $expr = $this->SingleValuedPathExpression();
  1577.                 break;
  1579.             case $this->lexer->peek() && $this->isMathOperator($this->peekBeyondClosingParenthesis()):
  1580.                 $expr = $this->ScalarExpression();
  1581.                 break;
  1583.             case $this->lexer->lookahead['type'] === Lexer::T_CASE:
  1584.                 $expr = $this->CaseExpression();
  1585.                 break;
  1587.             case $this->isFunction():
  1588.                 $expr = $this->FunctionDeclaration();
  1589.                 break;
  1591.             default:
  1592.                 $expr = $this->ResultVariable();
  1593.                 break;
  1594.         }
  1596.         $type = 'ASC';
  1597.         $item = new AST\OrderByItem($expr);
  1599.         switch (true) {
  1600.             case $this->lexer->isNextToken(Lexer::T_DESC):
  1601.                 $this->match(Lexer::T_DESC);
  1602.                 $type = 'DESC';
  1603.                 break;
  1605.             case $this->lexer->isNextToken(Lexer::T_ASC):
  1606.                 $this->match(Lexer::T_ASC);
  1607.                 break;
  1609.             default:
  1610.                 // Do nothing
  1611.         }
  1613.         $item->type = $type;
  1615.         return $item;
  1616.     }
  1618.     /**
  1619.      * NewValue ::= SimpleArithmeticExpression | StringPrimary | DatetimePrimary | BooleanPrimary |
  1620.      *      EnumPrimary | SimpleEntityExpression | "NULL"
  1621.      *
  1622.      * NOTE: Since it is not possible to correctly recognize individual types, here is the full
  1623.      * grammar that needs to be supported:
  1624.      *
  1625.      * NewValue ::= SimpleArithmeticExpression | "NULL"
  1626.      *
  1627.      * SimpleArithmeticExpression covers all *Primary grammar rules and also SimpleEntityExpression
  1628.      *
  1629.      * @return AST\ArithmeticExpression|AST\InputParameter|null
  1630.      */
  1631.     public function NewValue()
  1632.     {
  1633.         if ($this->lexer->isNextToken(Lexer::T_NULL)) {
  1634.             $this->match(Lexer::T_NULL);
  1636.             return null;
  1637.         }
  1639.         if ($this->lexer->isNextToken(Lexer::T_INPUT_PARAMETER)) {
  1640.             $this->match(Lexer::T_INPUT_PARAMETER);
  1642.             return new AST\InputParameter($this->lexer->token['value']);
  1643.         }
  1645.         return $this->ArithmeticExpression();
  1646.     }
  1648.     /**
  1649.      * IdentificationVariableDeclaration ::= RangeVariableDeclaration [IndexBy] {Join}*
  1650.      *
  1651.      * @return IdentificationVariableDeclaration
  1652.      */
  1653.     public function IdentificationVariableDeclaration()
  1654.     {
  1655.         $joins                    = [];
  1656.         $rangeVariableDeclaration = $this->RangeVariableDeclaration();
  1657.         $indexBy                  = $this->lexer->isNextToken(Lexer::T_INDEX)
  1658.             ? $this->IndexBy()
  1659.             : null;
  1661.         $rangeVariableDeclaration->isRoot = true;
  1663.         while (
  1664.             $this->lexer->isNextToken(Lexer::T_LEFT) ||
  1665.             $this->lexer->isNextToken(Lexer::T_INNER) ||
  1666.             $this->lexer->isNextToken(Lexer::T_JOIN)
  1667.         ) {
  1668.             $joins[] = $this->Join();
  1669.         }
  1671.         return new AST\IdentificationVariableDeclaration(
  1672.             $rangeVariableDeclaration,
  1673.             $indexBy,
  1674.             $joins
  1675.         );
  1676.     }
  1678.     /**
  1679.      * SubselectIdentificationVariableDeclaration ::= IdentificationVariableDeclaration
  1680.      *
  1681.      * {Internal note: WARNING: Solution is harder than a bare implementation.
  1682.      * Desired EBNF support:
  1683.      *
  1684.      * SubselectIdentificationVariableDeclaration ::= IdentificationVariableDeclaration | (AssociationPathExpression ["AS"] AliasIdentificationVariable)
  1685.      *
  1686.      * It demands that entire SQL generation to become programmatical. This is
  1687.      * needed because association based subselect requires "WHERE" conditional
  1688.      * expressions to be injected, but there is no scope to do that. Only scope
  1689.      * accessible is "FROM", prohibiting an easy implementation without larger
  1690.      * changes.}
  1691.      *
  1692.      * @return IdentificationVariableDeclaration
  1693.      */
  1694.     public function SubselectIdentificationVariableDeclaration()
  1695.     {
  1696.         /*
  1697.         NOT YET IMPLEMENTED!
  1699.         $glimpse = $this->lexer->glimpse();
  1701.         if ($glimpse['type'] == Lexer::T_DOT) {
  1702.             $associationPathExpression = $this->AssociationPathExpression();
  1704.             if ($this->lexer->isNextToken(Lexer::T_AS)) {
  1705.                 $this->match(Lexer::T_AS);
  1706.             }
  1708.             $aliasIdentificationVariable = $this->AliasIdentificationVariable();
  1709.             $identificationVariable      = $associationPathExpression->identificationVariable;
  1710.             $field                       = $associationPathExpression->associationField;
  1712.             $class       = $this->queryComponents[$identificationVariable]['metadata'];
  1713.             $targetClass = $this->em->getClassMetadata($class->associationMappings[$field]['targetEntity']);
  1715.             // Building queryComponent
  1716.             $joinQueryComponent = array(
  1717.                 'metadata'     => $targetClass,
  1718.                 'parent'       => $identificationVariable,
  1719.                 'relation'     => $class->getAssociationMapping($field),
  1720.                 'map'          => null,
  1721.                 'nestingLevel' => $this->nestingLevel,
  1722.                 'token'        => $this->lexer->lookahead
  1723.             );
  1725.             $this->queryComponents[$aliasIdentificationVariable] = $joinQueryComponent;
  1727.             return new AST\SubselectIdentificationVariableDeclaration(
  1728.                 $associationPathExpression, $aliasIdentificationVariable
  1729.             );
  1730.         }
  1731.         */
  1733.         return $this->IdentificationVariableDeclaration();
  1734.     }
  1736.     /**
  1737.      * Join ::= ["LEFT" ["OUTER"] | "INNER"] "JOIN"
  1738.      *          (JoinAssociationDeclaration | RangeVariableDeclaration)
  1739.      *          ["WITH" ConditionalExpression]
  1740.      *
  1741.      * @return Join
  1742.      */
  1743.     public function Join()
  1744.     {
  1745.         // Check Join type
  1746.         $joinType = AST\Join::JOIN_TYPE_INNER;
  1748.         switch (true) {
  1749.             case $this->lexer->isNextToken(Lexer::T_LEFT):
  1750.                 $this->match(Lexer::T_LEFT);
  1752.                 $joinType = AST\Join::JOIN_TYPE_LEFT;
  1754.                 // Possible LEFT OUTER join
  1755.                 if ($this->lexer->isNextToken(Lexer::T_OUTER)) {
  1756.                     $this->match(Lexer::T_OUTER);
  1758.                     $joinType = AST\Join::JOIN_TYPE_LEFTOUTER;
  1759.                 }
  1761.                 break;
  1763.             case $this->lexer->isNextToken(Lexer::T_INNER):
  1764.                 $this->match(Lexer::T_INNER);
  1765.                 break;
  1767.             default:
  1768.                 // Do nothing
  1769.         }
  1771.         $this->match(Lexer::T_JOIN);
  1773.         $next            = $this->lexer->glimpse();
  1774.         $joinDeclaration = $next['type'] === Lexer::T_DOT ? $this->JoinAssociationDeclaration() : $this->RangeVariableDeclaration();
  1775.         $adhocConditions = $this->lexer->isNextToken(Lexer::T_WITH);
  1776.         $join            = new AST\Join($joinType, $joinDeclaration);
  1778.         // Describe non-root join declaration
  1779.         if ($joinDeclaration instanceof AST\RangeVariableDeclaration) {
  1780.             $joinDeclaration->isRoot = false;
  1781.         }
  1783.         // Check for ad-hoc Join conditions
  1784.         if ($adhocConditions) {
  1785.             $this->match(Lexer::T_WITH);
  1787.             $join->conditionalExpression = $this->ConditionalExpression();
  1788.         }
  1790.         return $join;
  1791.     }
  1793.     /**
  1794.      * RangeVariableDeclaration ::= AbstractSchemaName ["AS"] AliasIdentificationVariable
  1795.      *
  1796.      * @return RangeVariableDeclaration
  1797.      *
  1798.      * @throws QueryException
  1799.      */
  1800.     public function RangeVariableDeclaration()
  1801.     {
  1802.         if ($this->lexer->isNextToken(Lexer::T_OPEN_PARENTHESIS) && $this->lexer->glimpse()['type'] === Lexer::T_SELECT) {
  1803.             $this->semanticalError('Subquery is not supported here', $this->lexer->token);
  1804.         }
  1806.         $abstractSchemaName = $this->AbstractSchemaName();
  1808.         $this->validateAbstractSchemaName($abstractSchemaName);
  1810.         if ($this->lexer->isNextToken(Lexer::T_AS)) {
  1811.             $this->match(Lexer::T_AS);
  1812.         }
  1814.         assert($this->lexer->lookahead !== null);
  1815.         $token                       = $this->lexer->lookahead;
  1816.         $aliasIdentificationVariable = $this->AliasIdentificationVariable();
  1817.         $classMetadata               = $this->em->getClassMetadata($abstractSchemaName);
  1819.         // Building queryComponent
  1820.         $queryComponent = [
  1821.             'metadata'     => $classMetadata,
  1822.             'parent'       => null,
  1823.             'relation'     => null,
  1824.             'map'          => null,
  1825.             'nestingLevel' => $this->nestingLevel,
  1826.             'token'        => $token,
  1827.         ];
  1829.         $this->queryComponents[$aliasIdentificationVariable] = $queryComponent;
  1831.         return new AST\RangeVariableDeclaration($abstractSchemaName, $aliasIdentificationVariable);
  1832.     }
  1834.     /**
  1835.      * JoinAssociationDeclaration ::= JoinAssociationPathExpression ["AS"] AliasIdentificationVariable [IndexBy]
  1836.      *
  1837.      * @return AST\JoinAssociationDeclaration
  1838.      */
  1839.     public function JoinAssociationDeclaration()
  1840.     {
  1841.         $joinAssociationPathExpression = $this->JoinAssociationPathExpression();
  1843.         if ($this->lexer->isNextToken(Lexer::T_AS)) {
  1844.             $this->match(Lexer::T_AS);
  1845.         }
  1847.         assert($this->lexer->lookahead !== null);
  1849.         $aliasIdentificationVariable = $this->AliasIdentificationVariable();
  1850.         $indexBy                     = $this->lexer->isNextToken(Lexer::T_INDEX) ? $this->IndexBy() : null;
  1852.         $identificationVariable = $joinAssociationPathExpression->identificationVariable;
  1853.         $field                  = $joinAssociationPathExpression->associationField;
  1855.         $class       = $this->getMetadataForDqlAlias($identificationVariable);
  1856.         $targetClass = $this->em->getClassMetadata($class->associationMappings[$field]['targetEntity']);
  1858.         // Building queryComponent
  1859.         $joinQueryComponent = [
  1860.             'metadata'     => $targetClass,
  1861.             'parent'       => $joinAssociationPathExpression->identificationVariable,
  1862.             'relation'     => $class->getAssociationMapping($field),
  1863.             'map'          => null,
  1864.             'nestingLevel' => $this->nestingLevel,
  1865.             'token'        => $this->lexer->lookahead,
  1866.         ];
  1868.         $this->queryComponents[$aliasIdentificationVariable] = $joinQueryComponent;
  1870.         return new AST\JoinAssociationDeclaration($joinAssociationPathExpression, $aliasIdentificationVariable, $indexBy);
  1871.     }
  1873.     /**
  1874.      * PartialObjectExpression ::= "PARTIAL" IdentificationVariable "." PartialFieldSet
  1875.      * PartialFieldSet ::= "{" SimpleStateField {"," SimpleStateField}* "}"
  1876.      *
  1877.      * @return PartialObjectExpression
  1878.      */
  1879.     public function PartialObjectExpression()
  1880.     {
  1881.         Deprecation::trigger(
  1882.             'doctrine/orm',
  1883.             'https://github.com/doctrine/orm/issues/8471',
  1884.             'PARTIAL syntax in DQL is deprecated.'
  1885.         );
  1887.         $this->match(Lexer::T_PARTIAL);
  1889.         $partialFieldSet = [];
  1891.         $identificationVariable = $this->IdentificationVariable();
  1893.         $this->match(Lexer::T_DOT);
  1894.         $this->match(Lexer::T_OPEN_CURLY_BRACE);
  1895.         $this->match(Lexer::T_IDENTIFIER);
  1897.         $field = $this->lexer->token['value'];
  1899.         // First field in partial expression might be embeddable property
  1900.         while ($this->lexer->isNextToken(Lexer::T_DOT)) {
  1901.             $this->match(Lexer::T_DOT);
  1902.             $this->match(Lexer::T_IDENTIFIER);
  1903.             $field .= '.' . $this->lexer->token['value'];
  1904.         }
  1906.         $partialFieldSet[] = $field;
  1908.         while ($this->lexer->isNextToken(Lexer::T_COMMA)) {
  1909.             $this->match(Lexer::T_COMMA);
  1910.             $this->match(Lexer::T_IDENTIFIER);
  1912.             $field = $this->lexer->token['value'];
  1914.             while ($this->lexer->isNextToken(Lexer::T_DOT)) {
  1915.                 $this->match(Lexer::T_DOT);
  1916.                 $this->match(Lexer::T_IDENTIFIER);
  1917.                 $field .= '.' . $this->lexer->token['value'];
  1918.             }
  1920.             $partialFieldSet[] = $field;
  1921.         }
  1923.         $this->match(Lexer::T_CLOSE_CURLY_BRACE);
  1925.         $partialObjectExpression = new AST\PartialObjectExpression($identificationVariable, $partialFieldSet);
  1927.         assert($this->lexer->token !== null);
  1928.         // Defer PartialObjectExpression validation
  1929.         $this->deferredPartialObjectExpressions[] = [
  1930.             'expression'   => $partialObjectExpression,
  1931.             'nestingLevel' => $this->nestingLevel,
  1932.             'token'        => $this->lexer->token,
  1933.         ];
  1935.         return $partialObjectExpression;
  1936.     }
  1938.     /**
  1939.      * NewObjectExpression ::= "NEW" AbstractSchemaName "(" NewObjectArg {"," NewObjectArg}* ")"
  1940.      *
  1941.      * @return NewObjectExpression
  1942.      */
  1943.     public function NewObjectExpression()
  1944.     {
  1945.         $this->match(Lexer::T_NEW);
  1947.         $className = $this->AbstractSchemaName(); // note that this is not yet validated
  1948.         $token     = $this->lexer->token;
  1950.         $this->match(Lexer::T_OPEN_PARENTHESIS);
  1952.         $args[] = $this->NewObjectArg();
  1954.         while ($this->lexer->isNextToken(Lexer::T_COMMA)) {
  1955.             $this->match(Lexer::T_COMMA);
  1957.             $args[] = $this->NewObjectArg();
  1958.         }
  1960.         $this->match(Lexer::T_CLOSE_PARENTHESIS);
  1962.         $expression = new AST\NewObjectExpression($className, $args);
  1964.         // Defer NewObjectExpression validation
  1965.         $this->deferredNewObjectExpressions[] = [
  1966.             'token'        => $token,
  1967.             'expression'   => $expression,
  1968.             'nestingLevel' => $this->nestingLevel,
  1969.         ];
  1971.         return $expression;
  1972.     }
  1974.     /**
  1975.      * NewObjectArg ::= ScalarExpression | "(" Subselect ")"
  1976.      *
  1977.      * @return mixed
  1978.      */
  1979.     public function NewObjectArg()
  1980.     {
  1981.         $token = $this->lexer->lookahead;
  1982.         $peek  = $this->lexer->glimpse();
  1984.         if ($token['type'] === Lexer::T_OPEN_PARENTHESIS && $peek['type'] === Lexer::T_SELECT) {
  1985.             $this->match(Lexer::T_OPEN_PARENTHESIS);
  1986.             $expression = $this->Subselect();
  1987.             $this->match(Lexer::T_CLOSE_PARENTHESIS);
  1989.             return $expression;
  1990.         }
  1992.         return $this->ScalarExpression();
  1993.     }
  1995.     /**
  1996.      * IndexBy ::= "INDEX" "BY" SingleValuedPathExpression
  1997.      *
  1998.      * @return IndexBy
  1999.      */
  2000.     public function IndexBy()
  2001.     {
  2002.         $this->match(Lexer::T_INDEX);
  2003.         $this->match(Lexer::T_BY);
  2004.         $pathExpr = $this->SingleValuedPathExpression();
  2006.         // Add the INDEX BY info to the query component
  2007.         $this->queryComponents[$pathExpr->identificationVariable]['map'] = $pathExpr->field;
  2009.         return new AST\IndexBy($pathExpr);
  2010.     }
  2012.     /**
  2013.      * ScalarExpression ::= SimpleArithmeticExpression | StringPrimary | DateTimePrimary |
  2014.      *                      StateFieldPathExpression | BooleanPrimary | CaseExpression |
  2015.      *                      InstanceOfExpression
  2016.      *
  2017.      * @return mixed One of the possible expressions or subexpressions.
  2018.      */
  2019.     public function ScalarExpression()
  2020.     {
  2021.         $lookahead = $this->lexer->lookahead['type'];
  2022.         $peek      = $this->lexer->glimpse();
  2024.         switch (true) {
  2025.             case $lookahead === Lexer::T_INTEGER:
  2026.             case $lookahead === Lexer::T_FLOAT:
  2027.             // SimpleArithmeticExpression : (- u.value ) or ( + u.value )  or ( - 1 ) or ( + 1 )
  2028.             case $lookahead === Lexer::T_MINUS:
  2029.             case $lookahead === Lexer::T_PLUS:
  2030.                 return $this->SimpleArithmeticExpression();
  2032.             case $lookahead === Lexer::T_STRING:
  2033.                 return $this->StringPrimary();
  2035.             case $lookahead === Lexer::T_TRUE:
  2036.             case $lookahead === Lexer::T_FALSE:
  2037.                 $this->match($lookahead);
  2039.                 return new AST\Literal(AST\Literal::BOOLEAN, $this->lexer->token['value']);
  2041.             case $lookahead === Lexer::T_INPUT_PARAMETER:
  2042.                 switch (true) {
  2043.                     case $this->isMathOperator($peek):
  2044.                         // :param + u.value
  2045.                         return $this->SimpleArithmeticExpression();
  2047.                     default:
  2048.                         return $this->InputParameter();
  2049.                 }
  2050.             case $lookahead === Lexer::T_CASE:
  2051.             case $lookahead === Lexer::T_COALESCE:
  2052.             case $lookahead === Lexer::T_NULLIF:
  2053.                 // Since NULLIF and COALESCE can be identified as a function,
  2054.                 // we need to check these before checking for FunctionDeclaration
  2055.                 return $this->CaseExpression();
  2057.             case $lookahead === Lexer::T_OPEN_PARENTHESIS:
  2058.                 return $this->SimpleArithmeticExpression();
  2060.             // this check must be done before checking for a filed path expression
  2061.             case $this->isFunction():
  2062.                 $this->lexer->peek(); // "("
  2064.                 switch (true) {
  2065.                     case $this->isMathOperator($this->peekBeyondClosingParenthesis()):
  2066.                         // SUM(u.id) + COUNT(u.id)
  2067.                         return $this->SimpleArithmeticExpression();
  2069.                     default:
  2070.                         // IDENTITY(u)
  2071.                         return $this->FunctionDeclaration();
  2072.                 }
  2074.                 break;
  2075.             // it is no function, so it must be a field path
  2076.             case $lookahead === Lexer::T_IDENTIFIER:
  2077.                 $this->lexer->peek(); // lookahead => '.'
  2078.                 $this->lexer->peek(); // lookahead => token after '.'
  2079.                 $peek = $this->lexer->peek(); // lookahead => token after the token after the '.'
  2080.                 $this->lexer->resetPeek();
  2082.                 if ($this->isMathOperator($peek)) {
  2083.                     return $this->SimpleArithmeticExpression();
  2084.                 }
  2086.                 return $this->StateFieldPathExpression();
  2088.             default:
  2089.                 $this->syntaxError();
  2090.         }
  2091.     }
  2093.     /**
  2094.      * CaseExpression ::= GeneralCaseExpression | SimpleCaseExpression | CoalesceExpression | NullifExpression
  2095.      * GeneralCaseExpression ::= "CASE" WhenClause {WhenClause}* "ELSE" ScalarExpression "END"
  2096.      * WhenClause ::= "WHEN" ConditionalExpression "THEN" ScalarExpression
  2097.      * SimpleCaseExpression ::= "CASE" CaseOperand SimpleWhenClause {SimpleWhenClause}* "ELSE" ScalarExpression "END"
  2098.      * CaseOperand ::= StateFieldPathExpression | TypeDiscriminator
  2099.      * SimpleWhenClause ::= "WHEN" ScalarExpression "THEN" ScalarExpression
  2100.      * CoalesceExpression ::= "COALESCE" "(" ScalarExpression {"," ScalarExpression}* ")"
  2101.      * NullifExpression ::= "NULLIF" "(" ScalarExpression "," ScalarExpression ")"
  2102.      *
  2103.      * @return mixed One of the possible expressions or subexpressions.
  2104.      */
  2105.     public function CaseExpression()
  2106.     {
  2107.         $lookahead = $this->lexer->lookahead['type'];
  2109.         switch ($lookahead) {
  2110.             case Lexer::T_NULLIF:
  2111.                 return $this->NullIfExpression();
  2113.             case Lexer::T_COALESCE:
  2114.                 return $this->CoalesceExpression();
  2116.             case Lexer::T_CASE:
  2117.                 $this->lexer->resetPeek();
  2118.                 $peek = $this->lexer->peek();
  2120.                 if ($peek['type'] === Lexer::T_WHEN) {
  2121.                     return $this->GeneralCaseExpression();
  2122.                 }
  2124.                 return $this->SimpleCaseExpression();
  2126.             default:
  2127.                 // Do nothing
  2128.                 break;
  2129.         }
  2131.         $this->syntaxError();
  2132.     }
  2134.     /**
  2135.      * CoalesceExpression ::= "COALESCE" "(" ScalarExpression {"," ScalarExpression}* ")"
  2136.      *
  2137.      * @return CoalesceExpression
  2138.      */
  2139.     public function CoalesceExpression()
  2140.     {
  2141.         $this->match(Lexer::T_COALESCE);
  2142.         $this->match(Lexer::T_OPEN_PARENTHESIS);
  2144.         // Process ScalarExpressions (1..N)
  2145.         $scalarExpressions   = [];
  2146.         $scalarExpressions[] = $this->ScalarExpression();
  2148.         while ($this->lexer->isNextToken(Lexer::T_COMMA)) {
  2149.             $this->match(Lexer::T_COMMA);
  2151.             $scalarExpressions[] = $this->ScalarExpression();
  2152.         }
  2154.         $this->match(Lexer::T_CLOSE_PARENTHESIS);
  2156.         return new AST\CoalesceExpression($scalarExpressions);
  2157.     }
  2159.     /**
  2160.      * NullIfExpression ::= "NULLIF" "(" ScalarExpression "," ScalarExpression ")"
  2161.      *
  2162.      * @return NullIfExpression
  2163.      */
  2164.     public function NullIfExpression()
  2165.     {
  2166.         $this->match(Lexer::T_NULLIF);
  2167.         $this->match(Lexer::T_OPEN_PARENTHESIS);
  2169.         $firstExpression = $this->ScalarExpression();
  2170.         $this->match(Lexer::T_COMMA);
  2171.         $secondExpression = $this->ScalarExpression();
  2173.         $this->match(Lexer::T_CLOSE_PARENTHESIS);
  2175.         return new AST\NullIfExpression($firstExpression, $secondExpression);
  2176.     }
  2178.     /**
  2179.      * GeneralCaseExpression ::= "CASE" WhenClause {WhenClause}* "ELSE" ScalarExpression "END"
  2180.      *
  2181.      * @return GeneralCaseExpression
  2182.      */
  2183.     public function GeneralCaseExpression()
  2184.     {
  2185.         $this->match(Lexer::T_CASE);
  2187.         // Process WhenClause (1..N)
  2188.         $whenClauses = [];
  2190.         do {
  2191.             $whenClauses[] = $this->WhenClause();
  2192.         } while ($this->lexer->isNextToken(Lexer::T_WHEN));
  2194.         $this->match(Lexer::T_ELSE);
  2195.         $scalarExpression = $this->ScalarExpression();
  2196.         $this->match(Lexer::T_END);
  2198.         return new AST\GeneralCaseExpression($whenClauses, $scalarExpression);
  2199.     }
  2201.     /**
  2202.      * SimpleCaseExpression ::= "CASE" CaseOperand SimpleWhenClause {SimpleWhenClause}* "ELSE" ScalarExpression "END"
  2203.      * CaseOperand ::= StateFieldPathExpression | TypeDiscriminator
  2204.      *
  2205.      * @return AST\SimpleCaseExpression
  2206.      */
  2207.     public function SimpleCaseExpression()
  2208.     {
  2209.         $this->match(Lexer::T_CASE);
  2210.         $caseOperand = $this->StateFieldPathExpression();
  2212.         // Process SimpleWhenClause (1..N)
  2213.         $simpleWhenClauses = [];
  2215.         do {
  2216.             $simpleWhenClauses[] = $this->SimpleWhenClause();
  2217.         } while ($this->lexer->isNextToken(Lexer::T_WHEN));
  2219.         $this->match(Lexer::T_ELSE);
  2220.         $scalarExpression = $this->ScalarExpression();
  2221.         $this->match(Lexer::T_END);
  2223.         return new AST\SimpleCaseExpression($caseOperand, $simpleWhenClauses, $scalarExpression);
  2224.     }
  2226.     /**
  2227.      * WhenClause ::= "WHEN" ConditionalExpression "THEN" ScalarExpression
  2228.      *
  2229.      * @return WhenClause
  2230.      */
  2231.     public function WhenClause()
  2232.     {
  2233.         $this->match(Lexer::T_WHEN);
  2234.         $conditionalExpression = $this->ConditionalExpression();
  2235.         $this->match(Lexer::T_THEN);
  2237.         return new AST\WhenClause($conditionalExpression, $this->ScalarExpression());
  2238.     }
  2240.     /**
  2241.      * SimpleWhenClause ::= "WHEN" ScalarExpression "THEN" ScalarExpression
  2242.      *
  2243.      * @return SimpleWhenClause
  2244.      */
  2245.     public function SimpleWhenClause()
  2246.     {
  2247.         $this->match(Lexer::T_WHEN);
  2248.         $conditionalExpression = $this->ScalarExpression();
  2249.         $this->match(Lexer::T_THEN);
  2251.         return new AST\SimpleWhenClause($conditionalExpression, $this->ScalarExpression());
  2252.     }
  2254.     /**
  2255.      * SelectExpression ::= (
  2256.      *     IdentificationVariable | ScalarExpression | AggregateExpression | FunctionDeclaration |
  2257.      *     PartialObjectExpression | "(" Subselect ")" | CaseExpression | NewObjectExpression
  2258.      * ) [["AS"] ["HIDDEN"] AliasResultVariable]
  2259.      *
  2260.      * @return SelectExpression
  2261.      */
  2262.     public function SelectExpression()
  2263.     {
  2264.         $expression    = null;
  2265.         $identVariable = null;
  2266.         $peek          = $this->lexer->glimpse();
  2267.         $lookaheadType = $this->lexer->lookahead['type'];
  2269.         switch (true) {
  2270.             // ScalarExpression (u.name)
  2271.             case $lookaheadType === Lexer::T_IDENTIFIER && $peek['type'] === Lexer::T_DOT:
  2272.                 $expression = $this->ScalarExpression();
  2273.                 break;
  2275.             // IdentificationVariable (u)
  2276.             case $lookaheadType === Lexer::T_IDENTIFIER && $peek['type'] !== Lexer::T_OPEN_PARENTHESIS:
  2277.                 $expression = $identVariable = $this->IdentificationVariable();
  2278.                 break;
  2280.             // CaseExpression (CASE ... or NULLIF(...) or COALESCE(...))
  2281.             case $lookaheadType === Lexer::T_CASE:
  2282.             case $lookaheadType === Lexer::T_COALESCE:
  2283.             case $lookaheadType === Lexer::T_NULLIF:
  2284.                 $expression = $this->CaseExpression();
  2285.                 break;
  2287.             // DQL Function (SUM(u.value) or SUM(u.value) + 1)
  2288.             case $this->isFunction():
  2289.                 $this->lexer->peek(); // "("
  2291.                 switch (true) {
  2292.                     case $this->isMathOperator($this->peekBeyondClosingParenthesis()):
  2293.                         // SUM(u.id) + COUNT(u.id)
  2294.                         $expression = $this->ScalarExpression();
  2295.                         break;
  2297.                     default:
  2298.                         // IDENTITY(u)
  2299.                         $expression = $this->FunctionDeclaration();
  2300.                         break;
  2301.                 }
  2303.                 break;
  2305.             // PartialObjectExpression (PARTIAL u.{id, name})
  2306.             case $lookaheadType === Lexer::T_PARTIAL:
  2307.                 $expression    = $this->PartialObjectExpression();
  2308.                 $identVariable = $expression->identificationVariable;
  2309.                 break;
  2311.             // Subselect
  2312.             case $lookaheadType === Lexer::T_OPEN_PARENTHESIS && $peek['type'] === Lexer::T_SELECT:
  2313.                 $this->match(Lexer::T_OPEN_PARENTHESIS);
  2314.                 $expression = $this->Subselect();
  2315.                 $this->match(Lexer::T_CLOSE_PARENTHESIS);
  2316.                 break;
  2318.             // Shortcut: ScalarExpression => SimpleArithmeticExpression
  2319.             case $lookaheadType === Lexer::T_OPEN_PARENTHESIS:
  2320.             case $lookaheadType === Lexer::T_INTEGER:
  2321.             case $lookaheadType === Lexer::T_STRING:
  2322.             case $lookaheadType === Lexer::T_FLOAT:
  2323.             // SimpleArithmeticExpression : (- u.value ) or ( + u.value )
  2324.             case $lookaheadType === Lexer::T_MINUS:
  2325.             case $lookaheadType === Lexer::T_PLUS:
  2326.                 $expression = $this->SimpleArithmeticExpression();
  2327.                 break;
  2329.             // NewObjectExpression (New ClassName(id, name))
  2330.             case $lookaheadType === Lexer::T_NEW:
  2331.                 $expression = $this->NewObjectExpression();
  2332.                 break;
  2334.             default:
  2335.                 $this->syntaxError(
  2336.                     'IdentificationVariable | ScalarExpression | AggregateExpression | FunctionDeclaration | PartialObjectExpression | "(" Subselect ")" | CaseExpression',
  2337.                     $this->lexer->lookahead
  2338.                 );
  2339.         }
  2341.         // [["AS"] ["HIDDEN"] AliasResultVariable]
  2342.         $mustHaveAliasResultVariable = false;
  2344.         if ($this->lexer->isNextToken(Lexer::T_AS)) {
  2345.             $this->match(Lexer::T_AS);
  2347.             $mustHaveAliasResultVariable = true;
  2348.         }
  2350.         $hiddenAliasResultVariable = false;
  2352.         if ($this->lexer->isNextToken(Lexer::T_HIDDEN)) {
  2353.             $this->match(Lexer::T_HIDDEN);
  2355.             $hiddenAliasResultVariable = true;
  2356.         }
  2358.         $aliasResultVariable = null;
  2360.         if ($mustHaveAliasResultVariable || $this->lexer->isNextToken(Lexer::T_IDENTIFIER)) {
  2361.             assert($this->lexer->lookahead !== null);
  2362.             assert($expression instanceof AST\Node || is_string($expression));
  2363.             $token               = $this->lexer->lookahead;
  2364.             $aliasResultVariable = $this->AliasResultVariable();
  2366.             // Include AliasResultVariable in query components.
  2367.             $this->queryComponents[$aliasResultVariable] = [
  2368.                 'resultVariable' => $expression,
  2369.                 'nestingLevel'   => $this->nestingLevel,
  2370.                 'token'          => $token,
  2371.             ];
  2372.         }
  2374.         // AST
  2376.         $expr = new AST\SelectExpression($expression, $aliasResultVariable, $hiddenAliasResultVariable);
  2378.         if ($identVariable) {
  2379.             $this->identVariableExpressions[$identVariable] = $expr;
  2380.         }
  2382.         return $expr;
  2383.     }
  2385.     /**
  2386.      * SimpleSelectExpression ::= (
  2387.      *      StateFieldPathExpression | IdentificationVariable | FunctionDeclaration |
  2388.      *      AggregateExpression | "(" Subselect ")" | ScalarExpression
  2389.      * ) [["AS"] AliasResultVariable]
  2390.      *
  2391.      * @return SimpleSelectExpression
  2392.      */
  2393.     public function SimpleSelectExpression()
  2394.     {
  2395.         $peek = $this->lexer->glimpse();
  2397.         switch ($this->lexer->lookahead['type']) {
  2398.             case Lexer::T_IDENTIFIER:
  2399.                 switch (true) {
  2400.                     case $peek['type'] === Lexer::T_DOT:
  2401.                         $expression = $this->StateFieldPathExpression();
  2403.                         return new AST\SimpleSelectExpression($expression);
  2405.                     case $peek['type'] !== Lexer::T_OPEN_PARENTHESIS:
  2406.                         $expression = $this->IdentificationVariable();
  2408.                         return new AST\SimpleSelectExpression($expression);
  2410.                     case $this->isFunction():
  2411.                         // SUM(u.id) + COUNT(u.id)
  2412.                         if ($this->isMathOperator($this->peekBeyondClosingParenthesis())) {
  2413.                             return new AST\SimpleSelectExpression($this->ScalarExpression());
  2414.                         }
  2416.                         // COUNT(u.id)
  2417.                         if ($this->isAggregateFunction($this->lexer->lookahead['type'])) {
  2418.                             return new AST\SimpleSelectExpression($this->AggregateExpression());
  2419.                         }
  2421.                         // IDENTITY(u)
  2422.                         return new AST\SimpleSelectExpression($this->FunctionDeclaration());
  2424.                     default:
  2425.                         // Do nothing
  2426.                 }
  2428.                 break;
  2430.             case Lexer::T_OPEN_PARENTHESIS:
  2431.                 if ($peek['type'] !== Lexer::T_SELECT) {
  2432.                     // Shortcut: ScalarExpression => SimpleArithmeticExpression
  2433.                     $expression = $this->SimpleArithmeticExpression();
  2435.                     return new AST\SimpleSelectExpression($expression);
  2436.                 }
  2438.                 // Subselect
  2439.                 $this->match(Lexer::T_OPEN_PARENTHESIS);
  2440.                 $expression = $this->Subselect();
  2441.                 $this->match(Lexer::T_CLOSE_PARENTHESIS);
  2443.                 return new AST\SimpleSelectExpression($expression);
  2445.             default:
  2446.                 // Do nothing
  2447.         }
  2449.         $this->lexer->peek();
  2451.         $expression = $this->ScalarExpression();
  2452.         $expr       = new AST\SimpleSelectExpression($expression);
  2454.         if ($this->lexer->isNextToken(Lexer::T_AS)) {
  2455.             $this->match(Lexer::T_AS);
  2456.         }
  2458.         if ($this->lexer->isNextToken(Lexer::T_IDENTIFIER)) {
  2459.             assert($this->lexer->lookahead !== null);
  2460.             $token                             = $this->lexer->lookahead;
  2461.             $resultVariable                    = $this->AliasResultVariable();
  2462.             $expr->fieldIdentificationVariable = $resultVariable;
  2464.             // Include AliasResultVariable in query components.
  2465.             $this->queryComponents[$resultVariable] = [
  2466.                 'resultvariable' => $expr,
  2467.                 'nestingLevel'   => $this->nestingLevel,
  2468.                 'token'          => $token,
  2469.             ];
  2470.         }
  2472.         return $expr;
  2473.     }
  2475.     /**
  2476.      * ConditionalExpression ::= ConditionalTerm {"OR" ConditionalTerm}*
  2477.      *
  2478.      * @return AST\ConditionalExpression|AST\ConditionalFactor|AST\ConditionalPrimary|AST\ConditionalTerm
  2479.      */
  2480.     public function ConditionalExpression()
  2481.     {
  2482.         $conditionalTerms   = [];
  2483.         $conditionalTerms[] = $this->ConditionalTerm();
  2485.         while ($this->lexer->isNextToken(Lexer::T_OR)) {
  2486.             $this->match(Lexer::T_OR);
  2488.             $conditionalTerms[] = $this->ConditionalTerm();
  2489.         }
  2491.         // Phase 1 AST optimization: Prevent AST\ConditionalExpression
  2492.         // if only one AST\ConditionalTerm is defined
  2493.         if (count($conditionalTerms) === 1) {
  2494.             return $conditionalTerms[0];
  2495.         }
  2497.         return new AST\ConditionalExpression($conditionalTerms);
  2498.     }
  2500.     /**
  2501.      * ConditionalTerm ::= ConditionalFactor {"AND" ConditionalFactor}*
  2502.      *
  2503.      * @return AST\ConditionalFactor|AST\ConditionalPrimary|AST\ConditionalTerm
  2504.      */
  2505.     public function ConditionalTerm()
  2506.     {
  2507.         $conditionalFactors   = [];
  2508.         $conditionalFactors[] = $this->ConditionalFactor();
  2510.         while ($this->lexer->isNextToken(Lexer::T_AND)) {
  2511.             $this->match(Lexer::T_AND);
  2513.             $conditionalFactors[] = $this->ConditionalFactor();
  2514.         }
  2516.         // Phase 1 AST optimization: Prevent AST\ConditionalTerm
  2517.         // if only one AST\ConditionalFactor is defined
  2518.         if (count($conditionalFactors) === 1) {
  2519.             return $conditionalFactors[0];
  2520.         }
  2522.         return new AST\ConditionalTerm($conditionalFactors);
  2523.     }
  2525.     /**
  2526.      * ConditionalFactor ::= ["NOT"] ConditionalPrimary
  2527.      *
  2528.      * @return AST\ConditionalFactor|AST\ConditionalPrimary
  2529.      */
  2530.     public function ConditionalFactor()
  2531.     {
  2532.         $not = false;
  2534.         if ($this->lexer->isNextToken(Lexer::T_NOT)) {
  2535.             $this->match(Lexer::T_NOT);
  2537.             $not = true;
  2538.         }
  2540.         $conditionalPrimary = $this->ConditionalPrimary();
  2542.         // Phase 1 AST optimization: Prevent AST\ConditionalFactor
  2543.         // if only one AST\ConditionalPrimary is defined
  2544.         if (! $not) {
  2545.             return $conditionalPrimary;
  2546.         }
  2548.         $conditionalFactor      = new AST\ConditionalFactor($conditionalPrimary);
  2549.         $conditionalFactor->not = $not;
  2551.         return $conditionalFactor;
  2552.     }
  2554.     /**
  2555.      * ConditionalPrimary ::= SimpleConditionalExpression | "(" ConditionalExpression ")"
  2556.      *
  2557.      * @return ConditionalPrimary
  2558.      */
  2559.     public function ConditionalPrimary()
  2560.     {
  2561.         $condPrimary = new AST\ConditionalPrimary();
  2563.         if (! $this->lexer->isNextToken(Lexer::T_OPEN_PARENTHESIS)) {
  2564.             $condPrimary->simpleConditionalExpression = $this->SimpleConditionalExpression();
  2566.             return $condPrimary;
  2567.         }
  2569.         // Peek beyond the matching closing parenthesis ')'
  2570.         $peek = $this->peekBeyondClosingParenthesis();
  2572.         if (
  2573.             $peek !== null && (
  2574.             in_array($peek['value'], ['=', '<', '<=', '<>', '>', '>=', '!='], true) ||
  2575.             in_array($peek['type'], [Lexer::T_NOT, Lexer::T_BETWEEN, Lexer::T_LIKE, Lexer::T_IN, Lexer::T_IS, Lexer::T_EXISTS], true) ||
  2576.             $this->isMathOperator($peek)
  2577.             )
  2578.         ) {
  2579.             $condPrimary->simpleConditionalExpression = $this->SimpleConditionalExpression();
  2581.             return $condPrimary;
  2582.         }
  2584.         $this->match(Lexer::T_OPEN_PARENTHESIS);
  2585.         $condPrimary->conditionalExpression = $this->ConditionalExpression();
  2586.         $this->match(Lexer::T_CLOSE_PARENTHESIS);
  2588.         return $condPrimary;
  2589.     }
  2591.     /**
  2592.      * SimpleConditionalExpression ::=
  2593.      *      ComparisonExpression | BetweenExpression | LikeExpression |
  2594.      *      InExpression | NullComparisonExpression | ExistsExpression |
  2595.      *      EmptyCollectionComparisonExpression | CollectionMemberExpression |
  2596.      *      InstanceOfExpression
  2597.      *
  2598.      * @return AST\BetweenExpression|
  2599.      *         AST\CollectionMemberExpression|
  2600.      *         AST\ComparisonExpression|
  2601.      *         AST\EmptyCollectionComparisonExpression|
  2602.      *         AST\ExistsExpression|
  2603.      *         AST\InExpression|
  2604.      *         AST\InstanceOfExpression|
  2605.      *         AST\LikeExpression|
  2606.      *         AST\NullComparisonExpression
  2607.      */
  2608.     public function SimpleConditionalExpression()
  2609.     {
  2610.         if ($this->lexer->isNextToken(Lexer::T_EXISTS)) {
  2611.             return $this->ExistsExpression();
  2612.         }
  2614.         $token     = $this->lexer->lookahead;
  2615.         $peek      = $this->lexer->glimpse();
  2616.         $lookahead = $token;
  2618.         if ($this->lexer->isNextToken(Lexer::T_NOT)) {
  2619.             $token = $this->lexer->glimpse();
  2620.         }
  2622.         if ($token['type'] === Lexer::T_IDENTIFIER || $token['type'] === Lexer::T_INPUT_PARAMETER || $this->isFunction()) {
  2623.             // Peek beyond the matching closing parenthesis.
  2624.             $beyond = $this->lexer->peek();
  2626.             switch ($peek['value']) {
  2627.                 case '(':
  2628.                     // Peeks beyond the matched closing parenthesis.
  2629.                     $token = $this->peekBeyondClosingParenthesis(false);
  2631.                     if ($token['type'] === Lexer::T_NOT) {
  2632.                         $token = $this->lexer->peek();
  2633.                     }
  2635.                     if ($token['type'] === Lexer::T_IS) {
  2636.                         $lookahead = $this->lexer->peek();
  2637.                     }
  2639.                     break;
  2641.                 default:
  2642.                     // Peek beyond the PathExpression or InputParameter.
  2643.                     $token = $beyond;
  2645.                     while ($token['value'] === '.') {
  2646.                         $this->lexer->peek();
  2648.                         $token = $this->lexer->peek();
  2649.                     }
  2651.                     // Also peek beyond a NOT if there is one.
  2652.                     if ($token['type'] === Lexer::T_NOT) {
  2653.                         $token = $this->lexer->peek();
  2654.                     }
  2656.                     // We need to go even further in case of IS (differentiate between NULL and EMPTY)
  2657.                     $lookahead = $this->lexer->peek();
  2658.             }
  2660.             // Also peek beyond a NOT if there is one.
  2661.             if ($lookahead['type'] === Lexer::T_NOT) {
  2662.                 $lookahead = $this->lexer->peek();
  2663.             }
  2665.             $this->lexer->resetPeek();
  2666.         }
  2668.         if ($token['type'] === Lexer::T_BETWEEN) {
  2669.             return $this->BetweenExpression();
  2670.         }
  2672.         if ($token['type'] === Lexer::T_LIKE) {
  2673.             return $this->LikeExpression();
  2674.         }
  2676.         if ($token['type'] === Lexer::T_IN) {
  2677.             return $this->InExpression();
  2678.         }
  2680.         if ($token['type'] === Lexer::T_INSTANCE) {
  2681.             return $this->InstanceOfExpression();
  2682.         }
  2684.         if ($token['type'] === Lexer::T_MEMBER) {
  2685.             return $this->CollectionMemberExpression();
  2686.         }
  2688.         if ($token['type'] === Lexer::T_IS && $lookahead['type'] === Lexer::T_NULL) {
  2689.             return $this->NullComparisonExpression();
  2690.         }
  2692.         if ($token['type'] === Lexer::T_IS && $lookahead['type'] === Lexer::T_EMPTY) {
  2693.             return $this->EmptyCollectionComparisonExpression();
  2694.         }
  2696.         return $this->ComparisonExpression();
  2697.     }
  2699.     /**
  2700.      * EmptyCollectionComparisonExpression ::= CollectionValuedPathExpression "IS" ["NOT"] "EMPTY"
  2701.      *
  2702.      * @return EmptyCollectionComparisonExpression
  2703.      */
  2704.     public function EmptyCollectionComparisonExpression()
  2705.     {
  2706.         $emptyCollectionCompExpr = new AST\EmptyCollectionComparisonExpression(
  2707.             $this->CollectionValuedPathExpression()
  2708.         );
  2709.         $this->match(Lexer::T_IS);
  2711.         if ($this->lexer->isNextToken(Lexer::T_NOT)) {
  2712.             $this->match(Lexer::T_NOT);
  2713.             $emptyCollectionCompExpr->not = true;
  2714.         }
  2716.         $this->match(Lexer::T_EMPTY);
  2718.         return $emptyCollectionCompExpr;
  2719.     }
  2721.     /**
  2722.      * CollectionMemberExpression ::= EntityExpression ["NOT"] "MEMBER" ["OF"] CollectionValuedPathExpression
  2723.      *
  2724.      * EntityExpression ::= SingleValuedAssociationPathExpression | SimpleEntityExpression
  2725.      * SimpleEntityExpression ::= IdentificationVariable | InputParameter
  2726.      *
  2727.      * @return CollectionMemberExpression
  2728.      */
  2729.     public function CollectionMemberExpression()
  2730.     {
  2731.         $not        = false;
  2732.         $entityExpr = $this->EntityExpression();
  2734.         if ($this->lexer->isNextToken(Lexer::T_NOT)) {
  2735.             $this->match(Lexer::T_NOT);
  2737.             $not = true;
  2738.         }
  2740.         $this->match(Lexer::T_MEMBER);
  2742.         if ($this->lexer->isNextToken(Lexer::T_OF)) {
  2743.             $this->match(Lexer::T_OF);
  2744.         }
  2746.         $collMemberExpr      = new AST\CollectionMemberExpression(
  2747.             $entityExpr,
  2748.             $this->CollectionValuedPathExpression()
  2749.         );
  2750.         $collMemberExpr->not = $not;
  2752.         return $collMemberExpr;
  2753.     }
  2755.     /**
  2756.      * Literal ::= string | char | integer | float | boolean
  2757.      *
  2758.      * @return Literal
  2759.      */
  2760.     public function Literal()
  2761.     {
  2762.         switch ($this->lexer->lookahead['type']) {
  2763.             case Lexer::T_STRING:
  2764.                 $this->match(Lexer::T_STRING);
  2766.                 return new AST\Literal(AST\Literal::STRING, $this->lexer->token['value']);
  2768.             case Lexer::T_INTEGER:
  2769.             case Lexer::T_FLOAT:
  2770.                 $this->match(
  2771.                     $this->lexer->isNextToken(Lexer::T_INTEGER) ? Lexer::T_INTEGER : Lexer::T_FLOAT
  2772.                 );
  2774.                 return new AST\Literal(AST\Literal::NUMERIC, $this->lexer->token['value']);
  2776.             case Lexer::T_TRUE:
  2777.             case Lexer::T_FALSE:
  2778.                 $this->match(
  2779.                     $this->lexer->isNextToken(Lexer::T_TRUE) ? Lexer::T_TRUE : Lexer::T_FALSE
  2780.                 );
  2782.                 return new AST\Literal(AST\Literal::BOOLEAN, $this->lexer->token['value']);
  2784.             default:
  2785.                 $this->syntaxError('Literal');
  2786.         }
  2787.     }
  2789.     /**
  2790.      * InParameter ::= ArithmeticExpression | InputParameter
  2791.      *
  2792.      * @return AST\InputParameter|AST\ArithmeticExpression
  2793.      */
  2794.     public function InParameter()
  2795.     {
  2796.         if ($this->lexer->lookahead['type'] === Lexer::T_INPUT_PARAMETER) {
  2797.             return $this->InputParameter();
  2798.         }
  2800.         return $this->ArithmeticExpression();
  2801.     }
  2803.     /**
  2804.      * InputParameter ::= PositionalParameter | NamedParameter
  2805.      *
  2806.      * @return InputParameter
  2807.      */
  2808.     public function InputParameter()
  2809.     {
  2810.         $this->match(Lexer::T_INPUT_PARAMETER);
  2812.         return new AST\InputParameter($this->lexer->token['value']);
  2813.     }
  2815.     /**
  2816.      * ArithmeticExpression ::= SimpleArithmeticExpression | "(" Subselect ")"
  2817.      *
  2818.      * @return ArithmeticExpression
  2819.      */
  2820.     public function ArithmeticExpression()
  2821.     {
  2822.         $expr = new AST\ArithmeticExpression();
  2824.         if ($this->lexer->isNextToken(Lexer::T_OPEN_PARENTHESIS)) {
  2825.             $peek = $this->lexer->glimpse();
  2827.             if ($peek['type'] === Lexer::T_SELECT) {
  2828.                 $this->match(Lexer::T_OPEN_PARENTHESIS);
  2829.                 $expr->subselect = $this->Subselect();
  2830.                 $this->match(Lexer::T_CLOSE_PARENTHESIS);
  2832.                 return $expr;
  2833.             }
  2834.         }
  2836.         $expr->simpleArithmeticExpression = $this->SimpleArithmeticExpression();
  2838.         return $expr;
  2839.     }
  2841.     /**
  2842.      * SimpleArithmeticExpression ::= ArithmeticTerm {("+" | "-") ArithmeticTerm}*
  2843.      *
  2844.      * @return SimpleArithmeticExpression|ArithmeticTerm
  2845.      */
  2846.     public function SimpleArithmeticExpression()
  2847.     {
  2848.         $terms   = [];
  2849.         $terms[] = $this->ArithmeticTerm();
  2851.         while (($isPlus = $this->lexer->isNextToken(Lexer::T_PLUS)) || $this->lexer->isNextToken(Lexer::T_MINUS)) {
  2852.             $this->match($isPlus ? Lexer::T_PLUS : Lexer::T_MINUS);
  2854.             $terms[] = $this->lexer->token['value'];
  2855.             $terms[] = $this->ArithmeticTerm();
  2856.         }
  2858.         // Phase 1 AST optimization: Prevent AST\SimpleArithmeticExpression
  2859.         // if only one AST\ArithmeticTerm is defined
  2860.         if (count($terms) === 1) {
  2861.             return $terms[0];
  2862.         }
  2864.         return new AST\SimpleArithmeticExpression($terms);
  2865.     }
  2867.     /**
  2868.      * ArithmeticTerm ::= ArithmeticFactor {("*" | "/") ArithmeticFactor}*
  2869.      *
  2870.      * @return ArithmeticTerm
  2871.      */
  2872.     public function ArithmeticTerm()
  2873.     {
  2874.         $factors   = [];
  2875.         $factors[] = $this->ArithmeticFactor();
  2877.         while (($isMult = $this->lexer->isNextToken(Lexer::T_MULTIPLY)) || $this->lexer->isNextToken(Lexer::T_DIVIDE)) {
  2878.             $this->match($isMult ? Lexer::T_MULTIPLY : Lexer::T_DIVIDE);
  2880.             $factors[] = $this->lexer->token['value'];
  2881.             $factors[] = $this->ArithmeticFactor();
  2882.         }
  2884.         // Phase 1 AST optimization: Prevent AST\ArithmeticTerm
  2885.         // if only one AST\ArithmeticFactor is defined
  2886.         if (count($factors) === 1) {
  2887.             return $factors[0];
  2888.         }
  2890.         return new AST\ArithmeticTerm($factors);
  2891.     }
  2893.     /**
  2894.      * ArithmeticFactor ::= [("+" | "-")] ArithmeticPrimary
  2895.      *
  2896.      * @return ArithmeticFactor
  2897.      */
  2898.     public function ArithmeticFactor()
  2899.     {
  2900.         $sign = null;
  2902.         $isPlus = $this->lexer->isNextToken(Lexer::T_PLUS);
  2903.         if ($isPlus || $this->lexer->isNextToken(Lexer::T_MINUS)) {
  2904.             $this->match($isPlus ? Lexer::T_PLUS : Lexer::T_MINUS);
  2905.             $sign = $isPlus;
  2906.         }
  2908.         $primary = $this->ArithmeticPrimary();
  2910.         // Phase 1 AST optimization: Prevent AST\ArithmeticFactor
  2911.         // if only one AST\ArithmeticPrimary is defined
  2912.         if ($sign === null) {
  2913.             return $primary;
  2914.         }
  2916.         return new AST\ArithmeticFactor($primary, $sign);
  2917.     }
  2919.     /**
  2920.      * ArithmeticPrimary ::= SingleValuedPathExpression | Literal | ParenthesisExpression
  2921.      *          | FunctionsReturningNumerics | AggregateExpression | FunctionsReturningStrings
  2922.      *          | FunctionsReturningDatetime | IdentificationVariable | ResultVariable
  2923.      *          | InputParameter | CaseExpression
  2924.      *
  2925.      * @return Node|string
  2926.      */
  2927.     public function ArithmeticPrimary()
  2928.     {
  2929.         if ($this->lexer->isNextToken(Lexer::T_OPEN_PARENTHESIS)) {
  2930.             $this->match(Lexer::T_OPEN_PARENTHESIS);
  2932.             $expr = $this->SimpleArithmeticExpression();
  2934.             $this->match(Lexer::T_CLOSE_PARENTHESIS);
  2936.             return new AST\ParenthesisExpression($expr);
  2937.         }
  2939.         switch ($this->lexer->lookahead['type']) {
  2940.             case Lexer::T_COALESCE:
  2941.             case Lexer::T_NULLIF:
  2942.             case Lexer::T_CASE:
  2943.                 return $this->CaseExpression();
  2945.             case Lexer::T_IDENTIFIER:
  2946.                 $peek = $this->lexer->glimpse();
  2948.                 if ($peek !== null && $peek['value'] === '(') {
  2949.                     return $this->FunctionDeclaration();
  2950.                 }
  2952.                 if ($peek !== null && $peek['value'] === '.') {
  2953.                     return $this->SingleValuedPathExpression();
  2954.                 }
  2956.                 if (isset($this->queryComponents[$this->lexer->lookahead['value']]['resultVariable'])) {
  2957.                     return $this->ResultVariable();
  2958.                 }
  2960.                 return $this->StateFieldPathExpression();
  2962.             case Lexer::T_INPUT_PARAMETER:
  2963.                 return $this->InputParameter();
  2965.             default:
  2966.                 $peek = $this->lexer->glimpse();
  2968.                 if ($peek !== null && $peek['value'] === '(') {
  2969.                     return $this->FunctionDeclaration();
  2970.                 }
  2972.                 return $this->Literal();
  2973.         }
  2974.     }
  2976.     /**
  2977.      * StringExpression ::= StringPrimary | ResultVariable | "(" Subselect ")"
  2978.      *
  2979.      * @return Subselect|Node|string
  2980.      */
  2981.     public function StringExpression()
  2982.     {
  2983.         $peek = $this->lexer->glimpse();
  2985.         // Subselect
  2986.         if ($this->lexer->isNextToken(Lexer::T_OPEN_PARENTHESIS) && $peek['type'] === Lexer::T_SELECT) {
  2987.             $this->match(Lexer::T_OPEN_PARENTHESIS);
  2988.             $expr = $this->Subselect();
  2989.             $this->match(Lexer::T_CLOSE_PARENTHESIS);
  2991.             return $expr;
  2992.         }
  2994.         // ResultVariable (string)
  2995.         if (
  2996.             $this->lexer->isNextToken(Lexer::T_IDENTIFIER) &&
  2997.             isset($this->queryComponents[$this->lexer->lookahead['value']]['resultVariable'])
  2998.         ) {
  2999.             return $this->ResultVariable();
  3000.         }
  3002.         return $this->StringPrimary();
  3003.     }
  3005.     /**
  3006.      * StringPrimary ::= StateFieldPathExpression | string | InputParameter | FunctionsReturningStrings | AggregateExpression | CaseExpression
  3007.      *
  3008.      * @return Node
  3009.      */
  3010.     public function StringPrimary()
  3011.     {
  3012.         $lookaheadType = $this->lexer->lookahead['type'];
  3014.         switch ($lookaheadType) {
  3015.             case Lexer::T_IDENTIFIER:
  3016.                 $peek = $this->lexer->glimpse();
  3018.                 if ($peek['value'] === '.') {
  3019.                     return $this->StateFieldPathExpression();
  3020.                 }
  3022.                 if ($peek['value'] === '(') {
  3023.                     // do NOT directly go to FunctionsReturningString() because it doesn't check for custom functions.
  3024.                     return $this->FunctionDeclaration();
  3025.                 }
  3027.                 $this->syntaxError("'.' or '('");
  3028.                 break;
  3030.             case Lexer::T_STRING:
  3031.                 $this->match(Lexer::T_STRING);
  3033.                 return new AST\Literal(AST\Literal::STRING, $this->lexer->token['value']);
  3035.             case Lexer::T_INPUT_PARAMETER:
  3036.                 return $this->InputParameter();
  3038.             case Lexer::T_CASE:
  3039.             case Lexer::T_COALESCE:
  3040.             case Lexer::T_NULLIF:
  3041.                 return $this->CaseExpression();
  3043.             default:
  3044.                 if ($this->isAggregateFunction($lookaheadType)) {
  3045.                     return $this->AggregateExpression();
  3046.                 }
  3047.         }
  3049.         $this->syntaxError(
  3050.             'StateFieldPathExpression | string | InputParameter | FunctionsReturningStrings | AggregateExpression'
  3051.         );
  3052.     }
  3054.     /**
  3055.      * EntityExpression ::= SingleValuedAssociationPathExpression | SimpleEntityExpression
  3056.      *
  3057.      * @return AST\InputParameter|PathExpression
  3058.      */
  3059.     public function EntityExpression()
  3060.     {
  3061.         $glimpse = $this->lexer->glimpse();
  3063.         if ($this->lexer->isNextToken(Lexer::T_IDENTIFIER) && $glimpse['value'] === '.') {
  3064.             return $this->SingleValuedAssociationPathExpression();
  3065.         }
  3067.         return $this->SimpleEntityExpression();
  3068.     }
  3070.     /**
  3071.      * SimpleEntityExpression ::= IdentificationVariable | InputParameter
  3072.      *
  3073.      * @return AST\InputParameter|AST\PathExpression
  3074.      */
  3075.     public function SimpleEntityExpression()
  3076.     {
  3077.         if ($this->lexer->isNextToken(Lexer::T_INPUT_PARAMETER)) {
  3078.             return $this->InputParameter();
  3079.         }
  3081.         return $this->StateFieldPathExpression();
  3082.     }
  3084.     /**
  3085.      * AggregateExpression ::=
  3086.      *  ("AVG" | "MAX" | "MIN" | "SUM" | "COUNT") "(" ["DISTINCT"] SimpleArithmeticExpression ")"
  3087.      *
  3088.      * @return AggregateExpression
  3089.      */
  3090.     public function AggregateExpression()
  3091.     {
  3092.         $lookaheadType = $this->lexer->lookahead['type'];
  3093.         $isDistinct    = false;
  3095.         if (! in_array($lookaheadType, [Lexer::T_COUNT, Lexer::T_AVG, Lexer::T_MAX, Lexer::T_MIN, Lexer::T_SUM], true)) {
  3096.             $this->syntaxError('One of: MAX, MIN, AVG, SUM, COUNT');
  3097.         }
  3099.         $this->match($lookaheadType);
  3100.         $functionName = $this->lexer->token['value'];
  3101.         $this->match(Lexer::T_OPEN_PARENTHESIS);
  3103.         if ($this->lexer->isNextToken(Lexer::T_DISTINCT)) {
  3104.             $this->match(Lexer::T_DISTINCT);
  3105.             $isDistinct = true;
  3106.         }
  3108.         $pathExp = $this->SimpleArithmeticExpression();
  3110.         $this->match(Lexer::T_CLOSE_PARENTHESIS);
  3112.         return new AST\AggregateExpression($functionName, $pathExp, $isDistinct);
  3113.     }
  3115.     /**
  3116.      * QuantifiedExpression ::= ("ALL" | "ANY" | "SOME") "(" Subselect ")"
  3117.      *
  3118.      * @return QuantifiedExpression
  3119.      */
  3120.     public function QuantifiedExpression()
  3121.     {
  3122.         $lookaheadType = $this->lexer->lookahead['type'];
  3123.         $value         = $this->lexer->lookahead['value'];
  3125.         if (! in_array($lookaheadType, [Lexer::T_ALL, Lexer::T_ANY, Lexer::T_SOME], true)) {
  3126.             $this->syntaxError('ALL, ANY or SOME');
  3127.         }
  3129.         $this->match($lookaheadType);
  3130.         $this->match(Lexer::T_OPEN_PARENTHESIS);
  3132.         $qExpr       = new AST\QuantifiedExpression($this->Subselect());
  3133.         $qExpr->type = $value;
  3135.         $this->match(Lexer::T_CLOSE_PARENTHESIS);
  3137.         return $qExpr;
  3138.     }
  3140.     /**
  3141.      * BetweenExpression ::= ArithmeticExpression ["NOT"] "BETWEEN" ArithmeticExpression "AND" ArithmeticExpression
  3142.      *
  3143.      * @return BetweenExpression
  3144.      */
  3145.     public function BetweenExpression()
  3146.     {
  3147.         $not        = false;
  3148.         $arithExpr1 = $this->ArithmeticExpression();
  3150.         if ($this->lexer->isNextToken(Lexer::T_NOT)) {
  3151.             $this->match(Lexer::T_NOT);
  3152.             $not = true;
  3153.         }
  3155.         $this->match(Lexer::T_BETWEEN);
  3156.         $arithExpr2 = $this->ArithmeticExpression();
  3157.         $this->match(Lexer::T_AND);
  3158.         $arithExpr3 = $this->ArithmeticExpression();
  3160.         $betweenExpr      = new AST\BetweenExpression($arithExpr1, $arithExpr2, $arithExpr3);
  3161.         $betweenExpr->not = $not;
  3163.         return $betweenExpr;
  3164.     }
  3166.     /**
  3167.      * ComparisonExpression ::= ArithmeticExpression ComparisonOperator ( QuantifiedExpression | ArithmeticExpression )
  3168.      *
  3169.      * @return ComparisonExpression
  3170.      */
  3171.     public function ComparisonExpression()
  3172.     {
  3173.         $this->lexer->glimpse();
  3175.         $leftExpr  = $this->ArithmeticExpression();
  3176.         $operator  = $this->ComparisonOperator();
  3177.         $rightExpr = $this->isNextAllAnySome()
  3178.             ? $this->QuantifiedExpression()
  3179.             : $this->ArithmeticExpression();
  3181.         return new AST\ComparisonExpression($leftExpr, $operator, $rightExpr);
  3182.     }
  3184.     /**
  3185.      * InExpression ::= SingleValuedPathExpression ["NOT"] "IN" "(" (InParameter {"," InParameter}* | Subselect) ")"
  3186.      *
  3187.      * @return InExpression
  3188.      */
  3189.     public function InExpression()
  3190.     {
  3191.         $inExpression = new AST\InExpression($this->ArithmeticExpression());
  3193.         if ($this->lexer->isNextToken(Lexer::T_NOT)) {
  3194.             $this->match(Lexer::T_NOT);
  3195.             $inExpression->not = true;
  3196.         }
  3198.         $this->match(Lexer::T_IN);
  3199.         $this->match(Lexer::T_OPEN_PARENTHESIS);
  3201.         if ($this->lexer->isNextToken(Lexer::T_SELECT)) {
  3202.             $inExpression->subselect = $this->Subselect();
  3203.         } else {
  3204.             $literals   = [];
  3205.             $literals[] = $this->InParameter();
  3207.             while ($this->lexer->isNextToken(Lexer::T_COMMA)) {
  3208.                 $this->match(Lexer::T_COMMA);
  3209.                 $literals[] = $this->InParameter();
  3210.             }
  3212.             $inExpression->literals = $literals;
  3213.         }
  3215.         $this->match(Lexer::T_CLOSE_PARENTHESIS);
  3217.         return $inExpression;
  3218.     }
  3220.     /**
  3221.      * InstanceOfExpression ::= IdentificationVariable ["NOT"] "INSTANCE" ["OF"] (InstanceOfParameter | "(" InstanceOfParameter {"," InstanceOfParameter}* ")")
  3222.      *
  3223.      * @return InstanceOfExpression
  3224.      */
  3225.     public function InstanceOfExpression()
  3226.     {
  3227.         $instanceOfExpression = new AST\InstanceOfExpression($this->IdentificationVariable());
  3229.         if ($this->lexer->isNextToken(Lexer::T_NOT)) {
  3230.             $this->match(Lexer::T_NOT);
  3231.             $instanceOfExpression->not = true;
  3232.         }
  3234.         $this->match(Lexer::T_INSTANCE);
  3235.         $this->match(Lexer::T_OF);
  3237.         $exprValues = [];
  3239.         if ($this->lexer->isNextToken(Lexer::T_OPEN_PARENTHESIS)) {
  3240.             $this->match(Lexer::T_OPEN_PARENTHESIS);
  3242.             $exprValues[] = $this->InstanceOfParameter();
  3244.             while ($this->lexer->isNextToken(Lexer::T_COMMA)) {
  3245.                 $this->match(Lexer::T_COMMA);
  3247.                 $exprValues[] = $this->InstanceOfParameter();
  3248.             }
  3250.             $this->match(Lexer::T_CLOSE_PARENTHESIS);
  3252.             $instanceOfExpression->value = $exprValues;
  3254.             return $instanceOfExpression;
  3255.         }
  3257.         $exprValues[] = $this->InstanceOfParameter();
  3259.         $instanceOfExpression->value = $exprValues;
  3261.         return $instanceOfExpression;
  3262.     }
  3264.     /**
  3265.      * InstanceOfParameter ::= AbstractSchemaName | InputParameter
  3266.      *
  3267.      * @return mixed
  3268.      */
  3269.     public function InstanceOfParameter()
  3270.     {
  3271.         if ($this->lexer->isNextToken(Lexer::T_INPUT_PARAMETER)) {
  3272.             $this->match(Lexer::T_INPUT_PARAMETER);
  3274.             return new AST\InputParameter($this->lexer->token['value']);
  3275.         }
  3277.         $abstractSchemaName = $this->AbstractSchemaName();
  3279.         $this->validateAbstractSchemaName($abstractSchemaName);
  3281.         return $abstractSchemaName;
  3282.     }
  3284.     /**
  3285.      * LikeExpression ::= StringExpression ["NOT"] "LIKE" StringPrimary ["ESCAPE" char]
  3286.      *
  3287.      * @return LikeExpression
  3288.      */
  3289.     public function LikeExpression()
  3290.     {
  3291.         $stringExpr = $this->StringExpression();
  3292.         $not        = false;
  3294.         if ($this->lexer->isNextToken(Lexer::T_NOT)) {
  3295.             $this->match(Lexer::T_NOT);
  3296.             $not = true;
  3297.         }
  3299.         $this->match(Lexer::T_LIKE);
  3301.         if ($this->lexer->isNextToken(Lexer::T_INPUT_PARAMETER)) {
  3302.             $this->match(Lexer::T_INPUT_PARAMETER);
  3303.             $stringPattern = new AST\InputParameter($this->lexer->token['value']);
  3304.         } else {
  3305.             $stringPattern = $this->StringPrimary();
  3306.         }
  3308.         $escapeChar = null;
  3310.         if ($this->lexer->lookahead !== null && $this->lexer->lookahead['type'] === Lexer::T_ESCAPE) {
  3311.             $this->match(Lexer::T_ESCAPE);
  3312.             $this->match(Lexer::T_STRING);
  3314.             $escapeChar = new AST\Literal(AST\Literal::STRING, $this->lexer->token['value']);
  3315.         }
  3317.         $likeExpr      = new AST\LikeExpression($stringExpr, $stringPattern, $escapeChar);
  3318.         $likeExpr->not = $not;
  3320.         return $likeExpr;
  3321.     }
  3323.     /**
  3324.      * NullComparisonExpression ::= (InputParameter | NullIfExpression | CoalesceExpression | AggregateExpression | FunctionDeclaration | IdentificationVariable | SingleValuedPathExpression | ResultVariable) "IS" ["NOT"] "NULL"
  3325.      *
  3326.      * @return NullComparisonExpression
  3327.      */
  3328.     public function NullComparisonExpression()
  3329.     {
  3330.         switch (true) {
  3331.             case $this->lexer->isNextToken(Lexer::T_INPUT_PARAMETER):
  3332.                 $this->match(Lexer::T_INPUT_PARAMETER);
  3334.                 $expr = new AST\InputParameter($this->lexer->token['value']);
  3335.                 break;
  3337.             case $this->lexer->isNextToken(Lexer::T_NULLIF):
  3338.                 $expr = $this->NullIfExpression();
  3339.                 break;
  3341.             case $this->lexer->isNextToken(Lexer::T_COALESCE):
  3342.                 $expr = $this->CoalesceExpression();
  3343.                 break;
  3345.             case $this->isFunction():
  3346.                 $expr = $this->FunctionDeclaration();
  3347.                 break;
  3349.             default:
  3350.                 // We need to check if we are in a IdentificationVariable or SingleValuedPathExpression
  3351.                 $glimpse = $this->lexer->glimpse();
  3353.                 if ($glimpse['type'] === Lexer::T_DOT) {
  3354.                     $expr = $this->SingleValuedPathExpression();
  3356.                     // Leave switch statement
  3357.                     break;
  3358.                 }
  3360.                 $lookaheadValue = $this->lexer->lookahead['value'];
  3362.                 // Validate existing component
  3363.                 if (! isset($this->queryComponents[$lookaheadValue])) {
  3364.                     $this->semanticalError('Cannot add having condition on undefined result variable.');
  3365.                 }
  3367.                 // Validate SingleValuedPathExpression (ie.: "product")
  3368.                 if (isset($this->queryComponents[$lookaheadValue]['metadata'])) {
  3369.                     $expr = $this->SingleValuedPathExpression();
  3370.                     break;
  3371.                 }
  3373.                 // Validating ResultVariable
  3374.                 if (! isset($this->queryComponents[$lookaheadValue]['resultVariable'])) {
  3375.                     $this->semanticalError('Cannot add having condition on a non result variable.');
  3376.                 }
  3378.                 $expr = $this->ResultVariable();
  3379.                 break;
  3380.         }
  3382.         $nullCompExpr = new AST\NullComparisonExpression($expr);
  3384.         $this->match(Lexer::T_IS);
  3386.         if ($this->lexer->isNextToken(Lexer::T_NOT)) {
  3387.             $this->match(Lexer::T_NOT);
  3389.             $nullCompExpr->not = true;
  3390.         }
  3392.         $this->match(Lexer::T_NULL);
  3394.         return $nullCompExpr;
  3395.     }
  3397.     /**
  3398.      * ExistsExpression ::= ["NOT"] "EXISTS" "(" Subselect ")"
  3399.      *
  3400.      * @return ExistsExpression
  3401.      */
  3402.     public function ExistsExpression()
  3403.     {
  3404.         $not = false;
  3406.         if ($this->lexer->isNextToken(Lexer::T_NOT)) {
  3407.             $this->match(Lexer::T_NOT);
  3408.             $not = true;
  3409.         }
  3411.         $this->match(Lexer::T_EXISTS);
  3412.         $this->match(Lexer::T_OPEN_PARENTHESIS);
  3414.         $existsExpression      = new AST\ExistsExpression($this->Subselect());
  3415.         $existsExpression->not = $not;
  3417.         $this->match(Lexer::T_CLOSE_PARENTHESIS);
  3419.         return $existsExpression;
  3420.     }
  3422.     /**
  3423.      * ComparisonOperator ::= "=" | "<" | "<=" | "<>" | ">" | ">=" | "!="
  3424.      *
  3425.      * @return string
  3426.      */
  3427.     public function ComparisonOperator()
  3428.     {
  3429.         switch ($this->lexer->lookahead['value']) {
  3430.             case '=':
  3431.                 $this->match(Lexer::T_EQUALS);
  3433.                 return '=';
  3435.             case '<':
  3436.                 $this->match(Lexer::T_LOWER_THAN);
  3437.                 $operator = '<';
  3439.                 if ($this->lexer->isNextToken(Lexer::T_EQUALS)) {
  3440.                     $this->match(Lexer::T_EQUALS);
  3441.                     $operator .= '=';
  3442.                 } elseif ($this->lexer->isNextToken(Lexer::T_GREATER_THAN)) {
  3443.                     $this->match(Lexer::T_GREATER_THAN);
  3444.                     $operator .= '>';
  3445.                 }
  3447.                 return $operator;
  3449.             case '>':
  3450.                 $this->match(Lexer::T_GREATER_THAN);
  3451.                 $operator = '>';
  3453.                 if ($this->lexer->isNextToken(Lexer::T_EQUALS)) {
  3454.                     $this->match(Lexer::T_EQUALS);
  3455.                     $operator .= '=';
  3456.                 }
  3458.                 return $operator;
  3460.             case '!':
  3461.                 $this->match(Lexer::T_NEGATE);
  3462.                 $this->match(Lexer::T_EQUALS);
  3464.                 return '<>';
  3466.             default:
  3467.                 $this->syntaxError('=, <, <=, <>, >, >=, !=');
  3468.         }
  3469.     }
  3471.     /**
  3472.      * FunctionDeclaration ::= FunctionsReturningStrings | FunctionsReturningNumerics | FunctionsReturningDatetime
  3473.      *
  3474.      * @return FunctionNode
  3475.      */
  3476.     public function FunctionDeclaration()
  3477.     {
  3478.         $token    = $this->lexer->lookahead;
  3479.         $funcName = strtolower($token['value']);
  3481.         $customFunctionDeclaration = $this->CustomFunctionDeclaration();
  3483.         // Check for custom functions functions first!
  3484.         switch (true) {
  3485.             case $customFunctionDeclaration !== null:
  3486.                 return $customFunctionDeclaration;
  3488.             case isset(self::$stringFunctions[$funcName]):
  3489.                 return $this->FunctionsReturningStrings();
  3491.             case isset(self::$numericFunctions[$funcName]):
  3492.                 return $this->FunctionsReturningNumerics();
  3494.             case isset(self::$datetimeFunctions[$funcName]):
  3495.                 return $this->FunctionsReturningDatetime();
  3497.             default:
  3498.                 $this->syntaxError('known function', $token);
  3499.         }
  3500.     }
  3502.     /**
  3503.      * Helper function for FunctionDeclaration grammar rule.
  3504.      */
  3505.     private function CustomFunctionDeclaration(): ?FunctionNode
  3506.     {
  3507.         $token    = $this->lexer->lookahead;
  3508.         $funcName = strtolower($token['value']);
  3510.         // Check for custom functions afterwards
  3511.         $config = $this->em->getConfiguration();
  3513.         switch (true) {
  3514.             case $config->getCustomStringFunction($funcName) !== null:
  3515.                 return $this->CustomFunctionsReturningStrings();
  3517.             case $config->getCustomNumericFunction($funcName) !== null:
  3518.                 return $this->CustomFunctionsReturningNumerics();
  3520.             case $config->getCustomDatetimeFunction($funcName) !== null:
  3521.                 return $this->CustomFunctionsReturningDatetime();
  3523.             default:
  3524.                 return null;
  3525.         }
  3526.     }
  3528.     /**
  3529.      * FunctionsReturningNumerics ::=
  3530.      *      "LENGTH" "(" StringPrimary ")" |
  3531.      *      "LOCATE" "(" StringPrimary "," StringPrimary ["," SimpleArithmeticExpression]")" |
  3532.      *      "ABS" "(" SimpleArithmeticExpression ")" |
  3533.      *      "SQRT" "(" SimpleArithmeticExpression ")" |
  3534.      *      "MOD" "(" SimpleArithmeticExpression "," SimpleArithmeticExpression ")" |
  3535.      *      "SIZE" "(" CollectionValuedPathExpression ")" |
  3536.      *      "DATE_DIFF" "(" ArithmeticPrimary "," ArithmeticPrimary ")" |
  3537.      *      "BIT_AND" "(" ArithmeticPrimary "," ArithmeticPrimary ")" |
  3538.      *      "BIT_OR" "(" ArithmeticPrimary "," ArithmeticPrimary ")"
  3539.      *
  3540.      * @return FunctionNode
  3541.      */
  3542.     public function FunctionsReturningNumerics()
  3543.     {
  3544.         $funcNameLower = strtolower($this->lexer->lookahead['value']);
  3545.         $funcClass     = self::$numericFunctions[$funcNameLower];
  3547.         $function = new $funcClass($funcNameLower);
  3548.         $function->parse($this);
  3550.         return $function;
  3551.     }
  3553.     /**
  3554.      * @return FunctionNode
  3555.      */
  3556.     public function CustomFunctionsReturningNumerics()
  3557.     {
  3558.         // getCustomNumericFunction is case-insensitive
  3559.         $functionName  = strtolower($this->lexer->lookahead['value']);
  3560.         $functionClass = $this->em->getConfiguration()->getCustomNumericFunction($functionName);
  3562.         assert($functionClass !== null);
  3564.         $function = is_string($functionClass)
  3565.             ? new $functionClass($functionName)
  3566.             : call_user_func($functionClass, $functionName);
  3568.         $function->parse($this);
  3570.         return $function;
  3571.     }
  3573.     /**
  3574.      * FunctionsReturningDateTime ::=
  3575.      *     "CURRENT_DATE" |
  3576.      *     "CURRENT_TIME" |
  3577.      *     "CURRENT_TIMESTAMP" |
  3578.      *     "DATE_ADD" "(" ArithmeticPrimary "," ArithmeticPrimary "," StringPrimary ")" |
  3579.      *     "DATE_SUB" "(" ArithmeticPrimary "," ArithmeticPrimary "," StringPrimary ")"
  3580.      *
  3581.      * @return FunctionNode
  3582.      */
  3583.     public function FunctionsReturningDatetime()
  3584.     {
  3585.         $funcNameLower = strtolower($this->lexer->lookahead['value']);
  3586.         $funcClass     = self::$datetimeFunctions[$funcNameLower];
  3588.         $function = new $funcClass($funcNameLower);
  3589.         $function->parse($this);
  3591.         return $function;
  3592.     }
  3594.     /**
  3595.      * @return FunctionNode
  3596.      */
  3597.     public function CustomFunctionsReturningDatetime()
  3598.     {
  3599.         // getCustomDatetimeFunction is case-insensitive
  3600.         $functionName  = $this->lexer->lookahead['value'];
  3601.         $functionClass = $this->em->getConfiguration()->getCustomDatetimeFunction($functionName);
  3603.         assert($functionClass !== null);
  3605.         $function = is_string($functionClass)
  3606.             ? new $functionClass($functionName)
  3607.             : call_user_func($functionClass, $functionName);
  3609.         $function->parse($this);
  3611.         return $function;
  3612.     }
  3614.     /**
  3615.      * FunctionsReturningStrings ::=
  3616.      *   "CONCAT" "(" StringPrimary "," StringPrimary {"," StringPrimary}* ")" |
  3617.      *   "SUBSTRING" "(" StringPrimary "," SimpleArithmeticExpression "," SimpleArithmeticExpression ")" |
  3618.      *   "TRIM" "(" [["LEADING" | "TRAILING" | "BOTH"] [char] "FROM"] StringPrimary ")" |
  3619.      *   "LOWER" "(" StringPrimary ")" |
  3620.      *   "UPPER" "(" StringPrimary ")" |
  3621.      *   "IDENTITY" "(" SingleValuedAssociationPathExpression {"," string} ")"
  3622.      *
  3623.      * @return FunctionNode
  3624.      */
  3625.     public function FunctionsReturningStrings()
  3626.     {
  3627.         $funcNameLower = strtolower($this->lexer->lookahead['value']);
  3628.         $funcClass     = self::$stringFunctions[$funcNameLower];
  3630.         $function = new $funcClass($funcNameLower);
  3631.         $function->parse($this);
  3633.         return $function;
  3634.     }
  3636.     /**
  3637.      * @return FunctionNode
  3638.      */
  3639.     public function CustomFunctionsReturningStrings()
  3640.     {
  3641.         // getCustomStringFunction is case-insensitive
  3642.         $functionName  = $this->lexer->lookahead['value'];
  3643.         $functionClass = $this->em->getConfiguration()->getCustomStringFunction($functionName);
  3645.         assert($functionClass !== null);
  3647.         $function = is_string($functionClass)
  3648.             ? new $functionClass($functionName)
  3649.             : call_user_func($functionClass, $functionName);
  3651.         $function->parse($this);
  3653.         return $function;
  3654.     }
  3656.     private function getMetadataForDqlAlias(string $dqlAlias): ClassMetadata
  3657.     {
  3658.         if (! isset($this->queryComponents[$dqlAlias]['metadata'])) {
  3659.             throw new LogicException(sprintf('No metadata for DQL alias: %s', $dqlAlias));
  3660.         }
  3662.         return $this->queryComponents[$dqlAlias]['metadata'];
  3663.     }
  3664. }