Top Level Template Variables

Work in Progress.


Top level variables are objects inserted into the Velocity Context so you may access the directly without having to go through another variable or creating them with a #set command.

These variables should be available to all storefront templates

Variable NameObject TypeComments

$advancedItemSearchManager

AdvancedItemSearchManager

 

$amazonS3

AmazonS3

 

$baseThumbnailUrl

string

"https://secure.ultracart.com/thumbs/" or "http://secure.ultracart.com/thumbs/"

$baseUrl

string

https://yoursite.com

$baseUrlHttp

string

http://yoursite.com (non-SSL)

$breadcrumbHelper

BreadcrumbHelper

 

$cart

Cart

$cart.getCartId() to retrieve the shopping cart id

$checkoutHostName

string

 

$checkoutUrl

string

 

$checkoutUrlHttps

string

 

$containerManager

ContainerManager

 

$cssManager

CssManager

 

$ctx

Context

 

$dateManager

DateManager

 

$escape

EscapeTool

 

$fontManager

FontManager

 

$formatHelper

FormatHelper

 

$geolocationManager

GeolocationManager

 

$JSONManager

JSONManager

 

$languageIsoCode

string

"ENG"

$menuManager

menuManager

 

$merchantID

string

 

$merchantId

string

 

$merchantLoggedIn

boolean

true if merchant is logged in and viewing the page

$myAccountUrl

string

 

$myAccountUrlHttps

string

 

$number

NumberTool

 

$paymentMethodManager

PaymentMethodManager

 

$queryString

string

 

$referrer

string

this is theHeader("Referer")

$remoteIPAddress

string

 

$render

RenderTool

 

$requestURI

string

 

$scriptManager

ScriptManager

 

$searchEngine

boolean

true if this page is a search page

$searchTerm

string

the search terms found in the query string

$site

Site

 

$socialNetworkHelper

SocialNetworkHelper

 

$sorter

SortTool

 

$theme

Theme

 

$twitterManager

TwitterManager