Documentation

CountWalker extends TreeWalkerAdapter
in package

Replaces the selectClause of the AST with a COUNT statement.

Table of Contents

Constants

HINT_DISTINCT  = 'doctrine_paginator.distinct'
Distinct mode hint name.

Properties

$parserResult  : ParserResult
The ParserResult of the original query that was produced by the Parser.
$query  : AbstractQuery
The original Query.
$queryComponents  : mixed
The query components of the original query (the "symbol table") that was produced by the Parser.

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.
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.
_getParserResult()  : ParserResult
Retrieves the ParserResult.
_getQuery()  : AbstractQuery
Retrieves the Query Instance responsible for the current walkers execution.
_getQueryComponents()  : array<string, array<string, mixed>>
Returns internal queryComponents array.
getMetadataForDqlAlias()  : ClassMetadata

Constants

HINT_DISTINCT

Distinct mode hint name.

public mixed HINT_DISTINCT = 'doctrine_paginator.distinct'

Properties

$queryComponents

The query components of the original query (the "symbol table") that was produced by the Parser.

private mixed $queryComponents
Tags
psalm-var

array<string, QueryComponent>

Methods

__construct()

Initializes TreeWalker with important information about the ASTs to be walked.

public __construct(mixed $query, mixed $parserResult, array<string|int, mixed> $queryComponents) : mixed
Parameters
$query : mixed

The parsed Query.

$parserResult : mixed

The result of the parsing process.

$queryComponents : array<string|int, mixed>

The query components (symbol table).

getQueryComponents()

Returns internal queryComponents array.

public getQueryComponents() : array<string, array<string, mixed>>
Return values
array<string, array<string, mixed>>

walkAggregateExpression()

Walks down an AggregateExpression AST node.

public walkAggregateExpression(mixed $aggExpression) : void
Parameters
$aggExpression : mixed
Tags
deprecated

This method will be removed in 3.0.

walkArithmeticExpression()

Walks down an ArithmeticExpression AST node.

public walkArithmeticExpression(mixed $arithmeticExpr) : void
Parameters
$arithmeticExpr : mixed
Tags
deprecated

This method will be removed in 3.0.

walkArithmeticFactor()

Walks down an ArithmeticFactor that represents an AST node.

public walkArithmeticFactor(mixed $factor) : void
Parameters
$factor : mixed
Tags
deprecated

This method will be removed in 3.0.

walkArithmeticTerm()

Walks down an ArithmeticTerm AST node.

public walkArithmeticTerm(mixed $term) : void
Parameters
$term : mixed
Tags
deprecated

This method will be removed in 3.0.

walkBetweenExpression()

Walks down a BetweenExpression AST node.

public walkBetweenExpression(mixed $betweenExpr) : void
Parameters
$betweenExpr : mixed
Tags
deprecated

This method will be removed in 3.0.

walkCollectionMemberExpression()

Walks down a CollectionMemberExpression AST node.

public walkCollectionMemberExpression(mixed $collMemberExpr) : void
Parameters
$collMemberExpr : mixed
Tags
deprecated

This method will be removed in 3.0.

walkComparisonExpression()

Walks down a ComparisonExpression AST node.

public walkComparisonExpression(mixed $compExpr) : void
Parameters
$compExpr : mixed
Tags
deprecated

This method will be removed in 3.0.

walkConditionalExpression()

Walk down a ConditionalExpression AST node.

public walkConditionalExpression(mixed $condExpr) : void
Parameters
$condExpr : mixed
Tags
deprecated

This method will be removed in 3.0.

walkConditionalFactor()

Walks down a ConditionalFactor AST node.

public walkConditionalFactor(mixed $factor) : void
Parameters
$factor : mixed
Tags
deprecated

This method will be removed in 3.0.

walkConditionalPrimary()

Walks down a ConditionalPrimary AST node.

public walkConditionalPrimary(mixed $primary) : void
Parameters
$primary : mixed
Tags
deprecated

