TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison:

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 61 of file Comparison.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison::__construct	(	PropertyValueInterface	$operand1,
			$operator,
			$operand2
	)

Constructs this Comparison instance

Parameters

PropertyValueInterface	$operand1
integer	$operator	one of QueryInterface::OPERATOR_*
mixed	$operand2

Definition at line 90 of file Comparison.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\$operand1, TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\$operand2, and TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\$operator.

Member Function Documentation

collectBoundVariableNames()

TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison::collectBoundVariableNames

(

&

$boundVariables

)

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

Parameters

array

&$boundVariables

Returns

void

Implements TYPO3\CMS\Extbase\Persistence\Generic\Qom\ConstraintInterface.

Definition at line 154 of file Comparison.php.

getOperand1()

TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison::getOperand1

(

)

Gets the first operand.

Returns

PropertyValueInterface the operand; non-null

Implements TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface.

Definition at line 101 of file Comparison.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\$operand1.

getOperand2()

TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison::getOperand2

(

)

Gets the second operand.

Returns

mixed the operand; non-null

Implements TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface.

Definition at line 129 of file Comparison.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\$operand2.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\getOperator().

getOperator()

TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison::getOperator

(

)

Gets the operator.

Returns

string One of QueryInterface::OPERATOR_*

Implements TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface.

Definition at line 110 of file Comparison.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\$operator, TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\getOperand2(), TYPO3\CMS\Extbase\Persistence\QueryInterface\OPERATOR_EQUAL_TO, TYPO3\CMS\Extbase\Persistence\QueryInterface\OPERATOR_EQUAL_TO_NULL, TYPO3\CMS\Extbase\Persistence\QueryInterface\OPERATOR_NOT_EQUAL_TO, and TYPO3\CMS\Extbase\Persistence\QueryInterface\OPERATOR_NOT_EQUAL_TO_NULL.

getParameterIdentifier()

TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison::getParameterIdentifier

(

)

Returns

string

Implements TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface.

Definition at line 144 of file Comparison.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\$parameterIdentifier.

setParameterIdentifier()

TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison::setParameterIdentifier

(

$parameterIdentifier

)

Parameters

string

$parameterIdentifier

Returns

void

Implements TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface.

Definition at line 137 of file Comparison.php.

References TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\$parameterIdentifier.

Member Data Documentation

$operand1

TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison::$operand1

protected

Definition at line 66 of file Comparison.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\__construct(), and TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\getOperand1().

$operand2

TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison::$operand2

protected

Definition at line 76 of file Comparison.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\__construct(), and TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\getOperand2().

$operator

TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison::$operator

protected

Definition at line 71 of file Comparison.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\__construct(), and TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\getOperator().

$parameterIdentifier

TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison::$parameterIdentifier

protected

Definition at line 81 of file Comparison.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\getParameterIdentifier(), and TYPO3\CMS\Extbase\Persistence\Generic\Qom\Comparison\setParameterIdentifier().