Global Template Variables
This article describes what data is available to all Front-end Templates in Aurora.
This does not include templates loaded via AJAX interfaces in order to achieve optimal performance.
| Variable Name | Type | Description |
|---|---|---|
| $aurora_site_name | String | The domain name currently configured in the Aurora Database for the site being viewed, e.g. "www.aurorademo.co.uk". |
| $path | Array [ String ] | Contains a list of the folder paths from the URL. Learn more here. |
| $pageType | String | Contains a string to represent the main area of the site a user might be on. Learn more here. |
| $basketItems | Integer | This is a count of the number of items in the visitors current basket. |
| $currency_options | Array [ $currency ] | An array of all available currencies and their data. |
| $currency | Container | A Container holding all of a currency's details. |
| $currency.id | Integer | The Internal ID Aurora uses to identify a currency. |
| $currency.currency_name | String | The name of the currency. |
| $currency.iso_code | String | The ISO3 Code configured for the currency in the Aurora Back-end. |
| $currency.default_currency | Boolean | Whether or not this currency is configured as the default currency or not. This is TRUE if the currency is in fact the default and FALSE otherwise. |
| $currency_iso | String | The currently selected currency ISO3 code. |
| $smarty.cookie.ab | Integer | The A/B Testing value assigned to the visitor for the duration of their current session. This is used to allocate the visitor to A/B Testing Action Groups. |
| $aurora_user | Container | A Container holding all of a User's details for the currently logged-in user. |
| $aurora_user.id | Integer | The Internal ID Aurora used to identify a User. |
| $aurora_user.email_address | String | The Email Address of the User currently logged into the site. |
| $aurora_user.user_type | [ 0, 1, 2 ] | The integer 'type' value for the User currently logged into the site. 0 = Normal Customer 1 or 2 = Admin User |
| $aurora_user.firstname | String | The First Name of the User currently logged into the site. |
| $aurora_user.lastname | String | The Last Name of the User currently logged into the site. |
| $aurora_user.loyalty_points | Integer | The number of Loyalty Points the User currently logged into the site has. |
| $aurora_user.used_loyalty_points | Integer | The number of Loyalty Points the User currently logged into the site has used to date. |
| $aurora_user.group_ids | Array( Integer ) | An indexed array of User Group IDs the User currently logged into the site belongs to. |
| $aurora_user.group_names | Array( String ) | An indexed array of User Group Names the User currently logged into the site belongs to. |
| $groups | Array [ Integer ] | A Pair/Value array of User Groups for the currently logged-in User, where the Key is the Group Name and the Value is its Internal Aurora ID. |
| $snippets | Array [ String ] | A Pair/Value array of Content Snippets, where the Key is the sanitised Snippet Name and the Value is its Content. |
| $locales | Array [ $locale ] | An array of all locale and their data. |
| $locale | Container | A Container holding all of a Locale's details. |
| $locales_active | Boolean | Denotes whether the locales are active or not (i.e. whether there are any configured in the Aurora Back-end). |
| $locale_code | String | The currently selected Locale code (as configured in the Aurora Back-end). |
| $languages | Array [ $language ] | An array of all active languages and their data. |
| $language | Container | A Container holding all of a Language's details. |
| $language.id | Integer | The Internal ID Aurora uses to identify a Language. |
| $language.language_name | String | The name of the language. |
| $language.iso | String | The ISO Code configured for the language in the Aurora Back-end. |
| $language.is_default | Boolean | Whether or not this language is configured as the default language or not. This is TRUE if the language is in fact the default and FALSE otherwise. |
| $language_id | Integer | The currently selected Internal ID Aurora used to identify a Language. |
| $language_iso | String | The currently selected Language ISO code (as configured in the Aurora Back-end). |
| $language_css_dir | String | The currently selected Languages CSS directory. Please also see: getFilePath |
| $language_image_dir | String | The currently selected Languages Image directory. Please also see: getFilePath |
Updated over 2 years ago