class Comparison extends Constraint (View source)

deprecated since Flow 6.0

Filters tuples based on the outcome of a binary operation.

For any comparison, operand2 always evaluates to a scalar value. In contrast, operand1 may evaluate to an array of values (for example, the value of a multi-valued property), in which case the comparison is separately performed for each element of the array, and the Comparison constraint is satisfied as a whole if the comparison against any element of the array is satisfied.

If operand1 and operand2 evaluate to values of different property types, the value of operand2 is converted to the property type of the value of operand1. If the type conversion fails, the query is invalid.

If operator is not supported for the property type of operand1, the query is invalid.

If operand1 evaluates to null (for example, if the operand evaluates the value of a property which does not exist), the constraint is not satisfied.

The OPERATOR_EQUAL_TO operator is satisfied only if the value of operand1 equals the value of operand2.

The OPERATOR_NOT_EQUAL_TO operator is satisfied unless the value of operand1 equals the value of operand2.

The OPERATOR_LESS_THAN operator is satisfied only if the value of operand1 is ordered before the value of operand2.

The OPERATOR_LESS_THAN_OR_EQUAL_TO operator is satisfied unless the value of operand1 is ordered after the value of operand2.

The OPERATOR_GREATER_THAN operator is satisfied only if the value of operand1 is ordered after the value of operand2.

The OPERATOR_GREATER_THAN_OR_EQUAL_TO operator is satisfied unless the value of operand1 is ordered before the value of operand2.

The OPERATOR_LIKE operator is satisfied only if the value of operand1 matches the pattern specified by the value of operand2, where in the pattern:

  • the character "%" matches zero or more characters, and
  • the character "_" (underscore) matches exactly one character, and
  • the string "\x" matches the character "x", and all other characters match themselves.

Properties

protected DynamicOperand $operand1
protected int $operator
protected mixed $operand2

Methods

__construct(DynamicOperand $operand1, int $operator, mixed $operand2 = null)

Constructs this Comparison instance

getOperand1()

Gets the first operand.

int
getOperator()

Gets the operator.

mixed
getOperand2()

Gets the second operand.

Details

__construct(DynamicOperand $operand1, int $operator, mixed $operand2 = null)

Constructs this Comparison instance

Parameters

DynamicOperand $operand1
int $operator

one of \Neos\Flow\Persistence\QueryInterface.OPERATOR_*

mixed $operand2

DynamicOperand getOperand1()

Gets the first operand.

Return Value

DynamicOperand

the operand; non-null

int getOperator()

Gets the operator.

Return Value

int

one of \Neos\Flow\Persistence\QueryInterface.OPERATOR_*

mixed getOperand2()

Gets the second operand.

Return Value

mixed