ePages 6.11.0 - DE_EPAGES/Content/API/TLE/TagHandler.pm

Package DE_EPAGES::Content::API::TLE::TagHandler

Functions

CHILD_CLASSES_ALLOWED
CONTENT_CHILD_CLASSES
OBSCUREEMAILADDRESSLINK
OBSCUREEMAILADDRESSTEXT
RELATEDTAGS
register

CHILD_CLASSES_ALLOWED

Checks whether the required class of the object allows the created subcategories.

Syntax
#CHILD_CLASSES_ALLOWED(#Object);
#IF(#CHILD_CLASSES_ALLOWED(#Object))
  #Alias
#ENDIF
Input
#Object (object)
content object
Return
#Allowed (boolean)
true if child objects allowed

CONTENT_CHILD_CLASSES

Returns a list of possible classes of child objects.

Syntax
#CONTENT_CHILD_CLASSES(#Shop.Object, #Class.Object);
#LOOP(#CONTENT_CHILD_CLASSES(#Shop.Object, #Class.Object, #Object))
  #Alias
#ENDLOOP
Input
#Shop.Object (object)
shop
#Class.Object (object)
class
#Object (object)
parent object (optional)
Return
Classes (ref.array.object)
allowed child object classes

OBSCUREEMAILADDRESSLINK

Returns an obscured mailto link of the given e-mail address. Uses simple base64 encoding. The decoding is done via JavaScript later.

Syntax
#OBSCUREEMAILADDRESSLINK(#EMail)
Example
<a href="javascript:obscureEMailLink(#OBSCUREEMAILADDRESSLINK(#Email))">
Input
#EMailAddress (string)
valid e-mail address
Return
ObscuredEMailAddress (ref.string)
obscured mailto link of the e-mail address

OBSCUREEMAILADDRESSTEXT

Returns an obscured string of the given e-mail address. This simply hacks the address into pieces and inserts html tags between the parts.

Syntax
#OBSCUREEMAILADDRESSTEXT(#EMail)
Example
<a href="...">#OBSCUREEMAILADDRESSTEXT(#Email)</a>
Input
#EMailAddress (string)
valid e-mail address
Return
ObscuredEMailAddress (ref.string)
obscured string of the e-mail address

RELATEDTAGS

Returns a loop of all tags from objects in the shop having the specified class.

Syntax
#RELATEDTAGS(#Shop.Object, #ClassAlias)
Example
#LOOP(#RELATEDTAGS(#Shop.Object, "ImageGallery"))
  #Element
#ENDLOOP
Input
#Shop.Object (object)
shop object
#ClassAlias (string)
class alias
Return
Tags (ref.array.hash)
loop of tags, the loop has only one valiable: #Element

register

Registers this handle on the processor

Syntax
$Handler->register( $Processor );
Input
$Processor (object)
tle processor