Logical operators for creating and manipulating booleans. More...

Public Member Functions
	chooseTransformation ($operatorName, &$node, $tpl, &$resourceData, $element, $lastElement, $elementList, $elementTree, &$parameters)
	eZTemplateLogicOperator ()
	getValueCount ($val)
	logicalComparisonTransformation ($operatorName, &$node, $tpl, &$resourceData, $element, $lastElement, $elementList, $elementTree, &$parameters)
	modify ($tpl, $operatorName, $operatorParameters, $rootNamespace, $currentNamespace, &$value, $namedParameters, $placement)
	namedParameterList ()
	namedParameterPerOperator ()
	negateTransformation ($operatorName, &$node, $tpl, &$resourceData, $element, $lastElement, $elementList, $elementTree, &$parameters)
	operatorCompiledStaticData ($operatorName)
	operatorList ()
	operatorTemplateHints ()
	trueFalseTransformation ($operatorName, &$node, $tpl, &$resourceData, $element, $lastElement, $elementList, $elementTree, &$parameters)
Public Attributes
	$AndName
	The "and" name.
	$ChooseName
	The "choose" name.
	$EqName
	The "equal" name.
	$FalseName
	The "false" name.
	$GeName
	The "greater than or equal" name.
	$GtName
	The "greater than" name.
	$LeName
	The "less than or equal" name.
	$LtName
	The "less than" name.
	$NeName
	The "not equal" name.
	$NotName
	The "not" name.
	$NullName
	The "null" name.
	$Operators
	The array of operators.
	$OrName
	The "or" name.
	$TrueName
	The "true" name.

Detailed Description

Logical operators for creating and manipulating booleans.

This class adds powerful template handling by enabling logical operators which alter the output of templates from input values.

How counts are interpreted:

If the data is an array the array count is used
If the data is an object the object attribute count is used
If the data is a numeric the value is used
If the data is a boolean false is 0 and true is 1
For all other data 0 is used

Data is considered null (or false) if the data count is 0 (see above) or the data is really null (is_null). Data is considered true if it is not null.

The supported operators are:

lt
Returns true if the input count is less than the parameter data count. See how count is interpreted above.
le
Same as lt but use less than or equal to.
gt
Same as lt but returns true for input greater than data.
ge
Same as gt but use greater than or equal to.
eq
Returns true if all the input parameters match. Matching is casual meaning that an integer of value 0 will match a boolean of type false.
ne
Returns true if one or more of the input parameters does not match. Matching is casual meaning that an integer of value 0 will match a boolean of type false.
null
Returns true if the data is null, false otherwise
not
Returns true if the data is false or false if data is true
true
false
Creates a true/false boolean
or
Evaluates all parameter values until one is found to be true (see above), then returns that value. The remaining parameters are not evaluated at all. If there are no parameter or all elements were false it returns false.
and
Evaluates all parameter values until one is found to be false (see above), then returns that false. The remaining parameters are not evaluated at all. If there are no parameter it returns false, if no elements were false it returns the last parameter value.
choose
Uses the input count to pick one of the parameter elements. The input count equals the parameter index.

Definition at line 87 of file eztemplatelogicoperator.php.

Member Function Documentation

eZTemplateLogicOperator::chooseTransformation	(	$	operatorName,
		&$	node,
		$	tpl,
		&$	resourceData,
		$	element,
		$	lastElement,
		$	elementList,
		$	elementTree,
		&$	parameters
	)

Definition at line 536 of file eztemplatelogicoperator.php.

eZTemplateLogicOperator::eZTemplateLogicOperator ( )

Initializes the operator class with the various operator names.

Definition at line 92 of file eztemplatelogicoperator.php.

eZTemplateLogicOperator::getValueCount ( $ val )

Returns the 'count' value as described in the introduction or 'false' in case of an unsupported type

Definition at line 616 of file eztemplatelogicoperator.php.

Referenced by modify().

eZTemplateLogicOperator::logicalComparisonTransformation	(	$	operatorName,
		&$	node,
		$	tpl,
		&$	resourceData,
		$	element,
		$	lastElement,
		$	elementList,
		$	elementTree,
		&$	parameters
	)

Definition at line 256 of file eztemplatelogicoperator.php.

eZTemplateLogicOperator::modify	(	$	tpl,
		$	operatorName,
		$	operatorParameters,
		$	rootNamespace,
		$	currentNamespace,
		&$	value,
		$	namedParameters,
		$	placement
	)

Examines the input value and outputs a boolean value. See class documentation for more information.

Definition at line 651 of file eztemplatelogicoperator.php.

eZTemplateLogicOperator::namedParameterList ( )

See eZTemplateOperator::namedParameterList

Definition at line 239 of file eztemplatelogicoperator.php.

eZTemplateLogicOperator::namedParameterPerOperator ( )

Returns:: true to tell the template engine that the parameter list exists per operator type.

Definition at line 117 of file eztemplatelogicoperator.php.

eZTemplateLogicOperator::negateTransformation	(	$	operatorName,
		&$	node,
		$	tpl,
		&$	resourceData,
		$	element,
		$	lastElement,
		$	elementList,
		$	elementTree,
		&$	parameters
	)

Definition at line 500 of file eztemplatelogicoperator.php.

eZTemplateLogicOperator::operatorCompiledStaticData ( $ operatorName )

Definition at line 220 of file eztemplatelogicoperator.php.

eZTemplateLogicOperator::operatorList ( )

Returns the operators in this class.

Definition at line 109 of file eztemplatelogicoperator.php.

eZTemplateLogicOperator::operatorTemplateHints ( )

Definition at line 122 of file eztemplatelogicoperator.php.

eZTemplateLogicOperator::trueFalseTransformation	(	$	operatorName,
		&$	node,
		$	tpl,
		&$	resourceData,
		$	element,
		$	lastElement,
		$	elementList,
		$	elementTree,
		&$	parameters
	)