This method will be removed in 3.0.

walkConditionalTerm()

Walks down a ConditionalTerm AST node.

public walkConditionalTerm(mixed $condTerm) : void
Parameters
$condTerm : mixed
Tags
deprecated

This method will be removed in 3.0.

walkDeleteClause()

Walks down a DeleteClause AST node.

public walkDeleteClause(DeleteClause $deleteClause) : void
Parameters
$deleteClause : DeleteClause
Tags
deprecated

This method will be removed in 3.0.

walkEmptyCollectionComparisonExpression()

Walks down an EmptyCollectionComparisonExpression AST node.

public walkEmptyCollectionComparisonExpression(mixed $emptyCollCompExpr) : void
Parameters
$emptyCollCompExpr : mixed
Tags
deprecated

This method will be removed in 3.0.

walkExistsExpression()

Walks down an ExistsExpression AST node.

public walkExistsExpression(mixed $existsExpr) : void
Parameters
$existsExpr : mixed
Tags
deprecated

This method will be removed in 3.0.

walkFromClause()

Walks down a FromClause AST node.

public walkFromClause(mixed $fromClause) : void
Parameters
$fromClause : mixed
Tags
deprecated

This method will be removed in 3.0.

walkFunction()

Walks down a FunctionNode AST node.

public walkFunction(mixed $function) : void
Parameters
$function : mixed
Tags
deprecated

This method will be removed in 3.0.

walkGroupByClause()

Walks down a GroupByClause AST node.

public walkGroupByClause(mixed $groupByClause) : void
Parameters
$groupByClause : mixed
Tags
deprecated

This method will be removed in 3.0.

walkGroupByItem()

Walks down a GroupByItem AST node.

public walkGroupByItem(mixed $groupByItem) : void
Parameters
$groupByItem : mixed
Tags
deprecated

This method will be removed in 3.0.

walkHavingClause()

Walks down a HavingClause AST node.

public walkHavingClause(mixed $havingClause) : void
Parameters
$havingClause : mixed
Tags
deprecated

This method will be removed in 3.0.

walkInExpression()

Walks down an InExpression AST node.

public walkInExpression(mixed $inExpr) : void
Parameters
$inExpr : mixed
Tags
deprecated

This method will be removed in 3.0.

walkInputParameter()

Walks down an InputParameter AST node.

public walkInputParameter(mixed $inputParam) : void
Parameters
$inputParam : mixed
Tags
deprecated

This method will be removed in 3.0.

walkInstanceOfExpression()

Walks down an InstanceOfExpression AST node.

public walkInstanceOfExpression(mixed $instanceOfExpr) : void
Parameters
$instanceOfExpr : mixed
Tags
deprecated

This method will be removed in 3.0.

walkJoin()

Walks down a Join AST node.

public walkJoin(mixed $join) : void
Parameters
$join : mixed
Tags
deprecated

This method will be removed in 3.0.

walkLikeExpression()

Walks down a LikeExpression AST node.

public walkLikeExpression(mixed $likeExpr) : void
Parameters
$likeExpr : mixed
Tags
deprecated

This method will be removed in 3.0.

walkLiteral()

Walks down a literal that represents an AST node.

public walkLiteral(mixed $literal) : void
Parameters
$literal : mixed
Tags
deprecated

This method will be removed in 3.0.

walkNullComparisonExpression()

Walks down a NullComparisonExpression AST node.

public walkNullComparisonExpression(mixed $nullCompExpr) : void
Parameters
$nullCompExpr : mixed
Tags
deprecated

This method will be removed in 3.0.

walkOrderByClause()

Walks down an OrderByClause AST node.

public walkOrderByClause(mixed $orderByClause) : void
Parameters
$orderByClause : mixed
Tags
deprecated

This method will be removed in 3.0.

walkOrderByItem()

Walks down an OrderByItem AST node, thereby generating the appropriate SQL.

