TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
Comparison Class Reference
Inheritance diagram for Comparison:
ComparisonInterface ConstraintInterface

Public Member Functions

 __construct (PropertyValueInterface $operand1, $operator, $operand2)
 
 getOperand1 ()
 
 getOperator ()
 
 getOperand2 ()
 
 setParameterIdentifier ($parameterIdentifier)
 
 getParameterIdentifier ()
 
 collectBoundVariableNames (&$boundVariables)
 

Protected Attributes

 $operand1
 
 $operator
 
 $operand2
 
 $parameterIdentifier
 

Detailed Description

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_LESSS_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.

Definition at line 63 of file Comparison.php.

Constructor & Destructor Documentation

__construct ( PropertyValueInterface  $operand1,
  $operator,
  $operand2 
)

Constructs this Comparison instance

Parameters
PropertyValueInterface$operand1
int$operatorone of QueryInterface::OPERATOR_*
mixed$operand2

Definition at line 93 of file Comparison.php.

References Comparison\$operand1, Comparison\$operand2, and Comparison\$operator.

Member Function Documentation

collectBoundVariableNames ( $boundVariables)

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

Parameters
array&$boundVariables
Returns
void

Implements ConstraintInterface.

Definition at line 167 of file Comparison.php.

getOperand1 ( )

Gets the first operand.

Returns
PropertyValueInterface the operand; non-null

Implements ComparisonInterface.

Definition at line 105 of file Comparison.php.

References Comparison\$operand1.

getOperand2 ( )

Gets the second operand.

Returns
mixed the operand; non-null

Implements ComparisonInterface.

Definition at line 135 of file Comparison.php.

References Comparison\$operand2.

Referenced by Comparison\getOperator().

getOperator ( )
getParameterIdentifier ( )
Returns
string
Deprecated:
since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 155 of file Comparison.php.

References Comparison\$parameterIdentifier, and GeneralUtility\logDeprecatedFunction().

setParameterIdentifier (   $parameterIdentifier)
Parameters
string$parameterIdentifier
Returns
void
Deprecated:
since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 145 of file Comparison.php.

References Comparison\$parameterIdentifier, and GeneralUtility\logDeprecatedFunction().

Member Data Documentation

$operand1
protected

Definition at line 68 of file Comparison.php.

Referenced by Comparison\__construct(), and Comparison\getOperand1().

$operand2
protected

Definition at line 78 of file Comparison.php.

Referenced by Comparison\__construct(), and Comparison\getOperand2().

$operator
protected

Definition at line 73 of file Comparison.php.

Referenced by Comparison\__construct(), and Comparison\getOperator().

$parameterIdentifier
protected