• Home
• Doctrine
• ORM
• Query
• Parser

PHP Class Doctrine\ORM\Query\Parser

Parses a DQL query, reports any errors in it, and generates an AST. Datei anzeigen Open project: pmjones/php-framework-benchmarks Class Usage Examples

Public Methods

Method	Description
AbstractSchemaName ( ) : string	AbstractSchemaName ::= identifier
AggregateExpression ( ) : Doctrine\ORM\Query\AST\AggregateExpression	AggregateExpression ::= ("AVG" | "MAX" | "MIN" | "SUM") "(" ["DISTINCT"] StateFieldPathExpression ")" | "COUNT" "(" ["DISTINCT"] (IdentificationVariable | SingleValuedPathExpression) ")"
AliasIdentificationVariable ( ) : string	AliasIdentificationVariable = identifier
AliasResultVariable ( ) : string	AliasResultVariable ::= identifier
ArithmeticExpression ( ) : Doctrine\ORM\Query\AST\ArithmeticExpression	ArithmeticExpression ::= SimpleArithmeticExpression | "(" Subselect ")"
ArithmeticFactor ( ) : Doctrine\ORM\Query\AST\ArithmeticFactor	ArithmeticFactor ::= [("+" | "-")] ArithmeticPrimary
ArithmeticPrimary ( )	ArithmeticPrimary ::= SingleValuedPathExpression | Literal | "(" SimpleArithmeticExpression ")" | FunctionsReturningNumerics | AggregateExpression | FunctionsReturningStrings | FunctionsReturningDatetime | IdentificationVariable
ArithmeticTerm ( ) : Doctrine\ORM\Query\AST\ArithmeticTerm	ArithmeticTerm ::= ArithmeticFactor {("*" | "/") ArithmeticFactor}*
AssociationPathExpression ( ) : Doctrine\ORM\Query\AST\PathExpression	AssociationPathExpression ::= CollectionValuedPathExpression | SingleValuedAssociationPathExpression
BetweenExpression ( ) : Doctrine\ORM\Query\AST\BetweenExpression	BetweenExpression ::= ArithmeticExpression ["NOT"] "BETWEEN" ArithmeticExpression "AND" ArithmeticExpression
CaseExpression ( )
CollectionMemberExpression ( ) : Doctrine\ORM\Query\AST\CollectionMemberExpression	CollectionMemberExpression ::= EntityExpression ["NOT"] "MEMBER" ["OF"] CollectionValuedPathExpression
CollectionValuedPathExpression ( ) : Doctrine\ORM\Query\AST\PathExpression	CollectionValuedPathExpression ::= IdentificationVariable "." CollectionValuedAssociationField
ComparisonExpression ( ) : Doctrine\ORM\Query\AST\ComparisonExpression	ComparisonExpression ::= ArithmeticExpression ComparisonOperator ( QuantifiedExpression | ArithmeticExpression )
ComparisonOperator ( ) : string	ComparisonOperator ::= "=" | "<" | "<=" | "<>" | ">" | ">=" | "!="
ConditionalExpression ( ) : Doctrine\ORM\Query\AST\ConditionalExpression	ConditionalExpression ::= ConditionalTerm {"OR" ConditionalTerm}*
ConditionalFactor ( ) : Doctrine\ORM\Query\AST\ConditionalFactor	ConditionalFactor ::= ["NOT"] ConditionalPrimary
ConditionalPrimary ( ) : Doctrine\ORM\Query\AST\ConditionalPrimary	ConditionalPrimary ::= SimpleConditionalExpression | "(" ConditionalExpression ")"
ConditionalTerm ( ) : Doctrine\ORM\Query\AST\ConditionalTerm	ConditionalTerm ::= ConditionalFactor {"AND" ConditionalFactor}*
CustomFunctionsReturningDatetime ( )
CustomFunctionsReturningNumerics ( )
CustomFunctionsReturningStrings ( )
DeleteClause ( ) : Doctrine\ORM\Query\AST\DeleteClause	DeleteClause ::= "DELETE" ["FROM"] AbstractSchemaName ["AS"] AliasIdentificationVariable
DeleteStatement ( ) : Doctrine\ORM\Query\AST\DeleteStatement	DeleteStatement ::= DeleteClause [WhereClause]
EmptyCollectionComparisonExpression ( ) : Doctrine\ORM\Query\AST\EmptyCollectionComparisonExpression	EmptyCollectionComparisonExpression ::= CollectionValuedPathExpression "IS" ["NOT"] "EMPTY"
EntityExpression ( ) : Doctrine\ORM\Query\AST\SingleValuedAssociationPathExpression	EntityExpression ::= SingleValuedAssociationPathExpression | SimpleEntityExpression
ExistsExpression ( ) : Doctrine\ORM\Query\AST\ExistsExpression	ExistsExpression ::= ["NOT"] "EXISTS" "(" Subselect ")"
FromClause ( ) : Doctrine\ORM\Query\AST\FromClause	FromClause ::= "FROM" IdentificationVariableDeclaration {"," IdentificationVariableDeclaration}*
FunctionDeclaration ( )	FunctionDeclaration ::= FunctionsReturningStrings | FunctionsReturningNumerics | FunctionsReturningDatetime
FunctionsReturningDatetime ( )	FunctionsReturningDateTime ::= "CURRENT_DATE" | "CURRENT_TIME" | "CURRENT_TIMESTAMP"
FunctionsReturningNumerics ( )	FunctionsReturningNumerics ::= "LENGTH" "(" StringPrimary ")" | "LOCATE" "(" StringPrimary "," StringPrimary ["," SimpleArithmeticExpression]")" | "ABS" "(" SimpleArithmeticExpression ")" | "SQRT" "(" SimpleArithmeticExpression ")" | "MOD" "(" SimpleArithmeticExpression "," SimpleArithmeticExpression ")" | "SIZE" "(" CollectionValuedPathExpression ")"
FunctionsReturningStrings ( )	FunctionsReturningStrings ::= "CONCAT" "(" StringPrimary "," StringPrimary ")" | "SUBSTRING" "(" StringPrimary "," SimpleArithmeticExpression "," SimpleArithmeticExpression ")" | "TRIM" "(" [["LEADING" | "TRAILING" | "BOTH"] [char] "FROM"] StringPrimary ")" | "LOWER" "(" StringPrimary ")" | "UPPER" "(" StringPrimary ")"
GroupByClause ( ) : Doctrine\ORM\Query\AST\GroupByClause	GroupByClause ::= "GROUP" "BY" GroupByItem {"," GroupByItem}*
GroupByItem ( ) : string	GroupByItem ::= IdentificationVariable | SingleValuedPathExpression
HavingClause ( ) : Doctrine\ORM\Query\AST\HavingClause	HavingClause ::= "HAVING" ConditionalExpression
IdentificationVariable ( ) : string	IdentificationVariable ::= identifier
IdentificationVariableDeclaration ( ) : Doctrine\ORM\Query\AST\IdentificationVariableDeclaration	IdentificationVariableDeclaration ::= RangeVariableDeclaration [IndexBy] {JoinVariableDeclaration}*
InExpression ( ) : Doctrine\ORM\Query\AST\InExpression	InExpression ::= SingleValuedPathExpression ["NOT"] "IN" "(" (InParameter {"," InParameter}* | Subselect) ")"
InParameter ( ) : string	InParameter ::= Literal | InputParameter
IndexBy ( ) : Doctrine\ORM\Query\AST\IndexBy	IndexBy ::= "INDEX" "BY" StateFieldPathExpression
InputParameter ( ) : Doctrine\ORM\Query\AST\InputParameter	InputParameter ::= PositionalParameter | NamedParameter
InstanceOfExpression ( ) : Doctrine\ORM\Query\AST\InstanceOfExpression	InstanceOfExpression ::= IdentificationVariable ["NOT"] "INSTANCE" ["OF"] (AbstractSchemaName | InputParameter)
Join ( ) : Doctrine\ORM\Query\AST\Join	Join ::= ["LEFT" ["OUTER"] | "INNER"] "JOIN" JoinAssociationPathExpression ["AS"] AliasIdentificationVariable ["WITH" ConditionalExpression]
JoinAssociationPathExpression ( ) : Doctrine\ORM\Query\AST\JoinAssociationPathExpression	JoinAssociationPathExpression ::= IdentificationVariable "." (CollectionValuedAssociationField | SingleValuedAssociationField)
JoinVariableDeclaration ( ) : Doctrine\ORM\Query\AST\JoinVariableDeclaration	JoinVariableDeclaration ::= Join [IndexBy]
LikeExpression ( ) : Doctrine\ORM\Query\AST\LikeExpression	LikeExpression ::= StringExpression ["NOT"] "LIKE" (string | input_parameter) ["ESCAPE" char]
Literal ( ) : string	Literal ::= string | char | integer | float | boolean
NewValue ( )	NewValue ::= SimpleArithmeticExpression | StringPrimary | DatetimePrimary | BooleanPrimary | EnumPrimary | SimpleEntityExpression | "NULL"
NullComparisonExpression ( ) : Doctrine\ORM\Query\AST\NullComparisonExpression	NullComparisonExpression ::= (SingleValuedPathExpression | InputParameter) "IS" ["NOT"] "NULL"
OrderByClause ( ) : Doctrine\ORM\Query\AST\OrderByClause	OrderByClause ::= "ORDER" "BY" OrderByItem {"," OrderByItem}*
OrderByItem ( ) : Doctrine\ORM\Query\AST\OrderByItem	OrderByItem ::= (ResultVariable | StateFieldPathExpression) ["ASC" | "DESC"]
PartialObjectExpression ( ) : array	PartialObjectExpression ::= "PARTIAL" IdentificationVariable "." PartialFieldSet PartialFieldSet ::= "{" SimpleStateField {"," SimpleStateField}* "}"
PathExpression ( integer $expectedTypes ) : Doctrine\ORM\Query\AST\PathExpression	Parses an arbitrary path expression and defers semantical validation based on expected types.
QuantifiedExpression ( ) : Doctrine\ORM\Query\AST\QuantifiedExpression	QuantifiedExpression ::= ("ALL" | "ANY" | "SOME") "(" Subselect ")"
QueryLanguage ( ) : Doctrine\ORM\Query\AST\SelectStatement	QueryLanguage ::= SelectStatement | UpdateStatement | DeleteStatement
RangeVariableDeclaration ( ) : Doctrine\ORM\Query\AST\RangeVariableDeclaration	RangeVariableDeclaration ::= AbstractSchemaName ["AS"] AliasIdentificationVariable
ResultVariable ( ) : string	ResultVariable ::= identifier
ScalarExpression ( ) : mixed	ScalarExpression ::= SimpleArithmeticExpression | StringPrimary | DateTimePrimary | StateFieldPathExpression | BooleanPrimary | CaseExpression | EntityTypeExpression
SelectClause ( ) : Doctrine\ORM\Query\AST\SelectClause	SelectClause ::= "SELECT" ["DISTINCT"] SelectExpression {"," SelectExpression}
SelectExpression ( ) : Doctrine\ORM\Query\AST\SelectExpression	SelectExpression ::= IdentificationVariable | StateFieldPathExpression | (AggregateExpression | "(" Subselect ")" | ScalarExpression) [["AS"] AliasResultVariable]
SelectStatement ( ) : Doctrine\ORM\Query\AST\SelectStatement	SelectStatement ::= SelectClause FromClause [WhereClause] [GroupByClause] [HavingClause] [OrderByClause]
SimpleArithmeticExpression ( ) : Doctrine\ORM\Query\AST\SimpleArithmeticExpression	SimpleArithmeticExpression ::= ArithmeticTerm {("+" | "-") ArithmeticTerm}*
SimpleConditionalExpression ( )	SimpleConditionalExpression ::= ComparisonExpression | BetweenExpression | LikeExpression | InExpression | NullComparisonExpression | ExistsExpression | EmptyCollectionComparisonExpression | CollectionMemberExpression | InstanceOfExpression
SimpleEntityExpression ( ) : string	SimpleEntityExpression ::= IdentificationVariable | InputParameter
SimpleSelectClause ( ) : Doctrine\ORM\Query\AST\SimpleSelectClause	SimpleSelectClause ::= "SELECT" ["DISTINCT"] SimpleSelectExpression
SimpleSelectExpression ( ) : Doctrine\ORM\Query\AST\SimpleSelectExpression	SimpleSelectExpression ::= StateFieldPathExpression | IdentificationVariable | ((AggregateExpression | "(" Subselect ")" | ScalarExpression) [["AS"] AliasResultVariable])
SingleValuedAssociationPathExpression ( ) : Doctrine\ORM\Query\AST\PathExpression	SingleValuedAssociationPathExpression ::= IdentificationVariable "." SingleValuedAssociationField
SingleValuedPathExpression ( ) : Doctrine\ORM\Query\AST\PathExpression	SingleValuedPathExpression ::= StateFieldPathExpression | SingleValuedAssociationPathExpression
StateFieldPathExpression ( ) : Doctrine\ORM\Query\AST\PathExpression	StateFieldPathExpression ::= IdentificationVariable "." StateField
StringExpression ( ) : Doctrine\ORM\Query\AST\StringPrimary	StringExpression ::= StringPrimary | "(" Subselect ")"
StringPrimary ( )	StringPrimary ::= StateFieldPathExpression | string | InputParameter | FunctionsReturningStrings | AggregateExpression
Subselect ( ) : Doctrine\ORM\Query\AST\Subselect	Subselect ::= SimpleSelectClause SubselectFromClause [WhereClause] [GroupByClause] [HavingClause] [OrderByClause]
SubselectFromClause ( ) : Doctrine\ORM\Query\AST\SubselectFromClause	SubselectFromClause ::= "FROM" SubselectIdentificationVariableDeclaration {"," SubselectIdentificationVariableDeclaration}*
SubselectIdentificationVariableDeclaration ( ) : Doctrine\ORM\Query\AST\SubselectIdentificationVariableDeclaration	SubselectIdentificationVariableDeclaration ::= IdentificationVariableDeclaration | (AssociationPathExpression ["AS"] AliasIdentificationVariable)
UpdateClause ( ) : Doctrine\ORM\Query\AST\UpdateClause	UpdateClause ::= "UPDATE" AbstractSchemaName ["AS"] AliasIdentificationVariable "SET" UpdateItem {"," UpdateItem}*
UpdateItem ( ) : Doctrine\ORM\Query\AST\UpdateItem	UpdateItem ::= SingleValuedPathExpression "=" NewValue
UpdateStatement ( ) : Doctrine\ORM\Query\AST\UpdateStatement	UpdateStatement ::= UpdateClause [WhereClause]
WhereClause ( ) : Doctrine\ORM\Query\AST\WhereClause	WhereClause ::= "WHERE" ConditionalExpression
__construct ( Doctrine\ORM\Query $query )	Creates a new query parser object.
addCustomTreeWalker ( string $className )	Adds a custom tree walker for modifying the AST.
free ( boolean $deep = false, integer $position )	Free this parser enabling it to be reused
getAST ( ) : Doctrine\ORM\Query\AST\SelectStatement	Parse and build AST for the given Query.
getEntityManager ( ) : EntityManager	Gets the EntityManager used by the parser.
getLexer ( ) : Doctrine\ORM\Query\Lexer	Gets the lexer used by the parser.
getParserResult ( ) : Doctrine\ORM\Query\ParserResult	Gets the ParserResult that is being filled with information during parsing.
match ( $token ) : void	Attempts to match the given token with the current lookahead token.
parse ( ) : Doctrine\ORM\Query\ParserResult	Parses a query string.
semanticalError ( string $message = '', array $token = null )	Generates a new semantical error.
setCustomOutputTreeWalker ( string $className )	Sets a custom tree walker that produces output.
syntaxError ( string $expected = '', array $token = null )	Generates a new syntax error.

Private Methods

Method	Description
_isAggregateFunction ( $tokenType ) : boolean	Checks whether the given token type indicates an aggregate function.
_isFunction ( ) : boolean	Checks if the next-next (after lookahead) token starts a function.
_isMathOperator ( $token ) : boolean	Checks if the given token indicates a mathematical operator.
_isNextAllAnySome ( ) : boolean	Checks whether the current lookahead token of the lexer has the type T_ALL, T_ANY or T_SOME.
_isSubselect ( ) : boolean	Checks whether the next 2 tokens start a subselect.
_peekBeyond ( array $token ) : array	Peeks beyond the specified token and returns the first token after that one.
_peekBeyondClosingParenthesis ( ) : array	Peek beyond the matched closing parenthesis and return the first token after that one.
_processDeferredIdentificationVariables ( ) : void	Validates that the given IdentificationVariable is semantically correct.
_processDeferredPartialObjectExpressions ( ) : void	Validates that the given PartialObjectExpression is semantically correct.
_processDeferredPathExpressions ( mixed $AST )	Validates that the given PathExpression is semantically correct for grammar rules:
_processDeferredResultVariables ( ) : void	Validates that the given ResultVariable is semantically correct.

Method Details