TreeWalker
in
Interface for walkers of DQL ASTs (abstract syntax trees).
Tags
Table of Contents
Methods
- __construct() : mixed
- Initializes TreeWalker with important information about the ASTs to be walked.
- getExecutor() : AbstractSqlExecutor
- Gets an executor that can be used to execute the result of this walker.
- getQueryComponents() : array<string, array<string, mixed>>
- Returns internal queryComponents array.
- setQueryComponent() : void
- Sets or overrides a query component for a given dql alias.
- walkAggregateExpression() : void
- Walks down an AggregateExpression AST node.
- walkArithmeticExpression() : void
- Walks down an ArithmeticExpression AST node.
- walkArithmeticFactor() : void
- Walks down an ArithmeticFactor that represents an AST node.
- walkArithmeticTerm() : void
- Walks down an ArithmeticTerm AST node.
- walkBetweenExpression() : void
- Walks down a BetweenExpression AST node.
- walkCollectionMemberExpression() : void
- Walks down a CollectionMemberExpression AST node.
- walkComparisonExpression() : void
- Walks down a ComparisonExpression AST node.
- walkConditionalExpression() : void
- Walk down a ConditionalExpression AST node.
- walkConditionalFactor() : void
- Walks down a ConditionalFactor AST node.
- walkConditionalPrimary() : void
- Walks down a ConditionalPrimary AST node.
- walkConditionalTerm() : void
- Walks down a ConditionalTerm AST node.
- walkDeleteClause() : void
- Walks down a DeleteClause AST node.
- walkDeleteStatement() : void
- Walks down a DeleteStatement AST node.
- walkEmptyCollectionComparisonExpression() : void
- Walks down an EmptyCollectionComparisonExpression AST node.
- walkExistsExpression() : void
- Walks down an ExistsExpression AST node.
- walkFromClause() : void
- Walks down a FromClause AST node.
- walkFunction() : void
- Walks down a FunctionNode AST node.
- walkGroupByClause() : void
- Walks down a GroupByClause AST node.
- walkGroupByItem() : void
- Walks down a GroupByItem AST node.
- walkHavingClause() : void
- Walks down a HavingClause AST node.
- walkInExpression() : void
- Walks down an InExpression AST node.
- walkInputParameter() : void
- Walks down an InputParameter AST node.
- walkInstanceOfExpression() : void
- Walks down an InstanceOfExpression AST node.
- walkJoin() : void
- Walks down a Join AST node.
- walkLikeExpression() : void
- Walks down a LikeExpression AST node.
- walkLiteral() : void
- Walks down a literal that represents an AST node.
- walkNullComparisonExpression() : void
- Walks down a NullComparisonExpression AST node.
- walkOrderByClause() : void
- Walks down an OrderByClause AST node.
- walkOrderByItem() : void
- Walks down an OrderByItem AST node, thereby generating the appropriate SQL.
- walkPathExpression() : void
- Walks down a PathExpression AST node.
- walkQuantifiedExpression() : void
- Walks down a QuantifiedExpression AST node.
- walkResultVariable() : void
- Walks down a ResultVariable that represents an AST node.
- walkSelectClause() : void
- Walks down a SelectClause AST node.
- walkSelectExpression() : void
- Walks down a SelectExpression AST node.
- walkSelectStatement() : void
- Walks down a SelectStatement AST node.
- walkSimpleArithmeticExpression() : void
- Walks down an SimpleArithmeticExpression AST node.
- walkSimpleSelectClause() : void
- Walks down a SimpleSelectClause AST node.
- walkSimpleSelectExpression() : void
- Walks down a SimpleSelectExpression AST node.
- walkStateFieldPathExpression() : void
- Walks down a StateFieldPathExpression AST node.
- walkStringPrimary() : void
- Walks down a StringPrimary that represents an AST node.
- walkSubselect() : void
- Walks down a Subselect AST node.
- walkSubselectFromClause() : void
- Walks down a SubselectFromClause AST node.
- walkUpdateClause() : void
- Walks down an UpdateClause AST node.
- walkUpdateItem() : void
- Walks down an UpdateItem AST node.
- walkUpdateStatement() : void
- Walks down an UpdateStatement AST node.
- walkWhereClause() : void
- Walks down a WhereClause AST node.
Methods
__construct()
Initializes TreeWalker with important information about the ASTs to be walked.
public
__construct(AbstractQuery $query, ParserResult $parserResult, array<string|int, mixed> $queryComponents) : mixed
Parameters
- $query : AbstractQuery
-
The parsed Query.
- $parserResult : ParserResult
-
The result of the parsing process.
- $queryComponents : array<string|int, mixed>
-
The query components (symbol table).
Tags
getExecutor()
Gets an executor that can be used to execute the result of this walker.
public
getExecutor(DeleteStatement|UpdateStatement|SelectStatement $AST) : AbstractSqlExecutor
Parameters
Tags
Return values
AbstractSqlExecutorgetQueryComponents()
Returns internal queryComponents array.
public
getQueryComponents() : array<string, array<string, mixed>>
Tags
Return values
array<string, array<string, mixed>>setQueryComponent()
Sets or overrides a query component for a given dql alias.
public
setQueryComponent(string $dqlAlias, array<string, mixed> $queryComponent) : void
Parameters
- $dqlAlias : string
-
The DQL alias.
- $queryComponent : array<string, mixed>
Tags
walkAggregateExpression()
Walks down an AggregateExpression AST node.
public
walkAggregateExpression(AggregateExpression $aggExpression) : void
Parameters
- $aggExpression : AggregateExpression
Tags
walkArithmeticExpression()
Walks down an ArithmeticExpression AST node.
public
walkArithmeticExpression(ArithmeticExpression $arithmeticExpr) : void
Parameters
- $arithmeticExpr : ArithmeticExpression
Tags
walkArithmeticFactor()
Walks down an ArithmeticFactor that represents an AST node.
public
walkArithmeticFactor(mixed $factor) : void
Parameters
- $factor : mixed
Tags
walkArithmeticTerm()
Walks down an ArithmeticTerm AST node.
public
walkArithmeticTerm(mixed $term) : void
Parameters
- $term : mixed
Tags
walkBetweenExpression()
Walks down a BetweenExpression AST node.
public
walkBetweenExpression(BetweenExpression $betweenExpr) : void
Parameters
- $betweenExpr : BetweenExpression
Tags
walkCollectionMemberExpression()
Walks down a CollectionMemberExpression AST node.
public
walkCollectionMemberExpression(CollectionMemberExpression $collMemberExpr) : void
Parameters
- $collMemberExpr : CollectionMemberExpression
Tags
walkComparisonExpression()
Walks down a ComparisonExpression AST node.
public
walkComparisonExpression(ComparisonExpression $compExpr) : void
Parameters
- $compExpr : ComparisonExpression
Tags
walkConditionalExpression()
Walk down a ConditionalExpression AST node.
public
walkConditionalExpression(ConditionalExpression $condExpr) : void
Parameters
- $condExpr : ConditionalExpression
Tags
walkConditionalFactor()
Walks down a ConditionalFactor AST node.
public
walkConditionalFactor(ConditionalFactor $factor) : void
Parameters
- $factor : ConditionalFactor
Tags
walkConditionalPrimary()
Walks down a ConditionalPrimary AST node.
public
walkConditionalPrimary(ConditionalPrimary $primary) : void
Parameters
- $primary : ConditionalPrimary
Tags
walkConditionalTerm()
Walks down a ConditionalTerm AST node.
public
walkConditionalTerm(ConditionalTerm $condTerm) : void
Parameters
- $condTerm : ConditionalTerm
Tags
walkDeleteClause()
Walks down a DeleteClause AST node.
public
walkDeleteClause(DeleteClause $deleteClause) : void
Parameters
- $deleteClause : DeleteClause
Tags
walkDeleteStatement()
Walks down a DeleteStatement AST node.
public
walkDeleteStatement(DeleteStatement $AST) : void
Parameters
- $AST : DeleteStatement
walkEmptyCollectionComparisonExpression()
Walks down an EmptyCollectionComparisonExpression AST node.
public
walkEmptyCollectionComparisonExpression(EmptyCollectionComparisonExpression $emptyCollCompExpr) : void
Parameters
- $emptyCollCompExpr : EmptyCollectionComparisonExpression
Tags
walkExistsExpression()
Walks down an ExistsExpression AST node.
public
walkExistsExpression(ExistsExpression $existsExpr) : void
Parameters
- $existsExpr : ExistsExpression
Tags
walkFromClause()
Walks down a FromClause AST node.
public
walkFromClause(FromClause $fromClause) : void
Parameters
- $fromClause : FromClause
Tags
walkFunction()
Walks down a FunctionNode AST node.
public
walkFunction(FunctionNode $function) : void
Parameters
- $function : FunctionNode
Tags
walkGroupByClause()
Walks down a GroupByClause AST node.
public
walkGroupByClause(GroupByClause $groupByClause) : void
Parameters
- $groupByClause : GroupByClause
Tags
walkGroupByItem()
Walks down a GroupByItem AST node.
public
walkGroupByItem(PathExpression|string $groupByItem) : void
Parameters
- $groupByItem : PathExpression|string
Tags
walkHavingClause()
Walks down a HavingClause AST node.
public
walkHavingClause(HavingClause $havingClause) : void
Parameters
- $havingClause : HavingClause
Tags
walkInExpression()
Walks down an InExpression AST node.
public
walkInExpression(InExpression $inExpr) : void
Parameters
- $inExpr : InExpression
Tags
walkInputParameter()
Walks down an InputParameter AST node.
public
walkInputParameter(InputParameter $inputParam) : void
Parameters
- $inputParam : InputParameter
Tags
walkInstanceOfExpression()
Walks down an InstanceOfExpression AST node.
public
walkInstanceOfExpression(InstanceOfExpression $instanceOfExpr) : void
Parameters
- $instanceOfExpr : InstanceOfExpression
Tags
walkJoin()
Walks down a Join AST node.
public
walkJoin(Join $join) : void
Parameters
- $join : Join
Tags
walkLikeExpression()
Walks down a LikeExpression AST node.
public
walkLikeExpression(LikeExpression $likeExpr) : void
Parameters
- $likeExpr : LikeExpression
Tags
walkLiteral()
Walks down a literal that represents an AST node.
public
walkLiteral(Literal $literal) : void
Parameters
- $literal : Literal
Tags
walkNullComparisonExpression()
Walks down a NullComparisonExpression AST node.
public
walkNullComparisonExpression(NullComparisonExpression $nullCompExpr) : void
Parameters
- $nullCompExpr : NullComparisonExpression
Tags
walkOrderByClause()
Walks down an OrderByClause AST node.
public
walkOrderByClause(OrderByClause $orderByClause) : void
Parameters
- $orderByClause : OrderByClause
Tags
walkOrderByItem()
Walks down an OrderByItem AST node, thereby generating the appropriate SQL.
public
walkOrderByItem(OrderByItem $orderByItem) : void
Parameters
- $orderByItem : OrderByItem
Tags
walkPathExpression()
Walks down a PathExpression AST node.
public
walkPathExpression(PathExpression $pathExpr) : void
Parameters
- $pathExpr : PathExpression
Tags
walkQuantifiedExpression()
Walks down a QuantifiedExpression AST node.
public
walkQuantifiedExpression(QuantifiedExpression $qExpr) : void
Parameters
- $qExpr : QuantifiedExpression
Tags
walkResultVariable()
Walks down a ResultVariable that represents an AST node.
public
walkResultVariable(string $resultVariable) : void
Parameters
- $resultVariable : string
Tags
walkSelectClause()
Walks down a SelectClause AST node.
public
walkSelectClause(SelectClause $selectClause) : void
Parameters
- $selectClause : SelectClause
Tags
walkSelectExpression()
Walks down a SelectExpression AST node.
public
walkSelectExpression(SelectExpression $selectExpression) : void
Parameters
- $selectExpression : SelectExpression
Tags
walkSelectStatement()
Walks down a SelectStatement AST node.
public
walkSelectStatement(SelectStatement $AST) : void
Parameters
- $AST : SelectStatement
walkSimpleArithmeticExpression()
Walks down an SimpleArithmeticExpression AST node.
public
walkSimpleArithmeticExpression(SimpleArithmeticExpression $simpleArithmeticExpr) : void
Parameters
- $simpleArithmeticExpr : SimpleArithmeticExpression
Tags
walkSimpleSelectClause()
Walks down a SimpleSelectClause AST node.
public
walkSimpleSelectClause(SimpleSelectClause $simpleSelectClause) : void
Parameters
- $simpleSelectClause : SimpleSelectClause
Tags
walkSimpleSelectExpression()
Walks down a SimpleSelectExpression AST node.
public
walkSimpleSelectExpression(SimpleSelectExpression $simpleSelectExpression) : void
Parameters
- $simpleSelectExpression : SimpleSelectExpression
Tags
walkStateFieldPathExpression()
Walks down a StateFieldPathExpression AST node.
public
walkStateFieldPathExpression(PathExpression $stateFieldPathExpression) : void
Parameters
- $stateFieldPathExpression : PathExpression
Tags
walkStringPrimary()
Walks down a StringPrimary that represents an AST node.
public
walkStringPrimary(mixed $stringPrimary) : void
Parameters
- $stringPrimary : mixed
Tags
walkSubselect()
Walks down a Subselect AST node.
public
walkSubselect(Subselect $subselect) : void
Parameters
- $subselect : Subselect
Tags
walkSubselectFromClause()
Walks down a SubselectFromClause AST node.
public
walkSubselectFromClause(SubselectFromClause $subselectFromClause) : void
Parameters
- $subselectFromClause : SubselectFromClause
Tags
walkUpdateClause()
Walks down an UpdateClause AST node.
public
walkUpdateClause(UpdateClause $updateClause) : void
Parameters
- $updateClause : UpdateClause
Tags
walkUpdateItem()
Walks down an UpdateItem AST node.
public
walkUpdateItem(UpdateItem $updateItem) : void
Parameters
- $updateItem : UpdateItem
Tags
walkUpdateStatement()
Walks down an UpdateStatement AST node.
public
walkUpdateStatement(UpdateStatement $AST) : void
Parameters
- $AST : UpdateStatement
walkWhereClause()
Walks down a WhereClause AST node.
public
walkWhereClause(WhereClause $whereClause) : void
WhereClause or not, the appropriate discriminator sql is added.
Parameters
- $whereClause : WhereClause