Templating:Variables

Variables

Templates get variables containing all necessary data passed from the back end. This is a complete reference of all available variables.

Globals

Globals are accessible anywhere in the templates, including macros.

Variable name	Type	Description	Format
current_page	string	Contains URL after domain name and before ?, for example storedomain.com/p/digital-fotoram/nextbase-photomil-8wi-fi-fotoram.html?vat_disp=0 returns /p/digital-fotoram/nextbase-photomil-8wi-fi-fotoram.html	N/A
current_script	string	Contains filename of current page	index.php
request	dictionary	A dictionary of recieved GET and POST data	Key Type Description get dictionary Data received from the GET query string post dictionary Received POST data
current_customer_id	integer	Returns customer ID if customer is logged in, else None	N/A
settings	dictionary	Contains some of the settings defined in the administration	Key Type Description SMALL_IMAGE_WIDTH integer Width of small thumbnails in pixels SMALL_IMAGE_HEIGHT integer Height of small thumbnails in pixels STATISTICS_GOOGLE_ANALYTICS string Google analytics tracking code, if specified PRODUCT_PAGE_DESIGN integer Internal

Boxes

Boxes are variables used for the side boxes. They are all prefixed with boxes.

Category menu

Variable name	Type	Description	Format
boxes.categories.tree	list of dictionaries	Contains a tree of displayed categories in menu	Key Type Description name string Name of category in current language href string Link to category's product listing page child_count integer Number of open child categories children list of dictionaries List of visible child categories. See boxes.categories.tree for format selected boolean Returns true if the category is the currently selected one

Manufacturer select

Variable name	Type	Description	Format
boxes.manufacturers.list	list of dictionaries	Lists all available manufacturers	Key Type Description name string Name of manufacturer href string Link to manufacturer page

Search box

Variable name	Type	Description	Format
boxes.search.advanced_href	string	URL to advanced search page	N/A
boxes.search.advanced_result_href	string	Action URL for search form	N/A

Information page list

Variable name	Type	Description	Format
boxes.information_pages.list	list of dictionaries	Lists all active information pages	Key Type Description name string Name of information page href string Link to information page active boolean Is user currently on this page? target boolean True if information page expects the attribute target="_blank"

VAT select box

Variable name	Type	Description	Format
boxes.vat_select.display_with_vat	boolean	True if prices are displayed including VAT, else false.	N/A
boxes.vat_select.with_href	string	URL to page where VAT display is set to true.	N/A
boxes.vat_select.without_href	string	URL to page where VAT display is set to false.	N/A

Page specific

Most variables are not available on a global scale. They are page specific variables. They are always prefixed with the same name as the included template. So contact.html variables are prefixed with contact.

Contact us page (contact.html)

Variable name	Type	Description	Format
contact.form_href	string	URL with target of form for handling user input data	N/A
contact.captcha	boolean	Determines whether Captcha should be used or not	N/A
contact.name	String	Contains customer name if customer is logged in or validation if validation of a field failed	N/A
contact.email	string	Contains customer e-mail if customer is logged in or validation if validation of a field failed	N/A
contact.heading	string	Contains heading text	N/A
contact.text	string	Contains a descriptive text of what the contact us page is. It most certainly contains HTML so the raw filter may be appropriate to use	N/A