public walkOrderByItem(mixed $orderByItem) : void
Parameters
$orderByItem : mixed
Tags
deprecated

This method will be removed in 3.0.

walkPathExpression()

Walks down a PathExpression AST node.

public walkPathExpression(mixed $pathExpr) : void
Parameters
$pathExpr : mixed
Tags
deprecated

This method will be removed in 3.0.

walkQuantifiedExpression()

Walks down a QuantifiedExpression AST node.

public walkQuantifiedExpression(mixed $qExpr) : void
Parameters
$qExpr : mixed
Tags
deprecated

This method will be removed in 3.0.

walkResultVariable()

Walks down a ResultVariable that represents an AST node.

public walkResultVariable(mixed $resultVariable) : void
Parameters
$resultVariable : mixed
Tags
deprecated

This method will be removed in 3.0.

walkSelectClause()

Walks down a SelectClause AST node.

public walkSelectClause(mixed $selectClause) : void
Parameters
$selectClause : mixed
Tags
deprecated

This method will be removed in 3.0.

walkSelectExpression()

Walks down a SelectExpression AST node.

public walkSelectExpression(mixed $selectExpression) : void
Parameters
$selectExpression : mixed
Tags
deprecated

This method will be removed in 3.0.

walkSimpleArithmeticExpression()

Walks down an SimpleArithmeticExpression AST node.

public walkSimpleArithmeticExpression(mixed $simpleArithmeticExpr) : void
Parameters
$simpleArithmeticExpr : mixed
Tags
deprecated

This method will be removed in 3.0.

walkSimpleSelectClause()

Walks down a SimpleSelectClause AST node.

public walkSimpleSelectClause(mixed $simpleSelectClause) : void
Parameters
$simpleSelectClause : mixed
Tags
deprecated

This method will be removed in 3.0.

walkSimpleSelectExpression()

Walks down a SimpleSelectExpression AST node.

public walkSimpleSelectExpression(mixed $simpleSelectExpression) : void
Parameters
$simpleSelectExpression : mixed
Tags
deprecated

This method will be removed in 3.0.

walkStateFieldPathExpression()

Walks down a StateFieldPathExpression AST node.

public walkStateFieldPathExpression(mixed $stateFieldPathExpression) : void
Parameters
$stateFieldPathExpression : mixed
Tags
deprecated

This method will be removed in 3.0.

walkStringPrimary()

Walks down a StringPrimary that represents an AST node.

public walkStringPrimary(mixed $stringPrimary) : void
Parameters
$stringPrimary : mixed
Tags
deprecated

This method will be removed in 3.0.

walkSubselect()

Walks down a Subselect AST node.

public walkSubselect(mixed $subselect) : void
Parameters
$subselect : mixed
Tags
deprecated

This method will be removed in 3.0.

walkSubselectFromClause()

Walks down a SubselectFromClause AST node.

public walkSubselectFromClause(mixed $subselectFromClause) : void
Parameters
$subselectFromClause : mixed
Tags
deprecated

This method will be removed in 3.0.

walkUpdateClause()

Walks down an UpdateClause AST node.

public walkUpdateClause(mixed $updateClause) : void
Parameters
$updateClause : mixed
Tags
deprecated

This method will be removed in 3.0.

walkUpdateItem()

Walks down an UpdateItem AST node.

public walkUpdateItem(mixed $updateItem) : void
Parameters
$updateItem : mixed
Tags
deprecated

This method will be removed in 3.0.

walkWhereClause()

Walks down a WhereClause AST node.

public walkWhereClause(mixed $whereClause) : void
Parameters
$whereClause : mixed
Tags
deprecated

This method will be removed in 3.0.

_getQueryComponents()

Returns internal queryComponents array.

protected _getQueryComponents() : array<string, array<string, mixed>>
Tags
deprecated

Call getQueryComponents() instead.

psalm-return

array<string, QueryComponent>

Return values
array<string, array<string, mixed>>

        
On this page

Search results