Comparison implements ComparisonInterface

Filters node-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.

Internal

only to be used within Extbase, not part of TYPO3 Core API.

Table of Contents

Interfaces

ComparisonInterface
Filters node-tuples based on the outcome of a binary operation.

Properties

$operand1  : PropertyValueInterface
$operand2  : mixed
The type of the second operand will vary depending on the operator.
$operator  : QueryInterface::OPERATOR_*

Methods

__construct()  : mixed
Constructs this Comparison instance
collectBoundVariableNames()  : array<string|int, mixed>
Fills an array with the names of all bound variables in the constraints
getOperand1()  : PropertyValueInterface
Gets the first operand.
getOperand2()  : mixed
Gets the second operand.
getOperator()  : QueryInterface::OPERATOR_*
Gets the operator.

Properties

$operand2

The type of the second operand will vary depending on the operator.

protected mixed $operand2
Tags
todo

Type this as mixed in v13.

$operator

protected QueryInterface::OPERATOR_* $operator

Methods

__construct()

Constructs this Comparison instance

public __construct(PropertyValueInterface $operand1, QueryInterface::OPERATOR_* $operator, mixed $operand2) : mixed
Parameters
$operand1 : PropertyValueInterface
$operator : QueryInterface::OPERATOR_*
$operand2 : mixed

collectBoundVariableNames()

Fills an array with the names of all bound variables in the constraints

public collectBoundVariableNames(array<string|int, mixed> &$boundVariables) : array<string|int, mixed>
Parameters
$boundVariables : array<string|int, mixed>
Return values
array<string|int, mixed>

getOperand2()

Gets the second operand.

public getOperand2() : mixed

getOperator()

Gets the operator.

public getOperator() : QueryInterface::OPERATOR_*
Return values
QueryInterface::OPERATOR_* 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results