QueryObjectModelFactory implements SingletonInterface
The Query Object Model Factory
only to be used within Extbase, not part of TYPO3 Core API.
Table of Contents
Interfaces
- SingletonInterface
- "empty" interface for singletons (marker interface pattern)
Methods
- _and() : AndInterface
- Performs a logical conjunction of two other constraints.
- _or() : OrInterface
- Performs a logical disjunction of two other constraints.
- ascending() : OrderingInterface
- Orders by the value of the specified operand, in ascending order.
- bindVariable() : BindVariableValueInterface
- Evaluates to the value of a bind variable.
- comparison() : ComparisonInterface
- Filters node-tuples based on the outcome of a binary operation.
- descending() : OrderingInterface
- Orders by the value of the specified operand, in descending order.
- equiJoinCondition() : EquiJoinConditionInterface
- Tests whether the value of a property in a first selector is equal to the value of a property in a second selector.
- join() : JoinInterface
- Performs a join between two node-tuple sources.
- lowerCase() : LowerCaseInterface
- Evaluates to the lower-case string value (or values, if multi-valued) of an operand.
- not() : NotInterface
- Performs a logical negation of another constraint.
- propertyValue() : PropertyValueInterface
- Evaluates to the value (or values, if multi-valued) of a property in the specified or default selector.
- selector() : SelectorInterface
- Selects a subset of the nodes in the repository based on node type.
- statement() : Statement
- Sets a statement as constraint. This is not part of the JCR 2.0 Specification!
- upperCase() : UpperCaseInterface
- Evaluates to the upper-case string value (or values, if multi-valued) of an operand.
Methods
_and()
Performs a logical conjunction of two other constraints.
public
_and(ConstraintInterface $constraint1, ConstraintInterface $constraint2) : AndInterface
Parameters
- $constraint1 : ConstraintInterface
-
the first constraint; non-null
- $constraint2 : ConstraintInterface
-
the second constraint; non-null
Tags
Return values
AndInterface —the And constraint; non-null
_or()
Performs a logical disjunction of two other constraints.
public
_or(ConstraintInterface $constraint1, ConstraintInterface $constraint2) : OrInterface
Parameters
- $constraint1 : ConstraintInterface
-
the first constraint; non-null
- $constraint2 : ConstraintInterface
-
the second constraint; non-null
Tags
Return values
OrInterface —the Or constraint; non-null
ascending()
Orders by the value of the specified operand, in ascending order.
public
ascending(DynamicOperandInterface $operand) : OrderingInterface
The query is invalid if $operand does not evaluate to a scalar value.
Parameters
- $operand : DynamicOperandInterface
-
the operand by which to order; non-null
Tags
Return values
OrderingInterface —the ordering
bindVariable()
Evaluates to the value of a bind variable.
public
bindVariable(string $bindVariableName) : BindVariableValueInterface
Parameters
- $bindVariableName : string
-
the bind variable name; non-null
Tags
Return values
BindVariableValueInterface —the operand; non-null
comparison()
Filters node-tuples based on the outcome of a binary operation.
public
comparison(PropertyValueInterface $operand1, QueryInterface::OPERATOR_* $operator, StaticOperandInterface $operand2) : ComparisonInterface
Parameters
- $operand1 : PropertyValueInterface
-
the first operand; non-null
- $operator : QueryInterface::OPERATOR_*
-
the operator
- $operand2 : StaticOperandInterface
-
the second operand; non-null
Tags
Return values
ComparisonInterface —the constraint; non-null
descending()
Orders by the value of the specified operand, in descending order.
public
descending(DynamicOperandInterface $operand) : OrderingInterface
The query is invalid if $operand does not evaluate to a scalar value.
Parameters
- $operand : DynamicOperandInterface
-
the operand by which to order; non-null
Tags
Return values
OrderingInterface —the ordering
equiJoinCondition()
Tests whether the value of a property in a first selector is equal to the value of a property in a second selector.
public
equiJoinCondition(string $selector1Name, string $property1Name, string $selector2Name, string $property2Name) : EquiJoinConditionInterface
Parameters
- $selector1Name : string
-
the name of the first selector; non-null
- $property1Name : string
-
the property name in the first selector; non-null
- $selector2Name : string
-
the name of the second selector; non-null
- $property2Name : string
-
the property name in the second selector; non-null
Tags
Return values
EquiJoinConditionInterface —the constraint; non-null
join()
Performs a join between two node-tuple sources.
public
join(SourceInterface $left, SourceInterface $right, string $joinType, JoinConditionInterface $joinCondition) : JoinInterface
Parameters
- $left : SourceInterface
-
the left node-tuple source; non-null
- $right : SourceInterface
-
the right node-tuple source; non-null
- $joinType : string
-
one of QueryObjectModelConstants.JCR_JOIN_TYPE_*
- $joinCondition : JoinConditionInterface
Return values
JoinInterface —the join; non-null
lowerCase()
Evaluates to the lower-case string value (or values, if multi-valued) of an operand.
public
lowerCase(PropertyValueInterface $operand) : LowerCaseInterface
Parameters
- $operand : PropertyValueInterface
-
the operand whose value is converted to a lower-case string; non-null
Tags
Return values
LowerCaseInterface —the operand; non-null
not()
Performs a logical negation of another constraint.
public
not(ConstraintInterface $constraint) : NotInterface
Parameters
- $constraint : ConstraintInterface
-
the constraint to be negated; non-null
Tags
Return values
NotInterface —the Not constraint; non-null
propertyValue()
Evaluates to the value (or values, if multi-valued) of a property in the specified or default selector.
public
propertyValue(string $propertyName[, string $selectorName = '' ]) : PropertyValueInterface
Parameters
- $propertyName : string
-
the property name; non-null
- $selectorName : string = ''
-
the selector name; non-null
Tags
Return values
PropertyValueInterface —the operand; non-null
selector()
Selects a subset of the nodes in the repository based on node type.
public
selector(string $nodeTypeName[, string $selectorName = '' ]) : SelectorInterface
Parameters
- $nodeTypeName : string
-
the name of the required node type; non-null
- $selectorName : string = ''
-
the selector name; optional
Tags
Return values
SelectorInterface —the selector
statement()
Sets a statement as constraint. This is not part of the JCR 2.0 Specification!
public
statement(string $statement[, array<string|int, mixed> $boundVariables = [] ]) : Statement
Parameters
- $statement : string
-
The statement
- $boundVariables : array<string|int, mixed> = []
-
An array of variables to bind to the statement
Return values
StatementupperCase()
Evaluates to the upper-case string value (or values, if multi-valued) of an operand.
public
upperCase(PropertyValueInterface $operand) : UpperCaseInterface
Parameters
- $operand : PropertyValueInterface
-
the operand whose value is converted to an upper-case string; non-null
Tags
Return values
UpperCaseInterface —the operand; non-null