NAME

PDF::Template::Container::Conditional

PURPOSE

To conditionally allow children to render

NODE NAME

CONDITIONAL IF (an alias for CONDITIONAL)

INHERITANCE

PDF::Template::Container

ATTRIBUTES

• NAME - Required. This is a parameter name, whose value will determine if the conditional passed or fails. If NAME is not specified, the conditional will consider to always fail.

• OP - defaults to == (numeric equality). If VALUE is specified, this will be how NAME and VALUE are compared. OP can be any of the 6 numeric comparision operators or the 6 string comparision operators.

• VALUE - if this is specified, OP will be checked. This is a standard attribute, so if you want a parameter, prepend it with '$'.

• IS - If there is no VALUE attribute, this will be checked. IS can be either 'FALSE' or 'TRUE'. The boolean of NAME will be compared and the conditional will branch appropriately.

CHILDREN

None

AFFECTS

Nothing

DEPENDENCIES

None

USAGE

<if name="__PAGE__" OP="!=" VALUE="__LAST_PAGE__">
  ... Children execute if the current page is not the last page ...
</if>

<if name="Param1" OP="eq" VALUE="$Param2">
  ... Children execute if Param1 is string-wise equals to Param2 ...
</if>

AUTHOR

Rob Kinyon (rkinyon@columbus.rr.com)

SEE ALSO