eZPublish  3.8
eZTemplateLogicOperator Class Reference

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)
 

Private Attributes

 $AndName
 The "and" name. More...
 
 $ChooseName
 The "choose" name. More...
 
 $EqName
 The "equal" name. More...
 
 $FalseName
 The "false" name. More...
 
 $GeName
 The "greater than or equal" name. More...
 
 $GtName
 The "greater than" name. More...
 
 $LeName
 The "less than or equal" name. More...
 
 $LtName
 The "less than" name. More...
 
 $NeName
 The "not equal" name. More...
 
 $NotName
 The "not" name. More...
 
 $NullName
 The "null" name. More...
 
 $Operators
 The array of operators. More...
 
 $OrName
 The "or" name. More...
 
 $TrueName
 The "true" name. More...
 

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:

  1. If the data is an array the array count is used
  2. If the data is an object the object attribute count is used
  3. If the data is a numeric the value is used
  4. If the data is a boolean false is 0 and true is 1
  5. 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.

Member Function Documentation

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

Initializes the operator class with the various operator names.

eZTemplateLogicOperator::getValueCount (   $val)

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

Referenced by modify().

eZTemplateLogicOperator::logicalComparisonTransformation (   $operatorName,
$node,
$tpl,
$resourceData,
$element,
$lastElement,
$elementList,
$elementTree,
$parameters 
)
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.

eZTemplateLogicOperator::namedParameterList ( )
eZTemplateLogicOperator::namedParameterPerOperator ( )
Returns
true to tell the template engine that the parameter list exists per operator type.
eZTemplateLogicOperator::negateTransformation (   $operatorName,
$node,
$tpl,
$resourceData,
$element,
$lastElement,
$elementList,
$elementTree,
$parameters 
)
eZTemplateLogicOperator::operatorCompiledStaticData (   $operatorName)
& eZTemplateLogicOperator::operatorList ( )

Returns the operators in this class.

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

Member Data Documentation

eZTemplateLogicOperator::$AndName
private

The "and" name.

eZTemplateLogicOperator::$ChooseName
private

The "choose" name.

eZTemplateLogicOperator::$EqName
private

The "equal" name.

eZTemplateLogicOperator::$FalseName
private

The "false" name.

eZTemplateLogicOperator::$GeName
private

The "greater than or equal" name.

eZTemplateLogicOperator::$GtName
private

The "greater than" name.

eZTemplateLogicOperator::$LeName
private

The "less than or equal" name.

eZTemplateLogicOperator::$LtName
private

The "less than" name.

eZTemplateLogicOperator::$NeName
private

The "not equal" name.

eZTemplateLogicOperator::$NotName
private

The "not" name.

eZTemplateLogicOperator::$NullName
private

The "null" name.

eZTemplateLogicOperator::$Operators
private

The array of operators.

Referenced by operatorList().

eZTemplateLogicOperator::$OrName
private

The "or" name.

eZTemplateLogicOperator::$TrueName
private

The "true" name.

Referenced by modify().


The documentation for this class was generated from the following file: