ePages 6.10 - DE_EPAGES/Design/API/TLE/NavBarHandler.pm

Package DE_EPAGES::Design::API::TLE::NavBarHandler

Functions

NAVBAR
NavBarElements
VisibleNavElements

NAVBAR

Loops though the elements of a navigation bar of the current shop style.

Syntax
#BLOCK("NAVBAR", #NavBarName, #JoinString) #INCLUDE(#Template) #ENDBLOCK
Example
#BLOCK("NAVBAR", "Top", "|") #INCLUDE(#Template) #ENDBLOCK
Input
#NavBarName (string)
navigation bar alias: "Top", "Left", etc.
#JoinString (string)
separator between navigation bar elements
Return
Content (string)
processed template content

NavBarElements

Returns the elements of a navigation bar of a shop style.

Syntax
#LOOP(#FUNCTION("NavBarElements", #NavBarName, #Style)) template #ENDLOOP
Example
#LOOP(#FUNCTION("NavBarElements", "Top", #Shop.DefaultStyle.Object)) #Alias #ENDLOOP
Input
#Style (object)
Style object
#NavBarName (string)
navigation bar alias: "Top", "Left", etc.
Return
NavBarElements (loop)
list of navigation bar elements

VisibleNavElements

Returns the navigation elements that are visible and adds an flag 'Available'

Syntax
#LOCAL("VisibleNavElements", #VisibleNavElements(#NavElements, #Shop)) #VisibleNavElements #ENDLOCAL
Example
#LOCAL("VisibleNavElements", #VisibleNavElements(#NavElements, #StyleShop.Object))#VisibleNavElements #ENDLOCAL
Input
NavBarElements (ref.array)
list of navigation bar elements
#Shop (object)
Shop object
Return
NavBarElements (array)
list of navigation bar elements