Templating:Variables

2012-12-13T23:48:29Z

195.62.25.214: http://scoutsharmherbal.com/products/men_s_health/viagrasuperactive/order/ Viagra Super Active

See also [[Templating:Emails]].
=Variables=
Templates get variables containing all necessary data passed from the back end. This is a complete reference of all available variables.
==Types==
===string===
====URL====
====HTML====
The [http://www.twig-project.org/doc/templates.html#raw raw] filter should be applied when displaying these variables.
===integer===
===decimal===
===boolean===
===list===
===dictionary===
====pagination====
{| class="wikitable"
!Key
!Type
!Description
|-
|page
|[[#integer|integer]]
|The current page.
|-
|prev
|[[#integer|integer]]
|The previous page.
|-
|next
|[[#integer|integer]]
|The next page.
|-
|pages
|[[#list|list]] of [[#integers|integer]]s
|The pages in the current set.
|-
|set_prev
|[[#integer|integer]]
|The last page in the previous set of pages.
|-
|set_next
|[[#integer|integer]]
|The first page in the next set of pages.
|-
|from_row
|[[#integer|integer]]
|The first row displayed.
|-
|to_row
|[[#integer|integer]]
|The last row displayed.
|-
|row_count
|[[#integer|integer]]
|The number of rows paginated.
|}

====product====
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|[[#string|string]]
|Products internal ID
|-
|delivery_time
|[[#string|string]]
|
|-
|description
|[[#HTML|HTML]]
|
|-
|description_short
|[[#HTML|HTML]]
|
|-
|href_buy
|[[#URL|URL]]
|
|-
|href
|[[#URL|URL]]
|
|-
|image
|[[#URL|URL]]
|
|-
|manufacturer_image
|[[#URL|URL]]
|
|-
|manufacturer_name
|[[#string|string]]
|
|-
|model
|[[#string|string]]
|
|-
|name
|[[#string|string]]
|
|-
|price_discount_percentage
|[[#HTML|HTML]]
|
|-
|price
|[[#HTML|HTML]]
|
|-
|price_recommended
|[[#HTML|HTML]]
|
|-
|price_special
|[[#HTML|HTML]]
|
|-
|quantity
|[[#integer|integer]]
|
|-
|seo_link
|[[#string|string]]
|
|-
|tax
|[[#decimal|decimal]]
|Product tax rate.
|-
|tax_class_id
|[[#integer|integer]]
|
|-
|parent_id
|[[#integer|integer]]
|The products parent
|-
|child_count
|[[#integer|integer]]
|Counts amount of child products
|-
|rating
|[[#decimal|decimal]]
|Average review rating in increments of 0.5.
|-
|price_per_unit
|[[#decimal|decimal]]
|Product price per unit
|-
|unit
|[[#string|string]]
|Product unit. ex. st/cm/m
|-
|price_per_unit_recommended
|[[#decimal|decimal]]
|Recommended price in unit
|-
|price_per_unit_special
|[[#decimal|decimal]]
|Special price in unit
|-
|price_klarna_account
|[[#decimal|decimal]]
|Klarna account price
|-
|tags
|[[#list|list]] of [[#tag|tags]]
|
|}

====tag====
{| class="wikitable"
! Key !! Type !! Description
|-
| id || [[#integer|integer]] || ID.
|-
| parent_id || [[#integer|integer]] || Parent ID, 0 when there is no parent tag.
|-
| name || [[#string|string]] || Name.
|-
| description || [[#HTML|HTML]] || Description.
|-
| image || [[#URL|URL]] || Image URL.
|-
| meta_title || [[#HTML|HTML]] || Meta title.
|-
| meta_keywords || [[#HTML|HTML]] || Meta keywords.
|-
| meta_description || [[#HTML|HTML]] || Meta description.
|-
| children || [[#list|list]] of [[#tag|tags]] || Child tags.
|-
| used || [[#boolean|boolean]] || Indicates if the tag is used by any product in a category listing.
|}

====custom field====
{| class="wikitable"
! Key !! Type !! Description
|-
| fields_id || [[#integer|integer]] || ID.
|-
| require_in_checkout || [[#boolean|boolean]] || Is the field required in the checkout?
|-
| type || [[#string|string]] || What was entered in the administration.
|-
| name || [[#string|string]] || Field label.
|-
| value || [[#string|string]] || Entered value (not always available).
|}

==Globals==
Globals are accessible anywhere in the templates, including macros.
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|template
|[[#string|string]]
|Path to active template directory
|N/A
|-
|current_page
|[[#string|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|string]]
|Contains filename of current page
|index.php
|-
|request
|[[#dictionary|dictionary]]
|A [[#dictionary|dictionary]] of recieved ''GET'' and ''POST'' data
|
{| class="wikitable"
!Key
!Type
!Description
|-
|get
|[[#dictionary|dictionary]]
|Data received from the ''GET'' query string
|-
|post
|[[#dictionary|dictionary]]
|Received ''POST'' data
|}
|-
|current_customer_id
|[[#integer|integer]]
|Returns customer ID if customer is logged in, else None
|N/A
|-
|customer
|[[#dictionary|dictionary]]
|Contains information about the logged in customer, or null.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|[[#integer|integer]]
|
|-
|email
|[[#string|string]]
|
|-
|personnummer
|[[#string|string]]
|
|-
|first_name
|[[#string|string]]
|
|-
|last_name
|[[#string|string]]
|
|-
|company
|[[#string|string]]
|
|-
|telephone
|[[#string|string]]
|
|-
|mobile
|[[#string|string]]
|
|-
|country_id
|[[#integer|integer]]
|
|-
|postcode
|[[#string|string]]
|
|-
|street_address
|[[#string|string]]
|
|-
|custom
|[[#list|list]] of [[#custom field|custom field]]
|Custom fields.
|}
|-
|user_agent
|[[#string|string]]
|The client's user agent string.
|N/A
|-
|meta
|[[#dictionary|dictionary]]
|Header meta information for current page.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|[[#HTML|HTML]]
|Page title.
|-
|keywords
|[[#string|string]]
|Page meta keywords.
|-
|description
|[[#HTML|HTML]]
|Page meta description.
|-
|language
|[[#string|string]]
|Page language code.
|-
|generator
|[[#string|string]]
|Startabutik E-handel.
|-
|canonical
|[[#URL|URL]]
|Canonical URL for current page. Not always available.
|}
|-
|session
|[[#dictionary|dictionary]]
|Configurable session variables.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|currency
|[[#string|string]]
|Code of selected currency.
|-
|language
|[[#string|string]]
|Code of selected language.
|-
|language_id
|[[#integer|integer]]
|ID of selected language.
|-
|vat
|[[#boolean|boolean]]
|Display prices with or without VAT.
|.
|}
|-
|settings
|[[#dictionary|dictionary]]
|Contains some of the settings defined in the administration
|
{| class="wikitable"
!Key
!Type
!Description
|-
|ACCOUNT_COMPANY, ACCOUNT_DOB, ACCOUNT_GENDER, ACCOUNT_PERSONNUMMER, ACCOUNT_STATE, ACCOUNT_SUBURB
|[[#boolean|boolean]]
|Account fields can be enabled and disabled
|-
|API_ID_FACEBOOK
|[[#string|string]]
|General APP id for Facebook
|-
|API_ID_GOOGLE_VERIFICATION
|[[#string|string]]
|Google verification
|-
|CHARSET
|[[#string|string]]
|Charset of page.
|-
|CREATE_ACCOUNT_LAYOUT
|[[#integer|integer]]
|''Internal''
|-
|DOWNLOAD_ENABLED
|[[#boolean|boolean]]
|Is the download module enabled
|-
|ENTRY_CITY_MIN_LENGTH, ENTRY_DOB_MIN_LENGTH, ENTRY_EMAIL_ADDRESS_MIN_LENGTH, ENTRY_FIRST_NAME_MIN_LENGTH, ENTRY_LAST_NAME_MIN_LENGTH, ENTRY_PASSWORD_MIN_LENGTH, ENTRY_POSTCODE_MIN_LENGTH, ENTRY_STATE_MIN_LENGTH, ENTRY_STREET_ADDRESS_MIN_LENGTH, ENTRY_TELEPHONE_MIN_LENGTH
|[[#integer|integer]]
|Used in form validation
|-
|ENTRY_PASSWORD_IN_REGISTRATION
|[[#boolean|boolean]]
|Is the user allowed to specify a password when registering
|-
|FORMS_USE_CAPTCHA
|[[#boolean|boolean]]
|Is captcha used for forms
|-
|FACEBOOK_PROFILE_URL
|[[#string|string]]
|URL in format http://url.se/subfolder/
|-
|GOOGLEPLUS_PROFILE_URL
|[[#string|string]]
|URL in format http://url.se/subfolder/
|-
|HEADING_IMAGE_WIDTH, HEADING_IMAGE_HEIGHT
|[[#integer|integer]]
|Width and height of heading images
|-
|MAX_ADDRESS_BOOK_ENTRIES
|[[#integer|integer]]
|Maximum entries in the address book
|-
|PREV_NEXT_BAR_LOCATION
|[[#integer|integer]]
|''Internal''
|-
|SMALL_IMAGE_WIDTH
|[[#integer|integer]]
|Width of small thumbnails in pixels
|-
|SMALL_IMAGE_HEIGHT
|[[#integer|integer]]
|Height of small thumbnails in pixels
|-
|STATISTICS_GOOGLE_ANALYTICS
|[[#string|string]]
|Google analytics tracking code, if specified
|-
|SHOP_HEADER_TEXT
|[[#string|string]]
|Alt text for logo
|-
|SHOP_LOGO
|[[#string|string]]
|Shop logo in /images/
|-
|STORE_NAME
|[[#string|string]]
|
|-
|-
|POPUP_IMAGE_WIDTH, POPUP_IMAGE_HEIGHT
|[[#integer|integer]]
|
|-
|PRODUCT_PAGE_DESIGN
|[[#integer|integer]]
|''Internal''
|-
|YOUTUBE_PROFILE_URL
|[[#string|string]]
|URL in format http://url.se/subfolder/
|-
|TWITTER_PROFILE_URL
|[[#string|string]]
|URL in format http://url.se/subfolder/
|}
|-
|shoppingcart_amount
|[[#string|string]]
|Amount of products in shopping cart
|N/A
|-
|shoppingcart_total
|[[#string|string]]
|Total sum of the content in shopping cart
|N/A
|-
|random_box_left
|[[#string|string]]
|Shows boxes at the left side of the store
|N/A
|-
|random_box_right
|[[#string|string]]
|Shows boxes at the right side of the store
|N/A
|}

==Boxes==
Boxes are variables used for the side boxes. They are all prefixed with ''boxes''.
===Category menu===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.categories.tree
|[[#list|list]] of [[#dictionary|dictionaries]]
|Contains a tree of displayed categories in menu
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|[[#integer|integer]]
|Id of category
|-
|name
|[[#string|string]]
|Name of category in current language
|-
|image
|[[#string|string]]
|Path to category image if such exists
|-
|href
|[[#string|string]]
|Link to category's product listing page
|-
|child_count
|[[#integer|integer]]
|Number of open child categories
|-
|children
|[[#list|list]] of [[#dictionary|dictionaries]]
|List of visible child categories. See boxes.categories.tree for format
|-
|open
|[[#boolean|boolean]]
|Returns true if the category (or one of its children) is the currently selected one
|-
|selected
|[[#boolean|boolean]]
|Returns true if the category is the currently selected one
|}
|}

===Category full menu===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.categories_full.tree
|[[#list|list]] of [[#dictionary|dictionaries]]
|Contains a full tree of all available categories in menu
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|[[#integer|integer]]
|Id of category
|-
|name
|[[#string|string]]
|Name of category in current language
|-
|image
|[[#string|string]]
|Path to category image if such exists
|-
|href
|[[#string|string]]
|Link to category's product listing page
|-
|child_count
|[[#integer|integer]]
|Number of open child categories
|-
|children
|[[#list|list]] of [[#dictionary|dictionaries]]
|List of visible child categories. See boxes.categories.tree for format
|-
|open
|[[#boolean|boolean]]
|Returns true if the category (or one of its children) is the currently selected one
|-
|selected
|[[#boolean|boolean]]
|Returns true if the category is the currently selected one
|}
|}

===Manufacturer select===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.manufacturers.list
|[[#list|list]] of [[#dictionary|dictionaries]]
|Lists all available manufacturers
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|[[#integer|integer]]
|Manufacturer ID.
|-
|name
|[[#string|string]]
|Name of manufacturer
|-
|href
|[[#string|string]]
|Link to manufacturer page
|-
|link
|[[#URL|URL]]
|Full link to manufacturer page
|
|-
|selected
|[[#boolean|boolean]]
|True if the manufacturer_id GET variable is equal to the ID of this manufacturer.
|}
|}

===Search box===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.search.advanced_href
|[[#string|string]]
|URL to advanced search page
|N/A
|-
|boxes.search.advanced_result_href
|[[#string|string]]
|Action URL for search form
|N/A
|}
===Information page list===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.information_pages.list
|[[#list|list]] of [[#dictionary|dictionaries]]
|Lists all active information pages
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|[[#string|string]]
|Name of information page
|-
|href
|[[#string|string]]
|Link to information page
|-
|active
|[[#boolean|boolean]]
|Is user currently on this page?
|-
|target
|[[#boolean|boolean]]
|True if information page expects the attribute target="_blank"
|}
|}
===Language list===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.languages.list
|[[#list|list]] of [[#dictionary|dictionaries]]
|Lists all languages
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|[[#string|string]]
|Language name
|-
|href
|[[#string|string]]
|Link to page that sets language to this one
|-
|image
|[[#string|string]]
|Image (flag) for language if available
|}
|}
===Login box===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.login.form_href
|[[#string|string]]
|Action link for login form
|N/A
|-
|boxes.login.password_forgotten_href
|[[#string|string]]
|Link to retrieve forgotten password page
|N/A
|-
|boxes.login.account_history_href
|[[#string|string]]
|Link to current customer's account history page. Contains orders and such
|N/A
|-
|boxes.login.account_href
|[[#string|string]]
|Link to current customer's account page
|N/A
|-
|boxes.login.account_password_href
|[[#string|string]]
|''Unknown''
|N/A
|-
|boxes.login.logoff_href
|[[#string|string]]
|Link to log off current customer
|N/A
|-
|boxes.login.customer_first_name
|[[#string|string]]
|Current customer's first name
|N/A
|-
|boxes.login.customer_last_name
|[[#string|string]]
|Current customer's last name
|N/A
|}
===New products list===
Lists the most recently added products.
{| class="wikitable"
!Variable name
!Type
!Description
|-
|boxes.products_new.list
|[[#list|list]] of [[#product|product]]
|The most recently added products, the most recent first.
|}
===News list===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.news.list
|[[#list|list]] of [[#dictionary|dictionaries]]
|Lists recent news. Limit set in administration
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|[[#string|string]]
|News name
|-
|href
|[[#string|string]]
|Link to news page
|-
|summary
|[[#string|string]]
|News summary
|}
|}
===Review===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.reviews.write_review_href
|[[#string|string]]
|Link to write review page. Only set if customer is viewing a product page
|N/A
|-
|boxes.reviews.product
|[[#dictionary|dictionary]]
|Product and review data
|
{| class="wikitable"
!Key
!Type
!Description
|-
|product_name
|[[#string|string]]
|Name of product
|-
|product_image
|[[#string|string]]
|Link to product image
|-
|review_href
|[[#string|string]]
|Link to full review
|-
|review_rating
|[[#string|string]]
|Rating
|-
|review_text
|[[#string|string]]
|Text of review
|}
|}
===Shopping cart===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.shopping_cart.list
|[[#list|list]] of [[#dictionary|dictionaries]]
|List of products in shopping cart
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|[[#integer|integer]]
|ID of product
|-
|model
|[[#string|string]]
|Model number for product
|-
|name
|[[#string|string]]
|Name of product
|-
|image
|[[#string|string]]
|Link to image of product
|-
|quantity
|[[#string|string]]
|Number of this product in shopping cart
|-
|price
|[[#string|string]]
|Price per product before discounts represented as a string with currency symbol
|-
|final_price
|[[#string|string]]
|Price per product after discounts represented as a string with currency symbol
|-
|total_price
|[[#string|string]]
|Total price for all products of this kind before discounts represented as a string with currency symbol
|-
|total_final_price
|[[#string|string]]
|Total price for all products of this kind after discounts represented as a string with currency symbol
|-
|href
|[[#string|string]]
|Link to product's page
|-
|new
|[[#boolean|boolean]]
|''True'' if product was just added to the shopping cart
|}
|-
|boxes.shopping_cart.total
|[[#string|string]]
|Total value of contents of shopping cart represented as a string with currency symbol
|N/A
|-
|boxes.shopping_cart.total_items
|[[#integer|integer]]
|Sum of product quantities.
|N/A
|}

===Random special offer===
Contains a random special offer.
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.special_offers.product
|[[#dictionary|dictionary]]
|''True'' if prices are displayed including VAT, else ''false''.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|[[#string|string]]
|Name of product
|-
|href
|[[#string|string]]
|Link to product page
|-
|image
|[[#string|string]]
|Link to product image
|-
|price
|[[#string|string]]
|Product standard price represented with currency symbol
|-
|special_price
|[[#string|string]]
|Product price after discounts represented with currency symbol
|}
|}
===VAT select box===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.vat_select.display_with_vat
|[[#boolean|boolean]]
|''True'' if prices are displayed including VAT, else ''false''.
|N/A
|-
|boxes.vat_select.with_href
|[[#string|string]]
|URL to page where VAT display is set to ''true''.
|N/A
|-
|boxes.vat_select.without_href
|[[#string|string]]
|URL to page where VAT display is set to ''false''.
|N/A
|}
===Custom boxes===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.custom.boxes
|[[#dictionary|dictionary]] of lists
|Dictionary of boxes, indexed by the box name.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|type
|[[#integer|integer]]
|Type of box.
|-
|class
|[[#string|string]]
|CSS classes
|}
If type is 0:
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|[[#string|string]]
|Box title.
|-
|product
|product
|Product displayed.
|}
If type is 1:
{| class="wikitable"
!Key
!Type
!Description
|-
|text
|[[#HTML|HTML]]
|Box contents.
|}
If type is 2:
{| class="wikitable"
!Key
!Type
!Description
|-
|image
|[[#URL|URL]]
|Box image.
|}
|}

==Modules==

===product_parent===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.product_parent.name
|[[#string|string]]
|Parent product name.
|N/A
|-
|modules.product_parent.description
|[[#string|string]]
|Parent product description.
|N/A
|-
|modules.product_parent.image
|[[#string|string]]
|Parent product image.
|N/A
|-
|modules.product_parent.images
|[[#string|string]]
|Parent product additional images.
|N/A
|}

===associated_products.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.associated_products.products
|[[#list|list]] of products
|Associated products.
|N/A
|}

===product_attributes.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.product_attributes.attributes
|[[#list|list]] of [[#dictionary|dictionaries]]
|Product attributes.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|value
|[[#string|string]]
|Attribute value.
|-
|id
|[[#integer|integer]]
|Attribute index.
|-
|name
|[[#string|string]]
|Attribute name.
|-
|type
|[[#integer|integer]]
|Attribute type.
|-
|selected
|[[#integer|integer]]
|Selected attribute.
|-
|options
|[[#list|list]] of index to value mappings
|Attribute options.
|}
|}

===product_specifications.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.product_specifications.grouped
|[[#list|list]] of categories
|Specifications with multiple values per specification grouped into a values variable.
|
|-
|modules.product_specifications.hierarchy
|[[#list|list]] of categories
|The hierarchy of specifications used for this product.
|
|-
|modules.product_specifications.specifications
|[[#list|list]] of [[#dictionary|dictionaries]]
|Product specifications.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|[[#string|string]]
|Specification name.
|-
|value
|[[#string|string]]
|Specification value.
|}
|-
|modules.product_specifications.specifications_multi
|[[#list|list]] of [[#dictionary|dictionaries]]
|Product specifications, one entry per value.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|[[#string|string]]
|Specification name.
|-
|value
|[[#string|string]]
|Specification value.
|}
|}

===products_in_package.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.products_in_package.products
|[[#list|list]] of products
|Products in product package.
|N/A
|}

===products_reviews.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.products_reviews.captcha_href
|[[#URL|URL]]
|Link to the captcha image.
|N/A
|-
|modules.products_reviews.error
|[[#string|string]]
|Error message.
|N/A
|-
|modules.products_reviews.customer
|[[#dictionary|dictionary]]
|Customer information.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|firstname
|[[#string|string]]
|First name.
|-
|lastname
|[[#string|string]]
|Last name.
|}
|-
|modules.products_reviews.reviews
|[[#list|list]] of [[#dictionary|dictionaries]]
|Product reviews.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|rating
|[[#integer|integer]]
|Review rating, 1-5.
|-
|author
|[[#string|string]]
|Review author.
|-
|date
|[[#string|string]]
|Review date.
|-
|text
|[[#HTML|HTML]]
|Review text.
|}
|}

===products_variants.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.products_variants.category
|[[#integer|integer]]
|Category index.
|N/A
|-
|modules.products_variants.variants
|[[#list|list]] of [[#dictionary|dictionaries]]
|Variants.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|[[#string|string]]
|Variant name
|-
|selected
|[[#integer|integer]]
|Selected variant.
|-
|options
|[[#list|list]] of [[#integer|integer]] to value mappings
|Variants.
|}
|-
|modules.products_variants.products
|[[#list|list]] of [[#dictionary|dictionaries]]
|Variants.
|
{| class="wikitabmodules.products_variants.products le"
!Key
!Type
!Description
|-
|seo_link
|[[#URL|URL]]
|Variant URL.
|-
|name
|[[#string|string]]
|Variant name.
|}
|-
|modules.products_variants.combinations
|[[#list|list]] of lists of [[#integers|integer]]s
|Available combinations of options.
|N/A
|-
|modules.products_variants.combination
|[[#list|list]] of [[#integers|integer]]s
|Currently selected combination.
|N/A
|}

===tell_a_friend.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.tell_a_friend.form_action
|[[#URL|URL]]
|Form handler.
|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''.

===Account edit page (account_edit.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account_edit.form_action
|[[#URL|URL]]
|A link to the page which handles the form
|N/A
|-
|account_edit.back_href
|[[#URL|URL]]
|A link back to the account page
|N/A
|-
|account_edit.account
|[[#dictionary|dictionary]]
|Account data
|
{| class="wikitable"
!Key
!Type
!Description
|-
|firstname
|[[#string|string]]
|Account first name
|-
|lastname
|[[#string|string]]
|Account last name
|-
|personnummer
|[[#string|string]]
|Account personnummer
|-
|dob
|[[#string|string]]
|Account date of birth
|-
|email_address
|[[#string|string]]
|Account email address
|-
|telephone
|[[#string|string]]
|Account telephone number
|-
|mobile
|[[#string|string]]
|Account mobile telephone number
|-
|fax
|[[#string|string]]
|Account fax number
|-
|gender
|[[#string|string]]
|Account gender ('m' or 'f')
|-
|custom
|[[#list|list]] of [[#custom field|custom field]]
|Custom fields.
|}
|}

===Account history page (account_history.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account_history.account_href
|[[#URL|URL]]
|A link back to the account page
|N/A
|-
|account_history.pagination
|[[#pagination|pagination]]
|Pagination info
|N/A
|-
|account_history.page_href_format
|[[#URL|URL]]
|Pagination link format
|N/A
|-
|account_history.order_history
|[[#list|list]] of [[#dictionary|dictionaries]]
|Order history
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|[[#integer|integer]]
|Order ID
|-
|status
|[[#string|string]]
|Order status
|-
|date
|[[#string|string]]
|Order date
|-
|type
|[[#string|string]]
|Order type
|-
|name
|[[#string|string]]
|Order delivery name
|-
|product_count
|[[#integer|integer]]
|Product count
|-
|total
|[[#string|string]]
|Order total
|-
|href
|[[#URL|URL]]
|A link to the description of the order
|-
|}
|}

===Order info page (account_history_info.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account_history_info.back_href
|[[#URL|URL]]
|Link back to the account order history
|N/A
|-
|account_history_info.order
|[[#dictionary|dictionary]]
|Order info
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id_formatted
|[[#string|string]]
|Order ID
|-
|status
|[[#string|string]]
|Order status
|-
|date
|[[#string|string]]
|Order date
|-
|total
|[[#string|string]]
|Order total
|-
|shipping_method
|[[#string|string]]
|Order shipping method
|-
|payment_method
|[[#string|string]]
|Order payment method
|-
|tax_group_count
|[[#integer|integer]]
|Number of different tax groups
|-
|billing_address
|[[#string|string]]
|Order billing address
|-
|delivery_address
|[[#string|string]]
|Order delivery address
|-
|delivery
|[[#boolean|boolean]]
|
|-
|products
|[[#list|list]] of [[#dictionary|dictionaries]]
|Products in order
{| class="wikitable"
!Key
!Type
!Description
|-
|qty
|[[#integer|integer]]
|Product quantity
|-
|id
|[[#integer|integer]]
|Product ID
|-
|name
|[[#string|string]]
|Product name
|-
|model
|[[#string|string]]
|Product model
|-
|tax
|[[#decimal|decimal]]
|Product tax
|-
|price
|[[#decimal|decimal]]
|Product price
|-
|-
|final_price
|[[#decimal|decimal]]
|Final product price
|-
|image
|[[#string|string]]
|Address to image
|-
|href
|[[#string|string]]
|Link address to product
|-
|status
|[[#string|string]]
|Products status. 0 = inactive, 1 = active
|}
|-
|totals
|[[#list|list]] of [[#dictionary|dictionaries]]
|Order parts of total
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|[[#string|string]]
|Total part label
|-
|text
|[[#HTML|HTML]]
|Total part value
|}
|-
|statuses
|[[#list|list]] of [[#dictionary|dictionaries]]
|Order statuses
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|[[#string|string]]
|Status name
|-
|date
|[[#string|string]]
|Status date
|-
|comments
|[[#string|string]]
|Status comments
|}
|-
|events
|[[#list|list]] of [[#dictionary|dictionaries]]
|Order delivery events
{| class="wikitable"
!Key
!Type
!Description
|-
|date
|[[#string|string]]
|Event date
|-
|location
|[[#string|string]]
|Event location
|-
|description
|[[#string|string]]
|Event description
|}
|}
|}

===Account page (account.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account.account_history_href
|[[#URL|URL]]
|A link to the account history page
|N/A
|-
|account.account_edit_href
|[[#URL|URL]]
|A link to the edit account page
|N/A
|-
|account.address_book_href
|[[#URL|URL]]
|A link to the address book page
|N/A
|-
|account.account_password_href
|[[#URL|URL]]
|A link to the password change page
|N/A
|-
|account.logoff_href
|[[#URL|URL]]
|A link to the logoff page
|N/A
|-
|account.account_newsletters_href
|[[#URL|URL]]
|A link to the newsletters page
|N/A
|-
|account.account_notifications_href
|[[#URL|URL]]
|A link to the notifications page
|N/A
|-
|account.order_history_enabled
|[[#boolean|boolean]]
|Is the order history enabled?
|N/A
|-
|account.order_history
|[[#list|list]] of [[#dictionary|dictionaries]]
|Order history
|
{| class="wikitable"
!Key
!Type
!Description
|-
|href
|[[#URL|URL]]
|A link to the order description page
|-
|date
|[[#string|string]]
|The date the order was placed
|-
|id
|[[#integer|integer]]
|Order ID
|-
|country
|[[#string|string]]
|Order delivery name and country
|-
|status
|[[#string|string]]
|Order status
|-
|total
|[[#HTML|HTML]]
|Order total
|}
|}

===Account newsletter subscription page (account_newsletters.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account_newsletters.form_action
|[[#URL|URL]]
|A link to the page which handles the form
|N/A
|-
|account_newsletters.back_href
|[[#URL|URL]]
|Link back to the account page
|N/A
|-
|account_newsletters.subscribed
|[[#boolean|boolean]]
|Is the user subscribed to the newsletter
|N/A
|}

===Account notifications page (account_notifications.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account_notifications.form_action
|[[#URL|URL]]
|A link to the page which handles the form
|N/A
|-
|account_notifications.account_href
|[[#URL|URL]]
|A link back to the account page
|N/A
|-
|account_notifications.products
|[[#list|list]] of [[#dictionary|dictionaries]]
|The products subscribed to
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|[[#integer|integer]]
|Product ID
|-
|name
|[[#string|string]]
|Product name
|-
|counter
|[[#integer|integer]]
|List index
|}
|-
|account_notifications.global_product_notifications
|[[#boolean|boolean]]
|Has the user enabled the global product notification setting
|N/A
|}

===Change account password page (account_password.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account_password.form_action
|[[#URL|URL]]
|A link to the page which handles the form
|N/A
|-
|account_password.back_href
|[[#URL|URL]]
|Link back to the account page
|N/A
|}

===New account password page (account_password_new.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account_password_new.form_action
|[[#URL|URL]]
|A link to the page which handles the form
|N/A
|-
|account_password_new.back_href
|[[#URL|URL]]
|Link back to the account page
|N/A
|-
|account_password_new.password_provided
|[[#boolean|boolean]]
|Is a password provided by the user, or the default password
|N/A
|}

===Address book page (address_book.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|address_book.back_href
|[[#URL|URL]]
|A link back to the account page
|N/A
|-
|address_book.add_href
|[[#URL|URL]]
|A link to a form which adds a new entry to the address book
|N/A
|-
|address_book.entries_count
|[[#integer|integer]]
|Number of entries
|N/A
|-
|address_book.address_label
|[[#HTML|HTML]]
|Address label
|N/A
|-
|address_book.addresses
|[[#list|list]] of [[#dictionary|dictionaries]]
|The addresses in the address book
|
{| class="wikitable"
!Key
!Type
!Description
|-
|default
|[[#boolean|boolean]]
|Is this the default address book entry
|-
|edit_href
|[[#URL|URL]]
|A link to edit the entry
|-
|delete_href
|[[#URL|URL]]
|A link to delete the entry
|-
|name
|[[#string|string]]
|Associated name
|-
|address
|[[#HTML|HTML]]
|The address
|}
|}

===Address book modification page (address_book_process.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|address_book_process.editing
|[[#boolean|boolean]]
|Is the page in the editing mode?
|N/A
|-
|address_book_process.deleting
|[[#boolean|boolean]]
|Is the page in the deletion mode?
|N/A
|-
|address_book_process.edit_form_action
|[[#URL|URL]]
|A link to a page which handles the editing form
|N/A
|-
|address_book_process.delete_form_action
|[[#URL|URL]]
|A link to a page which handles the deletion form
|N/A
|-
|address_book_process.address_label
|[[#HTML|HTML]]
|The address
|N/A
|-
|address_book_process.back_href
|[[#URL|URL]]
|A back link
|N/A
|-
|address_book_process.address_book_href
|[[#URL|URL]]
|A link to the address_book
|N/A
|-
|address_book_process.process
|[[#boolean|boolean]]
|Is the page in the processing mode?
|N/A
|-
|address_book_process.default_address
|[[#boolean|boolean]]
|Is this the default address?
|N/A
|-
|address_book_process.entry
|[[#dictionary|dictionary]]
|The fields in the current entry
|
{| class="wikitable"
!Key
!Type
!Description
|-
|male
|[[#boolean|boolean]]
|Male gender?
|-
|firstname
|[[#string|string]]
|First name
|-
|lastname
|[[#string|string]]
|Last name
|-
|company
|[[#string|string]]
|Company
|-
|street_address
|[[#string|string]]
|Street address
|-
|suburb
|[[#string|string]]
|Suburb
|-
|postcode
|[[#string|string]]
|Post code
|-
|city
|[[#string|string]]
|City
|-
|country_list
|[[#HTML|HTML]]
|A drop-down list with countries
|-
|state_has_zones
|[[#boolean|boolean]]
|Does the state have zones?
|-
|state
|[[#string|string]]
|State
|-
|states
|association list
|A list of zones in the state
|}
|}

===Advanced search page (advanced_search.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|advanced_search.form_action
|[[#string|string]]
|A link to the page which handles the form.
|N/A
|-
|advanced_search.categories
|association list
|A list of category names mapped to their indices.
|[[#dictionary|dictionary]] of [[#string|string]] to [[#integer|integer]] mappings.
|-
|advanced_search.manufacturers
|association list
|A list of manufacturer names mapped to their indices.
|[[#dictionary|dictionary]] of [[#string|string]] to [[#integer|integer]] mappings.
|}

===Search results page (advanced_search_results.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| advanced_search_results.results || [[#list|list]] of products || The search results. ||N/A
|-
| advanced_search_results.num_results || [[#integer|integer]] || The number of search results. || N/A
|-
| advanced_search_results.back_href || [[#URL|URL]] || A link for returning to the search page. || N/A
|}

===Campaign page (campaign.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| campaign.campaign_name || [[#HTML|HTML]] || Title of campaign. ||N/A
|-
| campaign.campaign_description || [[#HTML|HTML]] || Description of campaign. ||N/A
|-
| campaign.campaign_image || [[#URL|URL]] || Selected campaign image. ||N/A
|-
| campaign.products || [[#list|list]] of products || Products included in campaign. ||N/A
|}

===Product list (categories_listing.html)===
====GET variables====
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
|}
====Available data====
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| categories_listing.header || [[#dictionary|dictionary]] || Attributes for the top of the page. It is either a manufacturer or a category ||
{| class="wikitable"
! Key !! Type !! Description
|-
| name || [[#string|string]] || Name of category/manufacturer
|-
| alternative_name || [[#string|string]] || An alternative category name. (SEO name.)
|-
| image || [[#string|string]] || Image [[#URL|URL]] for category/manufacturer
|-
| text || [[#HTML|HTML]] || Description of category/manufacturer
|-
| alternative_text || [[#HTML|HTML]] || An alternative category description. (SEO text.)
|}
|-
| categories_listing.header || [[#dictionary|dictionary]] || Page header attributes: image, description and title ||
|-
| categories_listing.cpath || [[#list|list]] of [[#integers|integer]]s || List of category IDs, where the last one is the current category, the second last the current category's parent and so on. The first element is the top level category. ||N/A
|-
| categories_listing.product_list || [[#list|list]] of [[#dictionary|dictionaries]] || All products for current page || [[Templating:Variables#product|Product list]]
|-
| categories_listing.product_count || [[#integer|integer]] || Total number of products using current filters || N/A
|-
|}
====Display variables====
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| categories_listing.default_list_style || [[#integer|integer]] || By default this layout for the listing is selected || N/A
|-
| categories_listing.page_limit || [[#integer|integer]] || Maximum number of products per page || N/A
|-
| categories_listing.page_limits || [[#list|list]] of [[#integers|integer]]s || List of available page limits. 0 means all product on one page || N/A
|-
| categories_listing.page_index || [[#integer|integer]] || Current page number || N/A
|-
| categories_listing.page_count || [[#integer|integer]] || Number of pages || N/A
|-
| categories_listing.sort_options || [[#dictionary|dictionary]] || Total number of products using current filters || Identifier (''model, price, etc'') as key and name (''Model, Price, etc'') as values
|-
| categories_listing.sort_form_href || [[#string|string]] || Link to the same page. || N/A
|-
| categories_listing.sort_name_href || [[#string|string]] || Link to the same page when sorting by name. If already sorting by name, this URL inverts the order || N/A
|-
| categories_listing.sort_model_href || [[#string|string]] || Link to the same page when sorting by model. If already sorting by model, this URL inverts the order || N/A
|-
| categories_listing.sort_price_href || [[#string|string]] || Link to the same page when sorting by price. If already sorting by price, this URL inverts the order || N/A
|-
| categories_listing.pagination_uri_format || [[#string|string]] || Format string for pagination. It contains a %d that the pagination macro replaces by page number || N/A
|-
|}
====Filtering variables====
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| categories_listing.tags || [[#list|list]] of [[#tag|tags]] || Root tags for which at least one subtag is used by one of the listed products. || N/A
|-
| categories_listing.used_tag_ids || [[#list|list]] of [[#integers|integer]]s || The tags used by at least one product in the filtered set of products.|| N/A
|-
| categories_listing.used_spec_values || [[#dictionary|dictionary]] of [[#integers|integer]]s to [[#list|lists]] of [[#integer|integers]] || The specification values used by the value specifications for the filtered products.|| N/A
|-
| categories_listing.used_spec_texts || [[#dictionary|dictionary]] of [[#integers|integer]]s to [[#list|lists]] of [[#string|strings]] || The specification values used by the text specifications for the filtered products.|| N/A
|-
| categories_listing.used_manufacturers_ids || [[#list|list]] of [[#integers|integer]]s || The manufacturers used by at least one product in the filtered set of products.|| N/A
|-
| categories_listing.manufacturers || [[#list|list]] of [[#dictionary|dictionaries]] || Manufacturers used by products in current category tree. ||
{| class="wikitable"
! Key !! Type !! Description
|-
| id || [[#string|string]] || Manufacturer ID.
|-
| name || [[#string|string]] || Manufacturer name.
|-
| image || [[#URL|URL]] || Manufacturer image.
|}
|}

===Checkout success (checkout_success.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|checkout_success.update_action
|[[#URL|URL]]
|A link to the page which handles the form
|N/A
|-
|checkout_success.heading
|[[#string|string]]
|Page heading
|N/A
|-
|checkout_success.text
|[[#HTML|HTML]]
|Page content
|N/A
|-
|checkout_success.order_id
|[[#integer|integer]]
|Order ID
|N/A
|-
|checkout_success.survey_questions
|[[#list|list]] of [[#dictionary|dictionaries]]
|Survey questions
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|[[#integer|integer]]
|Question ID
|-
|question
|[[#string|string]]
|Question
|-
|alternatives
|[[#list|list]] of [[#dictionary|dictionaries]]
|Question alternatives
{| class="wikitable"
!Key
!Type
!Description
|-
|type
|[[#integer|integer]]
|Alternative type, 1 for a radio button, an input field otherwise
|-
|id
|[[#integer|integer]]
|Alternative ID
|-
|answer
|[[#string|string]]
|Alternative text
|-
|}
|}
|}

===Contact us page (contact.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|contact.form_href
|[[#string|string]]
|URL with target of form for handling user input data
|N/A
|-
|contact.captcha
|[[#boolean|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|string]]
|Contains customer e-mail if customer is logged in or validation if validation of a field failed
|N/A
|-
|contact.heading
|[[#string|string]]
|Contains heading text
|N/A
|-
|contact.text
|[[#string|string]]
|Contains a descriptive text of what the contact us page is. It most certainly contains [[#HTML|HTML]] so the [http://www.twig-project.org/doc/templates.html#raw raw] filter may be appropriate to use
|N/A
|}

===Cookie usage page (cookie_usage.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|cookie_usage.continue_href
|[[#string|string]]
|A link to the next page (index.php)
|N/A
|}

===Gallery pages (gallery.html, galleries/)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|gallery.title
|[[#string|string]]
|Gallery title.
|N/A
|-
|gallery.description
|[[#string|string]]
|Gallery description or content.
|N/A
|-
|gallery.date
|[[#string|string]]
|Last modification date.
|N/A
|-
|gallery.type
|[[#string|string]]
|Type of gallery.
|N/A
|-
|gallery.upload_data_action
|[[#URL|URL]]
|Form action for uploading.
|N/A
|-
|gallery.upload_data_check
|[[#boolean|boolean]]
|True.
|N/A
|-
|gallery.upload_data_type
|[[#HTML|HTML]]
|Form field.
|N/A
|-
|gallery.page_title
|[[#string|string]]
|Edited page title.
|N/A
|-
|gallery.page_description
|[[#HTML|HTML]]
|Edited page description.
|N/A
|-
|gallery.meta_title
|
|
|N/A
|-
|gallery.meta_description
|
|
|N/A
|-
|gallery.meta_keywords
|
|
|N/A
|-
|gallery.form_page_description
|[[#string|string]]
|Edited page description, escaped.
|N/A
|-
|gallery.gallery_owned
|[[#boolean|boolean]]
|Set if the gallery is owned by the logged-in user.
|N/A
|-
|gallery.edit_content_link
|[[#URL|URL]]
|Link for editing the gallery.
|N/A
|-
|gallery.remove_content_link
|[[#URL|URL]]
|Link for removing the gallery.
|N/A
|-
|gallery.edit_mode
|[[#boolean|boolean]]
|Set when editing, otherwise adding.
|N/A
|-
|gallery.gallery_fields
|[[#list|list]] of [[#dictionary|dictionaries]]
|Gallery fields.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|label
|[[#string|string]]
|Field label.
|-
|output
|[[#HTML|HTML]]
|Form field.
|}
|-
|gallery.children
|[[#list|list]] of [[#string|string]] to [[#dictionary|dictionary]] mappings
|Child galleries indexed by gallery type.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|[[#string|string]]
|Gallery title.
|-
|description
|[[#HTML|HTML]]
|Gallery description.
|-
|link
|[[#URL|URL]]
|Child gallery link.
|-
|date
|[[#string|string]]
|Last modification date.
|}
|-
|gallery.siblings
|[[#list|list]] of [[#string|string]] to [[#dictionary|dictionary]] mappings
|Sibling galleries indexed by gallery type.
|See gallery.children.
|}

===Index page (index.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|index.text
|[[#HTML|HTML]]
|Page text
|N/A
|-
|index.header_products
|products
|A random selection of products.
|[[#list|list]] of products
|-
|index.featured_products
|products
|A list of featured products.
|[[#list|list]] of products
|-
|index.new_products
|products
|A list of recently added products.
|[[#list|list]] of products
|-
|index.specials_products
|products
|A list of products with special prices.
|[[#list|list]] of products
|}

===Kolli page (kolli.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|kolli.heading
|[[#string|string]]
|Page heading
|N/A
|-
|kolli.text
|[[#HTML|HTML]]
|Page text
|N/A
|}

===Login page (create_account.html, login.html, password_forgotten.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|create_account.form_action
|[[#URL|URL]]
|A link to the page which handles the form
|N/A
|-
|create_account.heading
|[[#string|string]]
|Page heading.
|N/A
|-
|create_account.text
|[[#string|string]]
|Page text.
|N/A
|-
|create_account.generated_password
|[[#string|string]]
|A randomly generated password suitable for the new account.
|N/A
|-
|create_account.customers_personnummer
|[[#string|string]]
|
|N/A
|-
|create_account.countries
|association list
|A list of country indices mapped to their names.
|[[#dictionary|dictionary]] of [[#integer|integer]] to [[#string|string]] mappings.
|}

{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|login.form_action
|[[#URL|URL]]
|A link to the page which handles the form
|N/A
|-
|login.heading
|[[#string|string]]
|Page heading
|N/A
|-
|login.page_name
|[[#string|string]]
|
|N/A
|}

{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|password_forgotten.form_action
|[[#string|string]]
|A link to the page which handles the form
|N/A
|-
|password_forgotten.back_href
|[[#string|string]]
|A link to the parent page (login.php)
|N/A
|}

====Create account box (containboxes/create_account.html)====
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|containboxes.create_account.form_action
|[[#URL|URL]]
|A link to the page which handles the form
|N/A
|-
|containboxes.create_account.text
|[[#HTML|HTML]]
|Box text
|N/A
|-
|containboxes.create_account.generated_password
|[[#string|string]]
|A randomly generated password suitable for the new account.
|N/A
|-
|containboxes.create_account.customers_personnummer
|[[#string|string]]
|The customer's personnummer
|N/A
|-
|containboxes.create_account.countries
|association list
|A list of country indices mapped to their names.
|[[#dictionary|dictionary]] of [[#integer|integer]] to [[#string|string]] mappings.
|}

====Login box (containboxes/login_box.html)====
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|containboxes.login_box.form_action
|[[#URL|URL]]
|A link to the page which handles the form
|N/A
|}

====Password forgotten box (containboxes/password_forgotten_box.html)====
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|containboxes.password_forgotten_box.form_action
|[[#URL|URL]]
|A link to the page which handles the form
|N/A
|}

===Log off page (logoff.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|logoff.continue_href
|[[#string|string]]
|Link presented to the user after logging off.
|N/A
|}

===Manufacturers page (manufacturers.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|id
|[[#string|string]]
|N/A
|N/A
|-
|name
|[[#string|string]]
|N/A
|N/A
|-
|image
|[[#string|string]]
|N/A
|N/A
|-
|address
|[[#string|string]]
|N/A
|N/A
|-
|postcode
|[[#string|string]]
|N/A
|N/A
|-
|postal_address
|[[#string|string]]
|N/A
|N/A
|-
|visitational_address
|[[#string|string]]
|N/A
|N/A
|-
|country
|[[#string|string]]
|N/A
|N/A
|-
|telephone1
|[[#string|string]]
|N/A
|N/A
|-
|telephone2
|[[#string|string]]
|N/A
|N/A
|-
|fax
|[[#string|string]]
|N/A
|N/A
|-
|email_address
|[[#string|string]]
|N/A
|N/A
|-
|orgno
|[[#string|string]]
|N/A
|N/A
|-
|vat
|[[#string|string]]
|N/A
|N/A
|-
|note
|[[#string|string]]
|N/A
|N/A
|-
|plusgiro
|[[#string|string]]
|N/A
|N/A
|-
|bankgiro
|[[#string|string]]
|N/A
|N/A
|-
|contact
|[[#string|string]]
|N/A
|N/A
|-
|payment_conditions
|[[#string|string]]
|N/A
|N/A
|-
|customers_no
|[[#string|string]]
|N/A
|N/A
|-
|homepage
|[[#string|string]]
|N/A
|N/A
|-
|link
|[[#string|string]]
|N/A
|N/A
|-
|}

===News archive page (news_archive.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|news_archive.news
|[[#list|list]] of [[#dictionary|dictionaries]]
|News articles
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|[[#integer|integer]]
|News article ID
|-
|title
|[[#string|string]]
|News article title
|-
|date
|[[#string|string]]
|News article publishing date
|-
|content
|[[#string|string]]
|News article content
|}
|}

===News article page (news.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|news.title
|[[#string|string]]
|News article title
|N/A
|-
|news.date
|[[#string|string]]
|Date of publishing
|N/A
|-
|news.content
|[[#string|string]]
|News article content
|N/A
|}

===Newsletter page (newsletter.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| newsletter.text || [[#HTML|HTML]] || The newsletter. ||N/A
|}

===Product page (product.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product.form_href || [[#URL|URL]] || Add to cart handler. || N/A
|-
| product.reviews_href || [[#URL|URL]] || Link to product reviews. || N/A
|-
| product.invalid_name || [[#string|string]] || Invalid product name page title. || N/A
|-
| product.invalid_text || [[#string|string]] || Invalid product name page text. || N/A
|-
| product.inactive_name || [[#string|string]] || Inactive product name page title. || N/A
|-
| product.inactive_text || [[#string|string]] || Inactive product name page text. || N/A
|-
|product.product_prev
product.product_next
|[[#dictionary|dictionary]]
|Previous and next products in the current category.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id||[[#integer|integer]]||Product index.
|-
|image||[[#URL|URL]]||Product image.
|-
|name||[[#string|string]]||Product name.
|-
|href||[[#URL|URL]]||Product link
|}
|-
| product.category_path || [[#list|list]] of [[#dictionary|dictionaries]] || Information about the current category path.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id||[[#integer|integer]]||Category index.
|-
|name||[[#string|string]]||Category name.
|-
|image||[[#URL|URL]]||Category image.
|-
|seo_link||[[#URL|URL]]||Category link.
|}
|-
|product.product || [[#dictionary|dictionary]] || Product information
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id || [[#integer|integer]] || Product index.
|-
|parent_id||[[#integer|integer]]||Parent product index.
|-
|categories||[[#list|list]] of lists of [[#dictionary|dictionaries]]||Information for all product categories.||See product.category_path.
|-
|tags||[[#list|list]] of [[#tag|tags]]||Tags set for this product.
|-
|date_added||[[#string|string]]||Date product was added.
|-
|date_available||[[#string|string]]||Date product will be available.
|-
|delivery_time||[[#string|string]]||Product delivery time.
|-
|description||[[#HTML|HTML]]||Product description.
|-
|description_short||[[#HTML|HTML]]||Short product description.
|-
|disabled||[[#boolean|boolean]]||Product disabled status.
|-
|ean1||[[#string|string]]||Product EAN.
|-
|external_url||[[#URL|URL]]||Product link.
|-
|extra1||[[#HTML|HTML]]||Custom product field.
|-
|extra2||[[#HTML|HTML]]||Custom product field.
|-
|extra3||[[#HTML|HTML]]||Custom product field.
|-
|extra4||[[#HTML|HTML]]||Custom product field.
|-
|extra5||[[#HTML|HTML]]||Custom product field.
|-
|featured||[[#boolean|boolean]]||Featured product.
|-
|file||[[#URL|URL]]||Product file 1.
|-
|file2||[[#URL|URL]]||Product file 2.
|-
|full_products_id||[[#integer|integer]]||Requested product ID (including attributes).
|-
|image||[[#URL|URL]]||Product image.
|-
|image_href||[[#URL|URL]]||Link to full product image.
|-
|additional_images||Additional product images.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|href||[[#URL|URL]]||Image thumbnail link.
|-
|image||[[#URL|URL]]||Image path.
|-
|description||[[#string|string]]||Image description.
|}
|-
|last_modified||[[#string|string]]||Product last modified date.
|-
|lowest_number||[[#integer|integer]]||Minimum required order size.
|-
|manufacturer_model||[[#string|string]]||Product manufacturer model.
|-
|model||[[#string|string]]||Product model.
|-
|name||[[#string|string]]||Product name.
|-
|next_delivery_date||[[#string|string]]||Next delivery date.
|-
|next_delivery_quantity||[[#string|string]]||Next delivery quantity.
|-
|tax||[[#decimal|decimal]]||Product tax rate.
|-
|price||[[#string|string]]||Product price.
|-
|price_rek||[[#string|string]]||Recommended product price.
|-
|price_special||[[#string|string]]||Special product price.
|-
|rating||[[#decimal|decimal]]||Average review rating in increments of 0.5.
|-
|seo_link||[[#URL|URL]]||Product link.
|-
|stock||[[#integer|integer]]||Products in stock.
|-
|type||[[#string|string]]||Product quantity type.
|-
|weight||[[#string|string]]||Product weight.
|-
|reorder_stock||[[#string|string]]||
|-
|stock_place||[[#string|string]]||Product location.
|-
|viewed||[[#integer|integer]]||Product view count.
|-
|ordered||[[#integer|integer]]||Product order count.
|-
|note||[[#string|string]]||Product note.
|-
|lead_time||[[#string|string]]||
|-
|price_in||[[#string|string]]||
|-
|price_rek||[[#string|string]]||
|-
|shipping_class||int||Product shipping class. 1-10
|-
|}
|-
|product.manufacturer || [[#dictionary|dictionary]] || Product manufacturer information
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name||[[#string|string]]||Manufacturer name.
|-
|href||[[#URL|URL]]||Manufacturer URL.
|-
|image||[[#URL|URL]]||Manufacturer image.
|-
|address||[[#string|string]]||
|-
|postcode||[[#string|string]]||
|-
|postal_address||[[#string|string]]||
|-
|visitational_address||[[#string|string]]||
|-
|country||[[#string|string]]||
|-
|telephone1||[[#string|string]]||
|-
|telephone2||[[#string|string]]||
|-
|fax||[[#string|string]]||
|-
|email_address||[[#string|string]]||Manufacturer email address.
|-
|orgno||[[#string|string]]||
|-
|vat||[[#string|string]]||
|-
|note||[[#string|string]]||Manufacturer note.
|-
|plusgiro||[[#string|string]]||
|-
|bankgiro||[[#string|string]]||
|-
|contact||[[#string|string]]||
|-
|payment_conditions||[[#string|string]]||
|-
|customers_no||[[#string|string]]||
|-
|}
|}

===Product added to shopping cart page (product_added.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product_added.checkout_href || [[#URL|URL]] || A link to the checkout page. || N/A
|-
| product_added.product || product || The product added.
| The product has one additional key.
{| class="wikitable"
!Key
!Type
!Description
|-
|quantity_added
|[[#integer|integer]]
|The quantity of the product added to the shopping cart
|}
|}

===New products page (products_new.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|products_new.pagination
|[[#pagination|pagination]]
|Pagination info
|N/A
|-
|products_new.page_href_format
|[[#URL|URL]]
|Pagination link format
|N/A
|-
|products_new.products
|products
|A list of recently added products.
|[[#list|list]] of products
|}

===Product reviews page (product_reviews.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product_reviews.back_href || [[#URL|URL]] || Link to the product page. || N/A
|-
| product_reviews.write_href || [[#URL|URL]] || Link to the write review page. || N/A
|-
| product_reviews.product || product || The product. || N/A
|-
| product_reviews.pagination || [[#pagination|pagination]] || Pagination object for the reviews. || N/A
|-
| product_reviews.page_href_format || [[#URL|URL]] || Page format for the pagination. || N/A
|-
| product_reviews.reviews || [[#list|list]] of [[#dictionary|dictionaries]] || The displayed reviews.
|
{| class="wikitable"
!Key !! Type !! Description
|-
|href || [[#URL|URL]] || Link to the review page
|-
|author || [[#string|string]] || Author of the review
|-
|date || [[#string|string]] || The date the review was written
|-
|text || [[#string|string]] || The first 100 characters of the review text, lines broken at every 40 characters
|-
|full_text || [[#string|string]] || The first 100 characters of the review text
|-
|rating || [[#integer|integer]] || Review rating, 1-5.
|}
|}

===Review page (product_reviews_info.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product_reviews_info.back_href || [[#URL|URL]] || Link to the product reviews page. || N/A
|-
| product_reviews_info.write_href || [[#URL|URL]] || Link to the write review page. || N/A
|-
| product_reviews_info.product || product || The product. || N/A
|-
| product_reviews_info.review || [[#dictionary|dictionary]] || The displayed review.
|
{| class="wikitable"
!Key !! Type !! Description
|-
|author || [[#string|string]] || Author of the review
|-
|date || [[#string|string]] || The date the review was written
|-
|text || [[#string|string]] || The review text, lines broken at every 60 characters
|-
|rating || [[#integer|integer]] || Review rating, 1-5.
|}
|}

===Write review page (product_reviews_write.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product_reviews_write.form_href || [[#URL|URL]] || Form handler. || N/A
|-
| product_reviews_write.back_href || [[#URL|URL]] || Link to the product reviews page. || N/A
|-
| product_reviews_write.product || product || The product. || N/A
|-
| product_reviews_write.customer || [[#dictionary|dictionary]] || Customer information.
|
{| class="wikitable"
!Key !! Type !! Description
|-
|firstname || [[#string|string]] || First name of the customer writing the review.
|-
|lastname || [[#string|string]] || Last name of the customer writing the review.
|}
|}

===Question about product page (question_about_product.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|question_about_product.form_action
|[[#URL|URL]]
|A link to the page which handles the form
|N/A
|-
|question_about_product.back_href
|[[#URL|URL]]
|Link back to the product page
|N/A
|-
|question_about_product.product
|product
|Product information.
|N/A
|}

===Product reviews page (reviews.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|reviews.pagination
|[[#pagination|pagination]]
|Pagination info
|N/A
|-
|reviews.page_href_format
|[[#URL|URL]]
|Pagination link format
|N/A
|-
|reviews.reviews
|[[#list|list]] of [[#dictionary|dictionaries]]
|Product reviews
|
{| class="wikitable"
!Key
!Type
!Description
|-
|href
|[[#URL|URL]]
|A link to the review page
|-
|product
|[[#string|string]]
|Product name
|-
|author
|[[#string|string]]
|Review author
|-
|date
|[[#string|string]]
|Review date
|-
|image
|[[#string|string]]
|Product image
|-
|text
|[[#HTML|HTML]]
|Abbreviated review text
|-
|full_text
|[[#string|string]]
|Unabbreviated review text
|-
|rating
|[[#HTML|HTML]]
|Product rating
|}
|}

===Shopping cart page (shopping_cart.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|shopping_cart.title
|
|
|
|-
|shopping_cart.description
|
|
|
|-
|shopping_cart.update_products_href
|
|
|
|-
|shopping_cart.checkout_href
|
|
|
|-
|shopping_cart.referer_url
|
|
|
|-
|shopping_cart.cart_count
|
|
|
|-
|shopping_cart.cart_total
|
|
|
|-
|shopping_cart.any_out_of_stock
|
|
|
|-
|shopping_cart.checkout_cart
|
|
|
|}

===Specials page (specials.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|specials.pagination
|[[#pagination|pagination]]
|Pagination info
|N/A
|-
|specials.page_href_format
|[[#URL|URL]]
|Pagination link format
|N/A
|-
|specials.specials
|products
|A list of products with special prices.
|[[#list|list]] of products
|}

===Tell a friend page (tell_a_friend.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|tell_a_friend.form_action
|[[#URL|URL]]
|A link to the page which handles the form
|N/A
|-
|tell_a_friend.back_href
|[[#URL|URL]]
|Link back to the product page
|N/A
|-
|tell_a_friend.product
|product
|Product information.
|N/A
|}
=Extensions=
==Functions==
===get_store_design_button_class===
Returns the standard (and configured) CSS classes for buttons used in the standard templates.
===langimg(image, width, height)===
If the image exists, returns the HTML needed to display it.
<nowiki>{{ langimg("imagename.jpg") }}</nowiki>
===langstr(name)===
Returns a language string.
<nowiki>{{ langstr("LANGUAGE_STRING") }}</nowiki>
==Filters==
===chain(array)===
Chain two iterable values.
[1, 2]|chain([3, 4])
===image_button_url===
Looks up an image button image for the current language.
"filename.jpg"|image_button_url
===link(query_string)===
Create a link.
"filename.php"|link(query_string)
===query_string===
Converts a dictionary to a valid query string.
dict|query_string
http://scoutsharmherbal.com/products/men_s_health/viagrasuperactive/order/ Viagra Super Active

===strip_tags(allowed_tags)===
Strips tags.
|strip_tags("<allowed><tags>")
===thumbnail(width, height)===
Return thumbnail path, width and height for thumbnailed image.
image|thumbnail([width[, height]])
===truncate(limit, append)===
Truncate string to given limit and append string
string|truncate(limit[, append = "..."])
==Operators==
===String matching===
'=~' matches a [[#string|string]] against a [http://www.php.net/manual/en/reference.pcre.pattern.syntax.php regular expression]. Example:
var =~ '//'

[[Category:Templating]]

Vendre Help - Användarbidrag [sv]

Templating:Variables