ComparisonInterface Interface Reference

Inheritance diagram for ComparisonInterface:

Public Member Functions
	getOperand1 ()
	getOperator ()
	getOperand2 ()
	setParameterIdentifier ($parameterIdentifier)
	getParameterIdentifier ()
Public Member Functions inherited from ConstraintInterface
	collectBoundVariableNames (&$boundVariables)

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 JCR_OPERATOR_EQUAL_TO operator is satisfied only if the value of operand1 equals the value of operand2.

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

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

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

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

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

The JCR_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.

http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later

Definition at line 62 of file ComparisonInterface.php.

Member Function Documentation

getOperand1

(

)

Gets the first operand.

Returns

PropertyValueInterface the operand; non-null

Implemented in Comparison.

getOperand2

(

)

Gets the second operand.

Returns

StaticOperandInterface the operand; non-null

Implemented in Comparison.

getOperator

(

)

Gets the operator.

Returns

string one of ::*

Implemented in Comparison.

getParameterIdentifier

(

)

Returns

string

Implemented in Comparison.

setParameterIdentifier

(

$parameterIdentifier

)

Parameters

string

$parameterIdentifier

Returns

void

Implemented in Comparison.