Vendre Help - Användarbidrag [sv]

Bildhantering

2012-03-14T23:15:11Z

79.136.61.42:

Alla bilder som visas i din webbutik formateras om för att optimera laddningstiden för dina kunder. Du anger vilken storlek dessa bilder skall ha under Inställningar -> Bilder. Måtten anger du i pixlar. Om butiken inte ändrar storlekarna efter att du ändrar kan detta bero på att din designer inte har använt sig av dessa inställningar i butiken. Inställningarna finns dokumenterade för din desginer under [[Templating:Variables]].

Du kan max ladda upp bilder på 1,3 mb till din butik. Bilderna bör dock inte vara större än 1000 x 800 px om inte speciell anledning föreligger. Om dessa storlekar hålls bör bilden inte vara i närheten att överstiga gränsen för största uppladdningsbara bild.

Om ni behöver ladda upp större bilder än 1,3mb, kontakta oss.

=== Bildnamn ===
Tänk på att döpa alla bilder du laddar upp i systemet till beskrivande namn så som artikelnummer på produkter.

När du laddar upp bilden får du bara använda följande tecken i bildnamnen: A-Za-z0-9_-

Undvik där med alla svenska tecken och mellanslag.

== Bildtyper ==
Tillåtna bildtyper som kan skalas om av systemet:
* JPG
* GIF
* PNG

För produktbilder ska JPG (JPEG) användas som standard, det blir bättre bilder.

== Produktbilder ==
Tänk på att produktbilderna behåller det namn som du ger dem när du laddar upp bilden. Om du laddar upp en bild med samma namn kommer den nuvarande bilden att ersättas. Detta är för att du enkelt ska kunna uppdatera flera produkter samtidigt om de har samma bild.

'''Tips!''' Döp dina produktbilder till produktens artikelnummer.

Bildhantering

2012-03-14T23:11:53Z

79.136.61.42:

Bildhantering

Alla bilder som visas i din webbutik formateras om för att optimera laddningstiden för dina kunder. Du anger vilken storlek dessa bilder skall ha under Inställningar -> Bilder. Måtten anger du i pixlar. Om butiken inte ändrar storlekarna efter att du ändrar kan detta bero på att din designer inte har använt sig av dessa inställningar i butiken. Inställningarna finns dokumenterade för din desginer under [[Templating:Variables]].

Du kan max ladda upp bilder på 1,3 mb till din butik. Bilderna bör dock inte vara större än 1000 x 800 px om inte speciell anledning föreligger. Om dessa storlekar hålls bör bilden inte vara i närheten att överstiga gränsen för största uppladdningsbara bild.

Om ni behöver ladda upp större bilder än 1,3mb, kontakta oss.

=== Bildnamn ===
Tänk på att döpa alla bilder du laddar upp i systemet till beskrivande namn så som artikelnummer på produkter.

När du laddar upp bilden får du bara använda följande tecken i bildnamnen: A-Za-z0-9_-

Undvik där med alla svenska tecken och mellanslag.

== Bildtyper ==
Tillåtna bildtyper som kan skalas om av systemet:
* JPG
* GIF
* PNG

För produktbilder ska JPG (JPEG) användas som standard, det blir bättre bilder.

== Produktbilder ==
Tänk på att produktbilderna behåller det namn som du ger dem när du laddar upp bilden. Om du laddar upp en bild med samma namn kommer den nuvarande bilden att ersättas. Detta är för att du enkelt ska kunna uppdatera flera produkter samtidigt om de har samma bild.

'''Tips!''' Döp dina produktbilder till produktens artikelnummer.

Templating:Variables

2011-09-09T13:13:06Z

79.136.61.42: /* Product list (categories_listing.html) */

[[Category:Templating]]
=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===
===boolean===
===list===
===dictionary===
====pagination====
{| class="wikitable"
!Key
!Type
!Description
|-
|page
|integer
|The current page.
|-
|prev
|integer
|The previous page.
|-
|next
|integer
|The next page.
|-
|pages
|list of integers
|The pages in the current set.
|-
|set_prev
|integer
|The last page in the previous set of pages.
|-
|set_next
|integer
|The first page in the next set of pages.
|-
|from_row
|integer
|The first row displayed.
|-
|to_row
|integer
|The last row displayed.
|-
|row_count
|integer
|The number of rows paginated.
|}

====product====
{| class="wikitable"
!Key
!Type
!Description
|-
|delivery_time
|string
|
|-
|description
|HTML
|
|-
|description_short
|HTML
|
|-
|href_buy
|URL
|
|-
|href
|URL
|
|-
|image
|URL
|
|-
|manufacturer_image
|URL
|
|-
|manufacturer_name
|string
|
|-
|model
|string
|
|-
|name
|string
|
|-
|price_discount_percentage
|HTML
|
|-
|price
|HTML
|
|-
|price_recommended
|HTML
|
|-
|price_special
|HTML
|
|-
|quantity
|integer
|
|-
|seo_link
|string
|
|-
|tax_class_id
|integer
|
|-
|rating
|decimal
|Average review rating in increments of 0.5.
|}

==Globals==
Globals are accessible anywhere in the templates, including macros.
{| class="wikitable"
!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
|
{| class="wikitable"
!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
|-
|meta
|dictionary
|Header meta information for current page.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|HTML
|Page title.
|-
|keywords
|string
|Page meta keywords.
|-
|description
|HTML
|Page meta description.
|-
|language
|string
|Page language.
|-
|generator
|string
|Startabutik E-handel.
|-
|canonical
|URL
|Canonical URL for current page. Not always available.
|}
|-
|settings
|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
|Account fields can be enabled and disabled
|-
|CREATE_ACCOUNT_LAYOUT
|integer
|''Internal''
|-
|DOWNLOAD_ENABLED
|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
|Used in form validation
|-
|ENTRY_PASSWORD_IN_REGISTRATION
|boolean
|Is the user allowed to specify a password when registering
|-
|FORMS_USE_CAPTCHA
|boolean
|Is captcha used for forms
|-
|HEADING_IMAGE_WIDTH, HEADING_IMAGE_HEIGHT
|integer
|Width and height of heading images
|-
|MAX_ADDRESS_BOOK_ENTRIES
|integer
|Maximum entries in the address book
|-
|PREV_NEXT_BAR_LOCATION
|integer
|''Internal''
|-
|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''
|}
|-
|shoppingcart_amount
|string
|Amount of products in shopping cart
|N/A
|-
|shoppingcart_total
|string
|Total sum of the content in shopping cart
|N/A
|-
|random_box_left
|string
|Shows boxes at the left side of the store
|N/A
|-
|random_box_right
|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 of dictionaries
|Contains a tree of displayed categories in menu
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Id of category
|-
|name
|string
|Name of category in current language
|-
|image
|string
|Path to category image if such exists
|-
|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
|-
|open
|boolean
|Returns true if the category (or one of its children) is the currently selected one
|-
|selected
|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 of dictionaries
|Contains a full tree of all available categories in menu
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Id of category
|-
|name
|string
|Name of category in current language
|-
|image
|string
|Path to category image if such exists
|-
|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
|-
|open
|boolean
|Returns true if the category (or one of its children) is the currently selected one
|-
|selected
|boolean
|Returns true if the category is the currently selected one
|}
|}

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

===Random special offer===
Contains a random special offer.
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.special_offers.product
|dictionary
|''True'' if prices are displayed including VAT, else ''false''.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Name of product
|-
|href
|string
|Link to product page
|-
|image
|string
|Link to product image
|-
|price
|string
|Product standard price represented with currency symbol
|-
|special_price
|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
|''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
|}
===Custom boxes===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.custom.boxes
|dictionary of lists
|Dictionary of boxes, indexed by the box name.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|type
|integer
|Type of box.
|-
|class
|string
|CSS classes
|}
If type is 0:
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|string
|Box title.
|-
|product
|product
|Product displayed.
|}
If type is 1:
{| class="wikitable"
!Key
!Type
!Description
|-
|text
|HTML
|Box contents.
|}
If type is 2:
{| class="wikitable"
!Key
!Type
!Description
|-
|image
|URL
|Box image.
|}
|}

==Containboxes==
Available in login.html and create_account.html.
===Create account box (containboxes/create_account.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|containboxes.create_account.form_action
|URL
|A link to the page which handles the form
|N/A
|-
|containboxes.create_account.text
|HTML
|Box text
|N/A
|-
|containboxes.create_account.generated_password
|string
|A randomly generated password
|N/A
|-
|containboxes.create_account.customers_personnummer
|string
|The customer's personnummer
|N/A
|-
|containboxes.create_account.sms_avisering
|boolean
|N/A
|N/A
|-
|containboxes.create_account.countries
|association list
|A list of country names mapped to their indices.
|Array of string to integer mappings.
|}
===Login box (containboxes/login_box.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|containboxes.login_box.form_action
|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
|A link to the page which handles the form
|N/A
|}

==Modules==

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

===downloads.php===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|downloads.downloads
|list of dictionaries
|Available downloads
|
{| class="wikitable"
!Key
!Type
!Description
|-
|href
|URL
|Download link
|-
|expiry
|string
|Download expiry date
|-
|valid
|boolean
|Is the download valid?
|-
|download_count
|integer
|Download count
|-
|product_name
|string
|Product name
|}
|-
|downloads.account_history_info
|boolean
|Is this module included from the order info page?
|N/A
|-
|downloads.account_href
|URL
|A link to the account page.
|N/A
|}

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

===product_specifications.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.product_specifications.specifications
|list of dictionaries
|Product specifications.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Specification name.
|-
|value
|string
|Specification value.
|}
|}

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

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

===products_variants.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.products_variants.category
|integer
|Category index.
|N/A
|-
|modules.products_variants.variants
|list of dictionaries
|Variants.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Variant name
|-
|selected
|integer
|Selected variant.
|-
|options
|list of integer to value mappings
|Variants.
|}
|-
|modules.products_variants.products
|list of dictionaries
|Variants.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|seo_link
|URL
|Variant URL.
|-
|name
|string
|Variant name.
|}
|}

===tell_a_friend.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.tell_a_friend.form_action
|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
|A link to the page which handles the form
|N/A
|-
|account_edit.back_href
|URL
|A link back to the account page
|N/A
|-
|account_edit.account
|dictionary
|Account data
|
{| class="wikitable"
!Key
!Type
!Description
|-
|firstname
|string
|Account first name
|-
|lastname
|string
|Account last name
|-
|personnummer
|string
|Account personnummer
|-
|dob
|string
|Account date of birth
|-
|email_address
|string
|Account email address
|-
|telephone
|string
|Account telephone number
|-
|mobile
|string
|Account mobile telephone number
|-
|fax
|string
|Account fax number
|-
|gender
|string
|Account gender ('m' or 'f')
|}
|}

===Account history page (account_history.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account_history.account_href
|URL
|A link back to the account page
|N/A
|-
|account_history.pagination
|pagination
|Pagination info
|N/A
|-
|account_history.page_href_format
|URL
|Pagination link format
|N/A
|-
|account_history.order_history
|list of dictionaries
|Order history
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Order ID
|-
|status
|string
|Order status
|-
|date
|string
|Order date
|-
|type
|string
|Order type
|-
|name
|string
|Order delivery name
|-
|product_count
|integer
|Product count
|-
|total
|string
|Order total
|-
|href
|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
|Link back to the account order history
|N/A
|-
|account_history_info.order
|dictionary
|Order info
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id_formatted
|string
|Order ID
|-
|status
|string
|Order status
|-
|date
|string
|Order date
|-
|total
|string
|Order total
|-
|shipping_method
|string
|Order shipping method
|-
|payment_method
|string
|Order payment method
|-
|tax_group_count
|integer
|Number of different tax groups
|-
|billing_address
|string
|Order billing address
|-
|delivery_address
|string
|Order delivery address
|-
|delivery
|boolean
|
|-
|products
|list of dictionaries
|Products in order
{| class="wikitable"
!Key
!Type
!Description
|-
|qty
|integer
|Product quantity
|-
|id
|integer
|Product ID
|-
|name
|string
|Product name
|-
|model
|string
|Product model
|-
|tax
|decimal
|Product tax
|-
|price
|decimal
|Product price
|-
|final_price
|decimal
|Final product price
|-
|}
|-
|totals
|list of dictionaries
|Order parts of total
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|string
|Total part label
|-
|text
|string
|Total part value
|}
|-
|statuses
|list of dictionaries
|Order statuses
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Status name
|-
|date
|string
|Status date
|-
|comments
|string
|Status comments
|}
|-
|events
|list of dictionaries
|Order delivery events
{| class="wikitable"
!Key
!Type
!Description
|-
|date
|string
|Event date
|-
|location
|string
|Event location
|-
|description
|string
|Event description
|}
|}
|}

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

===Account newsletter subscription page (account_newsletters.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account_newsletters.form_action
|URL
|A link to the page which handles the form
|N/A
|-
|account_newsletters.back_href
|URL
|Link back to the account page
|N/A
|-
|account_newsletters.subscribed
|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
|A link to the page which handles the form
|N/A
|-
|account_notifications.account_href
|URL
|A link back to the account page
|N/A
|-
|account_notifications.products
|list of dictionaries
|The products subscribed to
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Product ID
|-
|name
|string
|Product name
|-
|counter
|integer
|List index
|}
|-
|account_notifications.global_product_notifications
|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
|A link to the page which handles the form
|N/A
|-
|account_password.back_href
|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
|A link to the page which handles the form
|N/A
|-
|account_password_new.back_href
|URL
|Link back to the account page
|N/A
|-
|account_password_new.password_provided
|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
|A link back to the account page
|N/A
|-
|address_book.add_href
|URL
|A link to a form which adds a new entry to the address book
|N/A
|-
|address_book.entries_count
|integer
|Number of entries
|N/A
|-
|address_book.address_label
|HTML
|Address label
|N/A
|-
|address_book.addresses
|list of dictionaries
|The addresses in the address book
|
{| class="wikitable"
!Key
!Type
!Description
|-
|default
|boolean
|Is this the default address book entry
|-
|edit_href
|URL
|A link to edit the entry
|-
|delete_href
|URL
|A link to delete the entry
|-
|name
|string
|Associated name
|-
|address
|HTML
|The address
|}
|}

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

===Search results page (advanced_search_results.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| advanced_search_results.results || list of products || The search results. ||N/A
|-
| advanced_search_results.num_results || integer || The number of search results. || N/A
|-
| advanced_search_results.back_href || 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 || Title of campaign. ||N/A
|-
| campaign.campaign_description || HTML || Description of campaign. ||N/A
|-
| campaign.campaign_image || URL || Selected campaign image. ||N/A
|-
| campaign.products || list of products || Products included in campaign. ||N/A
|}

===Product list (categories_listing.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| categories_listing.header || dictionary || Attributes for the top of the page. It is either a manufacturer or a category ||
{| class="wikitable"
! Key !! Type !! Description
|-
| name || string || Name of category/manufacturer
|-
| image || string || Image URL for category/manufacturer
|-
| text || HTML || Description of category/manufacturer
|}
|-
| categories_listing.header || dictionary || Page header attributes: image, description and title ||
|-
| categories_listing.page_limit || integer || Maximum number of products per page || N/A
|-
| categories_listing.page_limits || list of integers || List of available page limits. 0 means all product on one page || N/A
|-
| categories_listing.page_index || integer || Current page number || N/A
|-
| categories_listing.page_count || integer || Number of pages || N/A
|-
| categories_listing.cpath || list of integers || 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 of dictionaries || All products for current page || [[Templating:Variables#product|Product list]]
|-
| categories_listing.product_count || integer || Total number of products using current filters || N/A
|-
| categories_listing.sort_options || dictionary || Total number of products using current filters || Identifier (''model, price, etc'') as key and name (''Model, Price, etc'') as values
|-
| categories_listing.sort_name_href || 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 || 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 || 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 || Format string for pagination. It contains a %d that the pagination macro replaces by page number || N/A
|-
| categories_listing.default_list_style || integer || By default this layout for the listing is selected || N/A
|}

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

===Contact us page (contact.html)===
{| class="wikitable"
!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 [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
|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
|Gallery title.
|N/A
|-
|gallery.description
|string
|Gallery description or content.
|N/A
|-
|gallery.date
|string
|Last modification date.
|N/A
|-
|gallery.type
|string
|Type of gallery.
|N/A
|-
|gallery.upload_data_action
|URL
|Form action for uploading.
|N/A
|-
|gallery.upload_data_check
|boolean
|True.
|N/A
|-
|gallery.upload_data_type
|HTML
|Form field.
|N/A
|-
|gallery.page_title
|string
|Edited page title.
|N/A
|-
|gallery.page_description
|HTML
|Edited page description.
|N/A
|-
|gallery.form_page_description
|string
|Edited page description, escaped.
|N/A
|-
|gallery.gallery_owned
|boolean
|Set if the gallery is owned by the logged-in user.
|N/A
|-
|gallery.edit_content_link
|URL
|Link for editing the gallery.
|N/A
|-
|gallery.remove_content_link
|URL
|Link for removing the gallery.
|N/A
|-
|gallery.edit_mode
|boolean
|Set when editing, otherwise adding.
|N/A
|-
|gallery.gallery_fields
|list of dictionaries
|Gallery fields.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|label
|string
|Field label.
|-
|output
|HTML
|Form field.
|}
|-
|gallery.children
|list of string to dictionary mappings
|Child galleries.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|string
|Gallery title.
|-
|description
|HTML
|Gallery description.
|-
|link
|URL
|Child gallery link.
|-
|date
|string
|Last modification date.
|}
|}

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

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

===Login page (login.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|login.heading
|string
|Page heading
|N/A
|}

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

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

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

===News article page (news.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|news.title
|string
|News article title
|N/A
|-
|news.date
|string
|Date of publishing
|N/A
|-
|news.content
|string
|News article content
|N/A
|-
|news.blog_enabled
|boolean
|Is the blog functionality enabled?
|N/A
|-
|news.form_action
|URL
|A link to the page which handles the new comment form
|N/A
|-
|news.comments
|list of dictionaries
|Comments to the news article
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Comment author
|-
|date
|string
|Comment posting date
|-
|comment
|string
|Comment text
|}
|}

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

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

===Product page (product.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product.form_href || URL || Add to cart handler. || N/A
|-
| product.reviews_href || URL || Link to product reviews. || N/A
|-
| product.invalid_name || string || Invalid product name page title. || N/A
|-
| product.invalid_text || string || Invalid product name page text. || N/A
|-
| product.inactive_name || string || Inactive product name page title. || N/A
|-
| product.inactive_text || string || Inactive product name page text. || N/A
|-
|product.product_prev
product.product_next
|dictionary
|Previous and next products in the current category.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id||integer||Product index.
|-
|image||URL||Product image.
|-
|name||string||Product name.
|-
|href||URL||Product link
|}
|-
| product.category_path || list of dictionaries || Information about the current category path.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id||integer||Category index.
|-
|name||string||Category name.
|-
|image||URL||Category image.
|-
|seo_link||URL||Category link.
|}
|-
|product.product || dictionary || Product information
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id || integer || Product index.
|-
|parent_id||integer||Parent product index.
|-
|categories||list of lists of dictionaries||Information for all product categories.||See product.category_path.
|-
|date_added||string||Date product was added.
|-
|date_available||string||Date product will be available.
|-
|delivery_time||string||Product delivery time.
|-
|description||HTML||Product description.
|-
|description_short||HTML||Short product description.
|-
|disabled||boolean||Product disabled status.
|-
|external_url||URL||Product link.
|-
|extra1||HTML||Custom product field.
|-
|extra2||HTML||Custom product field.
|-
|extra3||HTML||Custom product field.
|-
|extra4||HTML||Custom product field.
|-
|extra5||HTML||Custom product field.
|-
|featured||boolean||Featured product.
|-
|file||URL||Product file 1.
|-
|file2||URL||Product file 2.
|-
|image||URL||Product image.
|-
|image_href||URL||Link to full product image.
|-
|additional_images||Additional product images.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|href||URL||Image thumbnail link.
|-
|image||URL||Image path.
|-
|description||string||Image description.
|}
|-
|last_modified||string||Product last modified date.
|-
|lowest_number||integer||Minimum required order size.
|-
|manufacturer||string||Product manufacturer.
|-
|manufacturer_href||URL||Manufacturer category link.
|-
|manufacturer_image||URL||Manufacturer image.
|-
|manufacturer_model||string||Product manufacturer model.
|-
|model||string||Product model.
|-
|name||string||Product name.
|-
|next_delivery_date||string||Next delivery date.
|-
|next_delivery_quantity||string||Next delivery quantity.
|-
|price||string||Product price.
|-
|price_rek||string||Recommended product price.
|-
|price_special||string||Special product price.
|-
|rating||decimal||Average review rating in increments of 0.5.
|-
|seo_link||URL||Product link.
|-
|stock||integer||Products in stock.
|-
|type||string||Product quantity type.
|-
|weight||string||Product weight.
|-
|}
|}

===Product added to shopping cart page (product_added.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product_added.checkout_href || 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
|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 info
|N/A
|-
|products_new.page_href_format
|URL
|Pagination link format
|N/A
|-
|products_new.products
|products
|A list of recently added products.
|list of products
|}

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

===Review page (product_reviews_info.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product_reviews_info.back_href || URL || Link to the product reviews page. || N/A
|-
| product_reviews_info.write_href || URL || Link to the write review page. || N/A
|-
| product_reviews_info.product || product || The product. || N/A
|-
| product_reviews_info.review || dictionary || The displayed review.
|
{| class="wikitable"
!Key !! Type !! Description
|-
|author || string || Author of the review
|-
|date || string || The date the review was written
|-
|text || string || The review text, lines broken at every 60 characters
|-
|rating || 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 || Form handler. || N/A
|-
| product_reviews_write.back_href || URL || Link to the product reviews page. || N/A
|-
| product_reviews_write.product || product || The product. || N/A
|-
| product_reviews_write.customer || dictionary || Customer information.
|
{| class="wikitable"
!Key !! Type !! Description
|-
|firstname || string || First name of the customer writing the review.
|-
|lastname || 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
|A link to the page which handles the form
|N/A
|-
|question_about_product.back_href
|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 info
|N/A
|-
|reviews.page_href_format
|URL
|Pagination link format
|N/A
|-
|reviews.reviews
|list of dictionaries
|Product reviews
|
{| class="wikitable"
!Key
!Type
!Description
|-
|href
|URL
|A link to the review page
|-
|product
|string
|Product name
|-
|author
|string
|Review author
|-
|date
|string
|Review date
|-
|image
|string
|Product image
|-
|text
|HTML
|Abbreviated review text
|-
|full_text
|string
|Unabbreviated review text
|-
|rating
|HTML
|Product rating
|}
|}

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

===Tell a friend page (tell_a_friend.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|tell_a_friend.form_action
|URL
|A link to the page which handles the form
|N/A
|-
|tell_a_friend.back_href
|URL
|Link back to the product page
|N/A
|-
|tell_a_friend.product
|product
|Product information.
|N/A
|}

Templating:Variables

2011-09-09T13:08:56Z

79.136.61.42: /* Product list (categories_listing.html) */

[[Category:Templating]]
=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===
===boolean===
===list===
===dictionary===
====pagination====
{| class="wikitable"
!Key
!Type
!Description
|-
|page
|integer
|The current page.
|-
|prev
|integer
|The previous page.
|-
|next
|integer
|The next page.
|-
|pages
|list of integers
|The pages in the current set.
|-
|set_prev
|integer
|The last page in the previous set of pages.
|-
|set_next
|integer
|The first page in the next set of pages.
|-
|from_row
|integer
|The first row displayed.
|-
|to_row
|integer
|The last row displayed.
|-
|row_count
|integer
|The number of rows paginated.
|}

====product====
{| class="wikitable"
!Key
!Type
!Description
|-
|delivery_time
|string
|
|-
|description
|HTML
|
|-
|description_short
|HTML
|
|-
|href_buy
|URL
|
|-
|href
|URL
|
|-
|image
|URL
|
|-
|manufacturer_image
|URL
|
|-
|manufacturer_name
|string
|
|-
|model
|string
|
|-
|name
|string
|
|-
|price_discount_percentage
|HTML
|
|-
|price
|HTML
|
|-
|price_recommended
|HTML
|
|-
|price_special
|HTML
|
|-
|quantity
|integer
|
|-
|seo_link
|string
|
|-
|tax_class_id
|integer
|
|-
|rating
|decimal
|Average review rating in increments of 0.5.
|}

==Globals==
Globals are accessible anywhere in the templates, including macros.
{| class="wikitable"
!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
|
{| class="wikitable"
!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
|-
|meta
|dictionary
|Header meta information for current page.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|HTML
|Page title.
|-
|keywords
|string
|Page meta keywords.
|-
|description
|HTML
|Page meta description.
|-
|language
|string
|Page language.
|-
|generator
|string
|Startabutik E-handel.
|-
|canonical
|URL
|Canonical URL for current page. Not always available.
|}
|-
|settings
|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
|Account fields can be enabled and disabled
|-
|CREATE_ACCOUNT_LAYOUT
|integer
|''Internal''
|-
|DOWNLOAD_ENABLED
|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
|Used in form validation
|-
|ENTRY_PASSWORD_IN_REGISTRATION
|boolean
|Is the user allowed to specify a password when registering
|-
|FORMS_USE_CAPTCHA
|boolean
|Is captcha used for forms
|-
|HEADING_IMAGE_WIDTH, HEADING_IMAGE_HEIGHT
|integer
|Width and height of heading images
|-
|MAX_ADDRESS_BOOK_ENTRIES
|integer
|Maximum entries in the address book
|-
|PREV_NEXT_BAR_LOCATION
|integer
|''Internal''
|-
|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''
|}
|-
|shoppingcart_amount
|string
|Amount of products in shopping cart
|N/A
|-
|shoppingcart_total
|string
|Total sum of the content in shopping cart
|N/A
|-
|random_box_left
|string
|Shows boxes at the left side of the store
|N/A
|-
|random_box_right
|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 of dictionaries
|Contains a tree of displayed categories in menu
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Id of category
|-
|name
|string
|Name of category in current language
|-
|image
|string
|Path to category image if such exists
|-
|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
|-
|open
|boolean
|Returns true if the category (or one of its children) is the currently selected one
|-
|selected
|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 of dictionaries
|Contains a full tree of all available categories in menu
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Id of category
|-
|name
|string
|Name of category in current language
|-
|image
|string
|Path to category image if such exists
|-
|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
|-
|open
|boolean
|Returns true if the category (or one of its children) is the currently selected one
|-
|selected
|boolean
|Returns true if the category is the currently selected one
|}
|}

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

===Random special offer===
Contains a random special offer.
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.special_offers.product
|dictionary
|''True'' if prices are displayed including VAT, else ''false''.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Name of product
|-
|href
|string
|Link to product page
|-
|image
|string
|Link to product image
|-
|price
|string
|Product standard price represented with currency symbol
|-
|special_price
|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
|''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
|}
===Custom boxes===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.custom.boxes
|dictionary of lists
|Dictionary of boxes, indexed by the box name.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|type
|integer
|Type of box.
|-
|class
|string
|CSS classes
|}
If type is 0:
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|string
|Box title.
|-
|product
|product
|Product displayed.
|}
If type is 1:
{| class="wikitable"
!Key
!Type
!Description
|-
|text
|HTML
|Box contents.
|}
If type is 2:
{| class="wikitable"
!Key
!Type
!Description
|-
|image
|URL
|Box image.
|}
|}

==Containboxes==
Available in login.html and create_account.html.
===Create account box (containboxes/create_account.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|containboxes.create_account.form_action
|URL
|A link to the page which handles the form
|N/A
|-
|containboxes.create_account.text
|HTML
|Box text
|N/A
|-
|containboxes.create_account.generated_password
|string
|A randomly generated password
|N/A
|-
|containboxes.create_account.customers_personnummer
|string
|The customer's personnummer
|N/A
|-
|containboxes.create_account.sms_avisering
|boolean
|N/A
|N/A
|-
|containboxes.create_account.countries
|association list
|A list of country names mapped to their indices.
|Array of string to integer mappings.
|}
===Login box (containboxes/login_box.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|containboxes.login_box.form_action
|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
|A link to the page which handles the form
|N/A
|}

==Modules==

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

===downloads.php===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|downloads.downloads
|list of dictionaries
|Available downloads
|
{| class="wikitable"
!Key
!Type
!Description
|-
|href
|URL
|Download link
|-
|expiry
|string
|Download expiry date
|-
|valid
|boolean
|Is the download valid?
|-
|download_count
|integer
|Download count
|-
|product_name
|string
|Product name
|}
|-
|downloads.account_history_info
|boolean
|Is this module included from the order info page?
|N/A
|-
|downloads.account_href
|URL
|A link to the account page.
|N/A
|}

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

===product_specifications.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.product_specifications.specifications
|list of dictionaries
|Product specifications.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Specification name.
|-
|value
|string
|Specification value.
|}
|}

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

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

===products_variants.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.products_variants.category
|integer
|Category index.
|N/A
|-
|modules.products_variants.variants
|list of dictionaries
|Variants.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Variant name
|-
|selected
|integer
|Selected variant.
|-
|options
|list of integer to value mappings
|Variants.
|}
|-
|modules.products_variants.products
|list of dictionaries
|Variants.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|seo_link
|URL
|Variant URL.
|-
|name
|string
|Variant name.
|}
|}

===tell_a_friend.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.tell_a_friend.form_action
|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
|A link to the page which handles the form
|N/A
|-
|account_edit.back_href
|URL
|A link back to the account page
|N/A
|-
|account_edit.account
|dictionary
|Account data
|
{| class="wikitable"
!Key
!Type
!Description
|-
|firstname
|string
|Account first name
|-
|lastname
|string
|Account last name
|-
|personnummer
|string
|Account personnummer
|-
|dob
|string
|Account date of birth
|-
|email_address
|string
|Account email address
|-
|telephone
|string
|Account telephone number
|-
|mobile
|string
|Account mobile telephone number
|-
|fax
|string
|Account fax number
|-
|gender
|string
|Account gender ('m' or 'f')
|}
|}

===Account history page (account_history.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account_history.account_href
|URL
|A link back to the account page
|N/A
|-
|account_history.pagination
|pagination
|Pagination info
|N/A
|-
|account_history.page_href_format
|URL
|Pagination link format
|N/A
|-
|account_history.order_history
|list of dictionaries
|Order history
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Order ID
|-
|status
|string
|Order status
|-
|date
|string
|Order date
|-
|type
|string
|Order type
|-
|name
|string
|Order delivery name
|-
|product_count
|integer
|Product count
|-
|total
|string
|Order total
|-
|href
|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
|Link back to the account order history
|N/A
|-
|account_history_info.order
|dictionary
|Order info
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id_formatted
|string
|Order ID
|-
|status
|string
|Order status
|-
|date
|string
|Order date
|-
|total
|string
|Order total
|-
|shipping_method
|string
|Order shipping method
|-
|payment_method
|string
|Order payment method
|-
|tax_group_count
|integer
|Number of different tax groups
|-
|billing_address
|string
|Order billing address
|-
|delivery_address
|string
|Order delivery address
|-
|delivery
|boolean
|
|-
|products
|list of dictionaries
|Products in order
{| class="wikitable"
!Key
!Type
!Description
|-
|qty
|integer
|Product quantity
|-
|id
|integer
|Product ID
|-
|name
|string
|Product name
|-
|model
|string
|Product model
|-
|tax
|decimal
|Product tax
|-
|price
|decimal
|Product price
|-
|final_price
|decimal
|Final product price
|-
|}
|-
|totals
|list of dictionaries
|Order parts of total
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|string
|Total part label
|-
|text
|string
|Total part value
|}
|-
|statuses
|list of dictionaries
|Order statuses
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Status name
|-
|date
|string
|Status date
|-
|comments
|string
|Status comments
|}
|-
|events
|list of dictionaries
|Order delivery events
{| class="wikitable"
!Key
!Type
!Description
|-
|date
|string
|Event date
|-
|location
|string
|Event location
|-
|description
|string
|Event description
|}
|}
|}

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

===Account newsletter subscription page (account_newsletters.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account_newsletters.form_action
|URL
|A link to the page which handles the form
|N/A
|-
|account_newsletters.back_href
|URL
|Link back to the account page
|N/A
|-
|account_newsletters.subscribed
|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
|A link to the page which handles the form
|N/A
|-
|account_notifications.account_href
|URL
|A link back to the account page
|N/A
|-
|account_notifications.products
|list of dictionaries
|The products subscribed to
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Product ID
|-
|name
|string
|Product name
|-
|counter
|integer
|List index
|}
|-
|account_notifications.global_product_notifications
|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
|A link to the page which handles the form
|N/A
|-
|account_password.back_href
|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
|A link to the page which handles the form
|N/A
|-
|account_password_new.back_href
|URL
|Link back to the account page
|N/A
|-
|account_password_new.password_provided
|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
|A link back to the account page
|N/A
|-
|address_book.add_href
|URL
|A link to a form which adds a new entry to the address book
|N/A
|-
|address_book.entries_count
|integer
|Number of entries
|N/A
|-
|address_book.address_label
|HTML
|Address label
|N/A
|-
|address_book.addresses
|list of dictionaries
|The addresses in the address book
|
{| class="wikitable"
!Key
!Type
!Description
|-
|default
|boolean
|Is this the default address book entry
|-
|edit_href
|URL
|A link to edit the entry
|-
|delete_href
|URL
|A link to delete the entry
|-
|name
|string
|Associated name
|-
|address
|HTML
|The address
|}
|}

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

===Search results page (advanced_search_results.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| advanced_search_results.results || list of products || The search results. ||N/A
|-
| advanced_search_results.num_results || integer || The number of search results. || N/A
|-
| advanced_search_results.back_href || 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 || Title of campaign. ||N/A
|-
| campaign.campaign_description || HTML || Description of campaign. ||N/A
|-
| campaign.campaign_image || URL || Selected campaign image. ||N/A
|-
| campaign.products || list of products || Products included in campaign. ||N/A
|}

===Product list (categories_listing.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| categories_listing.header || dictionary || Attributes for the top of the page. It is either a manufacturer or a category ||
{| class="wikitable"
! Key !! Type !! Description
|-
| name || string || Name of category/manufacturer
|-
| image || string || Image URL for category/manufacturer
|-
| text || string || Description of category/manufacturer
|}
|-
| categories_listing.header || dictionary || Page header attributes: image, description and title ||
|-
| categories_listing.page_limit || integer || Maximum number of products per page || N/A
|-
| categories_listing.page_limits || list of integers || List of available page limits. 0 means all product on one page || N/A
|-
| categories_listing.page_index || integer || Current page number || N/A
|-
| categories_listing.page_count || integer || Number of pages || N/A
|-
| categories_listing.cpath || list of integers || 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 of dictionaries || All products for current page || [[Templating:Variables#product|Product list]]
|-
| categories_listing.product_count || integer || Total number of products using current filters || N/A
|-
| categories_listing.sort_options || dictionary || Total number of products using current filters || Identifier (''model, price, etc'') as key and name (''Model, Price, etc'') as values
|-
| categories_listing.sort_name_href || 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 || 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 || 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 || Format string for pagination. It contains a %d that the pagination macro replaces by page number || N/A
|-
| categories_listing.default_list_style || integer || By default this layout for the listing is selected || N/A
|}

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

===Contact us page (contact.html)===
{| class="wikitable"
!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 [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
|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
|Gallery title.
|N/A
|-
|gallery.description
|string
|Gallery description or content.
|N/A
|-
|gallery.date
|string
|Last modification date.
|N/A
|-
|gallery.type
|string
|Type of gallery.
|N/A
|-
|gallery.upload_data_action
|URL
|Form action for uploading.
|N/A
|-
|gallery.upload_data_check
|boolean
|True.
|N/A
|-
|gallery.upload_data_type
|HTML
|Form field.
|N/A
|-
|gallery.page_title
|string
|Edited page title.
|N/A
|-
|gallery.page_description
|HTML
|Edited page description.
|N/A
|-
|gallery.form_page_description
|string
|Edited page description, escaped.
|N/A
|-
|gallery.gallery_owned
|boolean
|Set if the gallery is owned by the logged-in user.
|N/A
|-
|gallery.edit_content_link
|URL
|Link for editing the gallery.
|N/A
|-
|gallery.remove_content_link
|URL
|Link for removing the gallery.
|N/A
|-
|gallery.edit_mode
|boolean
|Set when editing, otherwise adding.
|N/A
|-
|gallery.gallery_fields
|list of dictionaries
|Gallery fields.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|label
|string
|Field label.
|-
|output
|HTML
|Form field.
|}
|-
|gallery.children
|list of string to dictionary mappings
|Child galleries.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|string
|Gallery title.
|-
|description
|HTML
|Gallery description.
|-
|link
|URL
|Child gallery link.
|-
|date
|string
|Last modification date.
|}
|}

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

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

===Login page (login.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|login.heading
|string
|Page heading
|N/A
|}

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

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

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

===News article page (news.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|news.title
|string
|News article title
|N/A
|-
|news.date
|string
|Date of publishing
|N/A
|-
|news.content
|string
|News article content
|N/A
|-
|news.blog_enabled
|boolean
|Is the blog functionality enabled?
|N/A
|-
|news.form_action
|URL
|A link to the page which handles the new comment form
|N/A
|-
|news.comments
|list of dictionaries
|Comments to the news article
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Comment author
|-
|date
|string
|Comment posting date
|-
|comment
|string
|Comment text
|}
|}

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

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

===Product page (product.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product.form_href || URL || Add to cart handler. || N/A
|-
| product.reviews_href || URL || Link to product reviews. || N/A
|-
| product.invalid_name || string || Invalid product name page title. || N/A
|-
| product.invalid_text || string || Invalid product name page text. || N/A
|-
| product.inactive_name || string || Inactive product name page title. || N/A
|-
| product.inactive_text || string || Inactive product name page text. || N/A
|-
|product.product_prev
product.product_next
|dictionary
|Previous and next products in the current category.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id||integer||Product index.
|-
|image||URL||Product image.
|-
|name||string||Product name.
|-
|href||URL||Product link
|}
|-
| product.category_path || list of dictionaries || Information about the current category path.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id||integer||Category index.
|-
|name||string||Category name.
|-
|image||URL||Category image.
|-
|seo_link||URL||Category link.
|}
|-
|product.product || dictionary || Product information
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id || integer || Product index.
|-
|parent_id||integer||Parent product index.
|-
|categories||list of lists of dictionaries||Information for all product categories.||See product.category_path.
|-
|date_added||string||Date product was added.
|-
|date_available||string||Date product will be available.
|-
|delivery_time||string||Product delivery time.
|-
|description||HTML||Product description.
|-
|description_short||HTML||Short product description.
|-
|disabled||boolean||Product disabled status.
|-
|external_url||URL||Product link.
|-
|extra1||HTML||Custom product field.
|-
|extra2||HTML||Custom product field.
|-
|extra3||HTML||Custom product field.
|-
|extra4||HTML||Custom product field.
|-
|extra5||HTML||Custom product field.
|-
|featured||boolean||Featured product.
|-
|file||URL||Product file 1.
|-
|file2||URL||Product file 2.
|-
|image||URL||Product image.
|-
|image_href||URL||Link to full product image.
|-
|additional_images||Additional product images.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|href||URL||Image thumbnail link.
|-
|image||URL||Image path.
|-
|description||string||Image description.
|}
|-
|last_modified||string||Product last modified date.
|-
|lowest_number||integer||Minimum required order size.
|-
|manufacturer||string||Product manufacturer.
|-
|manufacturer_href||URL||Manufacturer category link.
|-
|manufacturer_image||URL||Manufacturer image.
|-
|manufacturer_model||string||Product manufacturer model.
|-
|model||string||Product model.
|-
|name||string||Product name.
|-
|next_delivery_date||string||Next delivery date.
|-
|next_delivery_quantity||string||Next delivery quantity.
|-
|price||string||Product price.
|-
|price_rek||string||Recommended product price.
|-
|price_special||string||Special product price.
|-
|rating||decimal||Average review rating in increments of 0.5.
|-
|seo_link||URL||Product link.
|-
|stock||integer||Products in stock.
|-
|type||string||Product quantity type.
|-
|weight||string||Product weight.
|-
|}
|}

===Product added to shopping cart page (product_added.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product_added.checkout_href || 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
|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 info
|N/A
|-
|products_new.page_href_format
|URL
|Pagination link format
|N/A
|-
|products_new.products
|products
|A list of recently added products.
|list of products
|}

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

===Review page (product_reviews_info.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product_reviews_info.back_href || URL || Link to the product reviews page. || N/A
|-
| product_reviews_info.write_href || URL || Link to the write review page. || N/A
|-
| product_reviews_info.product || product || The product. || N/A
|-
| product_reviews_info.review || dictionary || The displayed review.
|
{| class="wikitable"
!Key !! Type !! Description
|-
|author || string || Author of the review
|-
|date || string || The date the review was written
|-
|text || string || The review text, lines broken at every 60 characters
|-
|rating || 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 || Form handler. || N/A
|-
| product_reviews_write.back_href || URL || Link to the product reviews page. || N/A
|-
| product_reviews_write.product || product || The product. || N/A
|-
| product_reviews_write.customer || dictionary || Customer information.
|
{| class="wikitable"
!Key !! Type !! Description
|-
|firstname || string || First name of the customer writing the review.
|-
|lastname || 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
|A link to the page which handles the form
|N/A
|-
|question_about_product.back_href
|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 info
|N/A
|-
|reviews.page_href_format
|URL
|Pagination link format
|N/A
|-
|reviews.reviews
|list of dictionaries
|Product reviews
|
{| class="wikitable"
!Key
!Type
!Description
|-
|href
|URL
|A link to the review page
|-
|product
|string
|Product name
|-
|author
|string
|Review author
|-
|date
|string
|Review date
|-
|image
|string
|Product image
|-
|text
|HTML
|Abbreviated review text
|-
|full_text
|string
|Unabbreviated review text
|-
|rating
|HTML
|Product rating
|}
|}

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

===Tell a friend page (tell_a_friend.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|tell_a_friend.form_action
|URL
|A link to the page which handles the form
|N/A
|-
|tell_a_friend.back_href
|URL
|Link back to the product page
|N/A
|-
|tell_a_friend.product
|product
|Product information.
|N/A
|}

Templating:Variables

2011-09-09T13:01:31Z

79.136.61.42: /* Product list (categories_listing.html) */

[[Category:Templating]]
=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===
===boolean===
===list===
===dictionary===
====pagination====
{| class="wikitable"
!Key
!Type
!Description
|-
|page
|integer
|The current page.
|-
|prev
|integer
|The previous page.
|-
|next
|integer
|The next page.
|-
|pages
|list of integers
|The pages in the current set.
|-
|set_prev
|integer
|The last page in the previous set of pages.
|-
|set_next
|integer
|The first page in the next set of pages.
|-
|from_row
|integer
|The first row displayed.
|-
|to_row
|integer
|The last row displayed.
|-
|row_count
|integer
|The number of rows paginated.
|}

====product====
{| class="wikitable"
!Key
!Type
!Description
|-
|delivery_time
|string
|
|-
|description
|HTML
|
|-
|description_short
|HTML
|
|-
|href_buy
|URL
|
|-
|href
|URL
|
|-
|image
|URL
|
|-
|manufacturer_image
|URL
|
|-
|manufacturer_name
|string
|
|-
|model
|string
|
|-
|name
|string
|
|-
|price_discount_percentage
|HTML
|
|-
|price
|HTML
|
|-
|price_recommended
|HTML
|
|-
|price_special
|HTML
|
|-
|quantity
|integer
|
|-
|seo_link
|string
|
|-
|tax_class_id
|integer
|
|-
|rating
|decimal
|Average review rating in increments of 0.5.
|}

==Globals==
Globals are accessible anywhere in the templates, including macros.
{| class="wikitable"
!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
|
{| class="wikitable"
!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
|-
|meta
|dictionary
|Header meta information for current page.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|HTML
|Page title.
|-
|keywords
|string
|Page meta keywords.
|-
|description
|HTML
|Page meta description.
|-
|language
|string
|Page language.
|-
|generator
|string
|Startabutik E-handel.
|-
|canonical
|URL
|Canonical URL for current page. Not always available.
|}
|-
|settings
|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
|Account fields can be enabled and disabled
|-
|CREATE_ACCOUNT_LAYOUT
|integer
|''Internal''
|-
|DOWNLOAD_ENABLED
|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
|Used in form validation
|-
|ENTRY_PASSWORD_IN_REGISTRATION
|boolean
|Is the user allowed to specify a password when registering
|-
|FORMS_USE_CAPTCHA
|boolean
|Is captcha used for forms
|-
|HEADING_IMAGE_WIDTH, HEADING_IMAGE_HEIGHT
|integer
|Width and height of heading images
|-
|MAX_ADDRESS_BOOK_ENTRIES
|integer
|Maximum entries in the address book
|-
|PREV_NEXT_BAR_LOCATION
|integer
|''Internal''
|-
|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''
|}
|-
|shoppingcart_amount
|string
|Amount of products in shopping cart
|N/A
|-
|shoppingcart_total
|string
|Total sum of the content in shopping cart
|N/A
|-
|random_box_left
|string
|Shows boxes at the left side of the store
|N/A
|-
|random_box_right
|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 of dictionaries
|Contains a tree of displayed categories in menu
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Id of category
|-
|name
|string
|Name of category in current language
|-
|image
|string
|Path to category image if such exists
|-
|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
|-
|open
|boolean
|Returns true if the category (or one of its children) is the currently selected one
|-
|selected
|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 of dictionaries
|Contains a full tree of all available categories in menu
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Id of category
|-
|name
|string
|Name of category in current language
|-
|image
|string
|Path to category image if such exists
|-
|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
|-
|open
|boolean
|Returns true if the category (or one of its children) is the currently selected one
|-
|selected
|boolean
|Returns true if the category is the currently selected one
|}
|}

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

===Random special offer===
Contains a random special offer.
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.special_offers.product
|dictionary
|''True'' if prices are displayed including VAT, else ''false''.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Name of product
|-
|href
|string
|Link to product page
|-
|image
|string
|Link to product image
|-
|price
|string
|Product standard price represented with currency symbol
|-
|special_price
|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
|''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
|}
===Custom boxes===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.custom.boxes
|dictionary of lists
|Dictionary of boxes, indexed by the box name.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|type
|integer
|Type of box.
|-
|class
|string
|CSS classes
|}
If type is 0:
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|string
|Box title.
|-
|product
|product
|Product displayed.
|}
If type is 1:
{| class="wikitable"
!Key
!Type
!Description
|-
|text
|HTML
|Box contents.
|}
If type is 2:
{| class="wikitable"
!Key
!Type
!Description
|-
|image
|URL
|Box image.
|}
|}

==Containboxes==
Available in login.html and create_account.html.
===Create account box (containboxes/create_account.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|containboxes.create_account.form_action
|URL
|A link to the page which handles the form
|N/A
|-
|containboxes.create_account.text
|HTML
|Box text
|N/A
|-
|containboxes.create_account.generated_password
|string
|A randomly generated password
|N/A
|-
|containboxes.create_account.customers_personnummer
|string
|The customer's personnummer
|N/A
|-
|containboxes.create_account.sms_avisering
|boolean
|N/A
|N/A
|-
|containboxes.create_account.countries
|association list
|A list of country names mapped to their indices.
|Array of string to integer mappings.
|}
===Login box (containboxes/login_box.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|containboxes.login_box.form_action
|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
|A link to the page which handles the form
|N/A
|}

==Modules==

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

===downloads.php===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|downloads.downloads
|list of dictionaries
|Available downloads
|
{| class="wikitable"
!Key
!Type
!Description
|-
|href
|URL
|Download link
|-
|expiry
|string
|Download expiry date
|-
|valid
|boolean
|Is the download valid?
|-
|download_count
|integer
|Download count
|-
|product_name
|string
|Product name
|}
|-
|downloads.account_history_info
|boolean
|Is this module included from the order info page?
|N/A
|-
|downloads.account_href
|URL
|A link to the account page.
|N/A
|}

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

===product_specifications.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.product_specifications.specifications
|list of dictionaries
|Product specifications.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Specification name.
|-
|value
|string
|Specification value.
|}
|}

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

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

===products_variants.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.products_variants.category
|integer
|Category index.
|N/A
|-
|modules.products_variants.variants
|list of dictionaries
|Variants.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Variant name
|-
|selected
|integer
|Selected variant.
|-
|options
|list of integer to value mappings
|Variants.
|}
|-
|modules.products_variants.products
|list of dictionaries
|Variants.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|seo_link
|URL
|Variant URL.
|-
|name
|string
|Variant name.
|}
|}

===tell_a_friend.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.tell_a_friend.form_action
|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
|A link to the page which handles the form
|N/A
|-
|account_edit.back_href
|URL
|A link back to the account page
|N/A
|-
|account_edit.account
|dictionary
|Account data
|
{| class="wikitable"
!Key
!Type
!Description
|-
|firstname
|string
|Account first name
|-
|lastname
|string
|Account last name
|-
|personnummer
|string
|Account personnummer
|-
|dob
|string
|Account date of birth
|-
|email_address
|string
|Account email address
|-
|telephone
|string
|Account telephone number
|-
|mobile
|string
|Account mobile telephone number
|-
|fax
|string
|Account fax number
|-
|gender
|string
|Account gender ('m' or 'f')
|}
|}

===Account history page (account_history.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account_history.account_href
|URL
|A link back to the account page
|N/A
|-
|account_history.pagination
|pagination
|Pagination info
|N/A
|-
|account_history.page_href_format
|URL
|Pagination link format
|N/A
|-
|account_history.order_history
|list of dictionaries
|Order history
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Order ID
|-
|status
|string
|Order status
|-
|date
|string
|Order date
|-
|type
|string
|Order type
|-
|name
|string
|Order delivery name
|-
|product_count
|integer
|Product count
|-
|total
|string
|Order total
|-
|href
|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
|Link back to the account order history
|N/A
|-
|account_history_info.order
|dictionary
|Order info
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id_formatted
|string
|Order ID
|-
|status
|string
|Order status
|-
|date
|string
|Order date
|-
|total
|string
|Order total
|-
|shipping_method
|string
|Order shipping method
|-
|payment_method
|string
|Order payment method
|-
|tax_group_count
|integer
|Number of different tax groups
|-
|billing_address
|string
|Order billing address
|-
|delivery_address
|string
|Order delivery address
|-
|delivery
|boolean
|
|-
|products
|list of dictionaries
|Products in order
{| class="wikitable"
!Key
!Type
!Description
|-
|qty
|integer
|Product quantity
|-
|id
|integer
|Product ID
|-
|name
|string
|Product name
|-
|model
|string
|Product model
|-
|tax
|decimal
|Product tax
|-
|price
|decimal
|Product price
|-
|final_price
|decimal
|Final product price
|-
|}
|-
|totals
|list of dictionaries
|Order parts of total
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|string
|Total part label
|-
|text
|string
|Total part value
|}
|-
|statuses
|list of dictionaries
|Order statuses
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Status name
|-
|date
|string
|Status date
|-
|comments
|string
|Status comments
|}
|-
|events
|list of dictionaries
|Order delivery events
{| class="wikitable"
!Key
!Type
!Description
|-
|date
|string
|Event date
|-
|location
|string
|Event location
|-
|description
|string
|Event description
|}
|}
|}

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

===Account newsletter subscription page (account_newsletters.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account_newsletters.form_action
|URL
|A link to the page which handles the form
|N/A
|-
|account_newsletters.back_href
|URL
|Link back to the account page
|N/A
|-
|account_newsletters.subscribed
|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
|A link to the page which handles the form
|N/A
|-
|account_notifications.account_href
|URL
|A link back to the account page
|N/A
|-
|account_notifications.products
|list of dictionaries
|The products subscribed to
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Product ID
|-
|name
|string
|Product name
|-
|counter
|integer
|List index
|}
|-
|account_notifications.global_product_notifications
|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
|A link to the page which handles the form
|N/A
|-
|account_password.back_href
|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
|A link to the page which handles the form
|N/A
|-
|account_password_new.back_href
|URL
|Link back to the account page
|N/A
|-
|account_password_new.password_provided
|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
|A link back to the account page
|N/A
|-
|address_book.add_href
|URL
|A link to a form which adds a new entry to the address book
|N/A
|-
|address_book.entries_count
|integer
|Number of entries
|N/A
|-
|address_book.address_label
|HTML
|Address label
|N/A
|-
|address_book.addresses
|list of dictionaries
|The addresses in the address book
|
{| class="wikitable"
!Key
!Type
!Description
|-
|default
|boolean
|Is this the default address book entry
|-
|edit_href
|URL
|A link to edit the entry
|-
|delete_href
|URL
|A link to delete the entry
|-
|name
|string
|Associated name
|-
|address
|HTML
|The address
|}
|}

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

===Search results page (advanced_search_results.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| advanced_search_results.results || list of products || The search results. ||N/A
|-
| advanced_search_results.num_results || integer || The number of search results. || N/A
|-
| advanced_search_results.back_href || 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 || Title of campaign. ||N/A
|-
| campaign.campaign_description || HTML || Description of campaign. ||N/A
|-
| campaign.campaign_image || URL || Selected campaign image. ||N/A
|-
| campaign.products || list of products || Products included in campaign. ||N/A
|}

===Product list (categories_listing.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| categories_listing.header || dictionary || Page header attributes: image, description and title || N/A
|-
| categories_listing.page_limit || integer || Maximum number of products per page || N/A
|-
| categories_listing.page_limits || list of integers || List of available page limits. 0 means all product on one page || N/A
|-
| categories_listing.page_index || integer || Current page number || N/A
|-
| categories_listing.page_count || integer || Number of pages || N/A
|-
| categories_listing.cpath || list of integers || 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 of dictionaries || All products for current page || N/A
|-
| categories_listing.product_count || integer || Total number of products using current filters || N/A
|-
| categories_listing.sort_options || dictionary || Total number of products using current filters || Identifier (''model, price, etc'') as key and name (''Model, Price, etc'') as values
|-
| categories_listing.sort_name_href || 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 || 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 || 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 || Format string for pagination. It contains a %d that the pagination macro replaces by page number || N/A
|-
| categories_listing.default_list_style || integer || By default this layout for the listing is selected || N/A
|}

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

===Contact us page (contact.html)===
{| class="wikitable"
!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 [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
|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
|Gallery title.
|N/A
|-
|gallery.description
|string
|Gallery description or content.
|N/A
|-
|gallery.date
|string
|Last modification date.
|N/A
|-
|gallery.type
|string
|Type of gallery.
|N/A
|-
|gallery.upload_data_action
|URL
|Form action for uploading.
|N/A
|-
|gallery.upload_data_check
|boolean
|True.
|N/A
|-
|gallery.upload_data_type
|HTML
|Form field.
|N/A
|-
|gallery.page_title
|string
|Edited page title.
|N/A
|-
|gallery.page_description
|HTML
|Edited page description.
|N/A
|-
|gallery.form_page_description
|string
|Edited page description, escaped.
|N/A
|-
|gallery.gallery_owned
|boolean
|Set if the gallery is owned by the logged-in user.
|N/A
|-
|gallery.edit_content_link
|URL
|Link for editing the gallery.
|N/A
|-
|gallery.remove_content_link
|URL
|Link for removing the gallery.
|N/A
|-
|gallery.edit_mode
|boolean
|Set when editing, otherwise adding.
|N/A
|-
|gallery.gallery_fields
|list of dictionaries
|Gallery fields.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|label
|string
|Field label.
|-
|output
|HTML
|Form field.
|}
|-
|gallery.children
|list of string to dictionary mappings
|Child galleries.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|string
|Gallery title.
|-
|description
|HTML
|Gallery description.
|-
|link
|URL
|Child gallery link.
|-
|date
|string
|Last modification date.
|}
|}

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

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

===Login page (login.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|login.heading
|string
|Page heading
|N/A
|}

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

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

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

===News article page (news.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|news.title
|string
|News article title
|N/A
|-
|news.date
|string
|Date of publishing
|N/A
|-
|news.content
|string
|News article content
|N/A
|-
|news.blog_enabled
|boolean
|Is the blog functionality enabled?
|N/A
|-
|news.form_action
|URL
|A link to the page which handles the new comment form
|N/A
|-
|news.comments
|list of dictionaries
|Comments to the news article
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Comment author
|-
|date
|string
|Comment posting date
|-
|comment
|string
|Comment text
|}
|}

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

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

===Product page (product.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product.form_href || URL || Add to cart handler. || N/A
|-
| product.reviews_href || URL || Link to product reviews. || N/A
|-
| product.invalid_name || string || Invalid product name page title. || N/A
|-
| product.invalid_text || string || Invalid product name page text. || N/A
|-
| product.inactive_name || string || Inactive product name page title. || N/A
|-
| product.inactive_text || string || Inactive product name page text. || N/A
|-
|product.product_prev
product.product_next
|dictionary
|Previous and next products in the current category.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id||integer||Product index.
|-
|image||URL||Product image.
|-
|name||string||Product name.
|-
|href||URL||Product link
|}
|-
| product.category_path || list of dictionaries || Information about the current category path.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id||integer||Category index.
|-
|name||string||Category name.
|-
|image||URL||Category image.
|-
|seo_link||URL||Category link.
|}
|-
|product.product || dictionary || Product information
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id || integer || Product index.
|-
|parent_id||integer||Parent product index.
|-
|categories||list of lists of dictionaries||Information for all product categories.||See product.category_path.
|-
|date_added||string||Date product was added.
|-
|date_available||string||Date product will be available.
|-
|delivery_time||string||Product delivery time.
|-
|description||HTML||Product description.
|-
|description_short||HTML||Short product description.
|-
|disabled||boolean||Product disabled status.
|-
|external_url||URL||Product link.
|-
|extra1||HTML||Custom product field.
|-
|extra2||HTML||Custom product field.
|-
|extra3||HTML||Custom product field.
|-
|extra4||HTML||Custom product field.
|-
|extra5||HTML||Custom product field.
|-
|featured||boolean||Featured product.
|-
|file||URL||Product file 1.
|-
|file2||URL||Product file 2.
|-
|image||URL||Product image.
|-
|image_href||URL||Link to full product image.
|-
|additional_images||Additional product images.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|href||URL||Image thumbnail link.
|-
|image||URL||Image path.
|-
|description||string||Image description.
|}
|-
|last_modified||string||Product last modified date.
|-
|lowest_number||integer||Minimum required order size.
|-
|manufacturer||string||Product manufacturer.
|-
|manufacturer_href||URL||Manufacturer category link.
|-
|manufacturer_image||URL||Manufacturer image.
|-
|manufacturer_model||string||Product manufacturer model.
|-
|model||string||Product model.
|-
|name||string||Product name.
|-
|next_delivery_date||string||Next delivery date.
|-
|next_delivery_quantity||string||Next delivery quantity.
|-
|price||string||Product price.
|-
|price_rek||string||Recommended product price.
|-
|price_special||string||Special product price.
|-
|rating||decimal||Average review rating in increments of 0.5.
|-
|seo_link||URL||Product link.
|-
|stock||integer||Products in stock.
|-
|type||string||Product quantity type.
|-
|weight||string||Product weight.
|-
|}
|}

===Product added to shopping cart page (product_added.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product_added.checkout_href || 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
|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 info
|N/A
|-
|products_new.page_href_format
|URL
|Pagination link format
|N/A
|-
|products_new.products
|products
|A list of recently added products.
|list of products
|}

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

===Review page (product_reviews_info.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product_reviews_info.back_href || URL || Link to the product reviews page. || N/A
|-
| product_reviews_info.write_href || URL || Link to the write review page. || N/A
|-
| product_reviews_info.product || product || The product. || N/A
|-
| product_reviews_info.review || dictionary || The displayed review.
|
{| class="wikitable"
!Key !! Type !! Description
|-
|author || string || Author of the review
|-
|date || string || The date the review was written
|-
|text || string || The review text, lines broken at every 60 characters
|-
|rating || 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 || Form handler. || N/A
|-
| product_reviews_write.back_href || URL || Link to the product reviews page. || N/A
|-
| product_reviews_write.product || product || The product. || N/A
|-
| product_reviews_write.customer || dictionary || Customer information.
|
{| class="wikitable"
!Key !! Type !! Description
|-
|firstname || string || First name of the customer writing the review.
|-
|lastname || 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
|A link to the page which handles the form
|N/A
|-
|question_about_product.back_href
|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 info
|N/A
|-
|reviews.page_href_format
|URL
|Pagination link format
|N/A
|-
|reviews.reviews
|list of dictionaries
|Product reviews
|
{| class="wikitable"
!Key
!Type
!Description
|-
|href
|URL
|A link to the review page
|-
|product
|string
|Product name
|-
|author
|string
|Review author
|-
|date
|string
|Review date
|-
|image
|string
|Product image
|-
|text
|HTML
|Abbreviated review text
|-
|full_text
|string
|Unabbreviated review text
|-
|rating
|HTML
|Product rating
|}
|}

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

===Tell a friend page (tell_a_friend.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|tell_a_friend.form_action
|URL
|A link to the page which handles the form
|N/A
|-
|tell_a_friend.back_href
|URL
|Link back to the product page
|N/A
|-
|tell_a_friend.product
|product
|Product information.
|N/A
|}

Templating:Variables

2011-09-06T10:10:36Z

79.136.61.42: /* Campaign page (campaign.html) */

[[Category:Templating]]
=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===
===boolean===
===list===
===dictionary===
====pagination====
{| class="wikitable"
!Key
!Type
!Description
|-
|page
|integer
|The current page.
|-
|prev
|integer
|The previous page.
|-
|next
|integer
|The next page.
|-
|pages
|list of integers
|The pages in the current set.
|-
|set_prev
|integer
|The last page in the previous set of pages.
|-
|set_next
|integer
|The first page in the next set of pages.
|-
|from_row
|integer
|The first row displayed.
|-
|to_row
|integer
|The last row displayed.
|-
|row_count
|integer
|The number of rows paginated.
|}

====product====
{| class="wikitable"
!Key
!Type
!Description
|-
|delivery_time
|string
|
|-
|description
|HTML
|
|-
|description_short
|HTML
|
|-
|href_buy
|URL
|
|-
|href
|URL
|
|-
|image
|URL
|
|-
|manufacturer_image
|URL
|
|-
|manufacturer_name
|string
|
|-
|model
|string
|
|-
|name
|string
|
|-
|price_discount_percentage
|HTML
|
|-
|price
|HTML
|
|-
|price_recommended
|HTML
|
|-
|price_special
|HTML
|
|-
|quantity
|integer
|
|-
|seo_link
|string
|
|-
|tax_class_id
|integer
|
|}

==Globals==
Globals are accessible anywhere in the templates, including macros.
{| class="wikitable"
!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
|
{| class="wikitable"
!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
|-
|meta
|dictionary
|Header meta information for current page.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|HTML
|Page title.
|-
|keywords
|string
|Page meta keywords.
|-
|description
|HTML
|Page meta description.
|-
|language
|string
|Page language.
|-
|generator
|string
|Startabutik E-handel.
|-
|canonical
|URL
|Canonical URL for current page. Not always available.
|}
|-
|settings
|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
|Account fields can be enabled and disabled
|-
|CREATE_ACCOUNT_LAYOUT
|integer
|''Internal''
|-
|DOWNLOAD_ENABLED
|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
|Used in form validation
|-
|ENTRY_PASSWORD_IN_REGISTRATION
|boolean
|Is the user allowed to specify a password when registering
|-
|FORMS_USE_CAPTCHA
|boolean
|Is captcha used for forms
|-
|HEADING_IMAGE_WIDTH, HEADING_IMAGE_HEIGHT
|integer
|Width and height of heading images
|-
|MAX_ADDRESS_BOOK_ENTRIES
|integer
|Maximum entries in the address book
|-
|PREV_NEXT_BAR_LOCATION
|integer
|''Internal''
|-
|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''
|}
|-
|shoppingcart_amount
|string
|Amount of products in shopping cart
|N/A
|-
|shoppingcart_total
|string
|Total sum of the content in shopping cart
|N/A
|-
|random_box_left
|string
|Shows boxes at the left side of the store
|N/A
|-
|random_box_right
|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 of dictionaries
|Contains a tree of displayed categories in menu
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Id of category
|-
|name
|string
|Name of category in current language
|-
|image
|string
|Path to category image if such exists
|-
|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
|-
|open
|boolean
|Returns true if the category (or one of its children) is the currently selected one
|-
|selected
|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 of dictionaries
|Contains a full tree of all available categories in menu
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Id of category
|-
|name
|string
|Name of category in current language
|-
|image
|string
|Path to category image if such exists
|-
|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
|-
|open
|boolean
|Returns true if the category (or one of its children) is the currently selected one
|-
|selected
|boolean
|Returns true if the category is the currently selected one
|}
|}

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

===Random special offer===
Contains a random special offer.
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.special_offers.product
|dictionary
|''True'' if prices are displayed including VAT, else ''false''.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Name of product
|-
|href
|string
|Link to product page
|-
|image
|string
|Link to product image
|-
|price
|string
|Product standard price represented with currency symbol
|-
|special_price
|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
|''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
|}

==Containboxes==
Available in login.html and create_account.html.
===Create account box (containboxes/create_account.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|containboxes.create_account.form_action
|URL
|A link to the page which handles the form
|N/A
|-
|containboxes.create_account.text
|HTML
|Box text
|N/A
|-
|containboxes.create_account.generated_password
|string
|A randomly generated password
|N/A
|-
|containboxes.create_account.customers_personnummer
|string
|The customer's personnummer
|N/A
|-
|containboxes.create_account.sms_avisering
|boolean
|N/A
|N/A
|-
|containboxes.create_account.countries
|association list
|A list of country names mapped to their indices.
|Array of string to integer mappings.
|}
===Login box (containboxes/login_box.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|containboxes.login_box.form_action
|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
|A link to the page which handles the form
|N/A
|}

==Modules==

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

===downloads.php===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|downloads.downloads
|list of dictionaries
|Available downloads
|
{| class="wikitable"
!Key
!Type
!Description
|-
|href
|URL
|Download link
|-
|expiry
|string
|Download expiry date
|-
|valid
|boolean
|Is the download valid?
|-
|download_count
|integer
|Download count
|-
|product_name
|string
|Product name
|}
|-
|downloads.account_history_info
|boolean
|Is this module included from the order info page?
|N/A
|-
|downloads.account_href
|URL
|A link to the account page.
|N/A
|}

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

===product_specifications.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.product_specifications.specifications
|list of dictionaries
|Product specifications.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Specification name.
|-
|value
|string
|Specification value.
|}
|}

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

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

===products_variants.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.products_variants.category
|integer
|Category index.
|N/A
|-
|modules.products_variants.variants
|list of dictionaries
|Variants.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Variant name
|-
|selected
|integer
|Selected variant.
|-
|options
|list of integer to value mappings
|Variants.
|}
|-
|modules.products_variants.products
|list of dictionaries
|Variants.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|seo_link
|URL
|Variant URL.
|-
|name
|string
|Variant name.
|}
|}

===tell_a_friend.html===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|modules.tell_a_friend.form_action
|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
|A link to the page which handles the form
|N/A
|-
|account_edit.back_href
|URL
|A link back to the account page
|N/A
|-
|account_edit.account
|dictionary
|Account data
|
{| class="wikitable"
!Key
!Type
!Description
|-
|firstname
|string
|Account first name
|-
|lastname
|string
|Account last name
|-
|personnummer
|string
|Account personnummer
|-
|dob
|string
|Account date of birth
|-
|email_address
|string
|Account email address
|-
|telephone
|string
|Account telephone number
|-
|mobile
|string
|Account mobile telephone number
|-
|fax
|string
|Account fax number
|-
|gender
|string
|Account gender ('m' or 'f')
|}
|}

===Account history page (account_history.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account_history.account_href
|URL
|A link back to the account page
|N/A
|-
|account_history.pagination
|pagination
|Pagination info
|N/A
|-
|account_history.page_href_format
|URL
|Pagination link format
|N/A
|-
|account_history.order_history
|list of dictionaries
|Order history
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Order ID
|-
|status
|string
|Order status
|-
|date
|string
|Order date
|-
|type
|string
|Order type
|-
|name
|string
|Order delivery name
|-
|product_count
|integer
|Product count
|-
|total
|string
|Order total
|-
|href
|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
|Link back to the account order history
|N/A
|-
|account_history_info.order
|dictionary
|Order info
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id_formatted
|string
|Order ID
|-
|status
|string
|Order status
|-
|date
|string
|Order date
|-
|total
|string
|Order total
|-
|shipping_method
|string
|Order shipping method
|-
|payment_method
|string
|Order payment method
|-
|tax_group_count
|integer
|Number of different tax groups
|-
|billing_address
|string
|Order billing address
|-
|delivery_address
|string
|Order delivery address
|-
|delivery
|boolean
|
|-
|products
|list of dictionaries
|Products in order
{| class="wikitable"
!Key
!Type
!Description
|-
|qty
|integer
|Product quantity
|-
|id
|integer
|Product ID
|-
|name
|string
|Product name
|-
|model
|string
|Product model
|-
|tax
|decimal
|Product tax
|-
|price
|decimal
|Product price
|-
|final_price
|decimal
|Final product price
|-
|}
|-
|totals
|list of dictionaries
|Order parts of total
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|string
|Total part label
|-
|text
|string
|Total part value
|}
|-
|statuses
|list of dictionaries
|Order statuses
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Status name
|-
|date
|string
|Status date
|-
|comments
|string
|Status comments
|}
|-
|events
|list of dictionaries
|Order delivery events
{| class="wikitable"
!Key
!Type
!Description
|-
|date
|string
|Event date
|-
|location
|string
|Event location
|-
|description
|string
|Event description
|}
|}
|}

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

===Account newsletter subscription page (account_newsletters.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|account_newsletters.form_action
|URL
|A link to the page which handles the form
|N/A
|-
|account_newsletters.back_href
|URL
|Link back to the account page
|N/A
|-
|account_newsletters.subscribed
|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
|A link to the page which handles the form
|N/A
|-
|account_notifications.account_href
|URL
|A link back to the account page
|N/A
|-
|account_notifications.products
|list of dictionaries
|The products subscribed to
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|Product ID
|-
|name
|string
|Product name
|-
|counter
|integer
|List index
|}
|-
|account_notifications.global_product_notifications
|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
|A link to the page which handles the form
|N/A
|-
|account_password.back_href
|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
|A link to the page which handles the form
|N/A
|-
|account_password_new.back_href
|URL
|Link back to the account page
|N/A
|-
|account_password_new.password_provided
|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
|A link back to the account page
|N/A
|-
|address_book.add_href
|URL
|A link to a form which adds a new entry to the address book
|N/A
|-
|address_book.entries_count
|integer
|Number of entries
|N/A
|-
|address_book.address_label
|HTML
|Address label
|N/A
|-
|address_book.addresses
|list of dictionaries
|The addresses in the address book
|
{| class="wikitable"
!Key
!Type
!Description
|-
|default
|boolean
|Is this the default address book entry
|-
|edit_href
|URL
|A link to edit the entry
|-
|delete_href
|URL
|A link to delete the entry
|-
|name
|string
|Associated name
|-
|address
|HTML
|The address
|}
|}

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

===Search results page (advanced_search_results.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| advanced_search_results.results || list of products || The search results. ||N/A
|-
| advanced_search_results.num_results || integer || The number of search results. || N/A
|-
| advanced_search_results.back_href || 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 || Title of campaign. ||N/A
|-
| campaign.campaign_description || HTML || Description of campaign. ||N/A
|-
| campaign.campaign_image || URL || Selected campaign image. ||N/A
|-
| campaign.products || list of products || Products included in campaign. ||N/A
|}

===Product list (categories_listing.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| categories_listing.header || dictionary || Page header attributes: image, description and title ||N/A
|-
| categories_listing.page_limit || integer || Maximum number of products per page ||N/A
|-
| categories_listing.page_limits || list of integers || List of available page limits. 0 means all product on one page ||N/A
|-
| categories_listing.page_index || integer || Current page number ||N/A
|-
| categories_listing.page_count || integer || Number of pages ||N/A
|-
| categories_listing.cpath || list of integers || 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_count || integer || Total number of products using current filters ||N/A
|}

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

===Contact us page (contact.html)===
{| class="wikitable"
!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 [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
|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
|Gallery title.
|N/A
|-
|gallery.description
|string
|Gallery description or content.
|N/A
|-
|gallery.date
|string
|Last modification date.
|N/A
|-
|gallery.type
|string
|Type of gallery.
|N/A
|-
|gallery.upload_data_action
|URL
|Form action for uploading.
|N/A
|-
|gallery.upload_data_check
|boolean
|True.
|N/A
|-
|gallery.upload_data_type
|HTML
|Form field.
|N/A
|-
|gallery.page_title
|string
|Edited page title.
|N/A
|-
|gallery.page_description
|HTML
|Edited page description.
|N/A
|-
|gallery.form_page_description
|string
|Edited page description, escaped.
|N/A
|-
|gallery.gallery_owned
|boolean
|Set if the gallery is owned by the logged-in user.
|N/A
|-
|gallery.edit_content_link
|URL
|Link for editing the gallery.
|N/A
|-
|gallery.remove_content_link
|URL
|Link for removing the gallery.
|N/A
|-
|gallery.edit_mode
|boolean
|Set when editing, otherwise adding.
|N/A
|-
|gallery.gallery_fields
|list of dictionaries
|Gallery fields.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|label
|string
|Field label.
|-
|output
|HTML
|Form field.
|}
|-
|gallery.children
|list of string to dictionary mappings
|Child galleries.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|title
|string
|Gallery title.
|-
|description
|HTML
|Gallery description.
|-
|link
|URL
|Child gallery link.
|-
|date
|string
|Last modification date.
|}
|}

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

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

===Login page (login.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|login.heading
|string
|Page heading
|N/A
|}

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

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

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

===News article page (news.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|news.title
|string
|News article title
|N/A
|-
|news.date
|string
|Date of publishing
|N/A
|-
|news.content
|string
|News article content
|N/A
|-
|news.blog_enabled
|boolean
|Is the blog functionality enabled?
|N/A
|-
|news.form_action
|URL
|A link to the page which handles the new comment form
|N/A
|-
|news.comments
|list of dictionaries
|Comments to the news article
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Comment author
|-
|date
|string
|Comment posting date
|-
|comment
|string
|Comment text
|}
|}

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

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

===Product page (product.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product.form_href || URL || Add to cart handler. || N/A
|-
| product.reviews_href || URL || Link to product reviews. || N/A
|-
| product.invalid_name || string || Invalid product name page title. || N/A
|-
| product.invalid_text || string || Invalid product name page text. || N/A
|-
| product.inactive_name || string || Inactive product name page title. || N/A
|-
| product.inactive_text || string || Inactive product name page text. || N/A
|-
|product.product_prev
product.product_next
|dictionary
|Previous and next products in the current category.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id||integer||Product index.
|-
|image||URL||Product image.
|-
|name||string||Product name.
|-
|href||URL||Product link
|}
|-
| product.category_path || list of dictionaries || Information about the current category path.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id||integer||Category index.
|-
|name||string||Category name.
|-
|image||URL||Category image.
|-
|seo_link||URL||Category link.
|}
|-
|product.product || dictionary || Product information
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id || integer || Product index.
|-
|parent_id||integer||Parent product index.
|-
|categories||list of lists of dictionaries||Information for all product categories.||See product.category_path.
|-
|date_added||string||Date product was added.
|-
|date_available||string||Date product will be available.
|-
|delivery_time||string||Product delivery time.
|-
|description||HTML||Product description.
|-
|description_short||HTML||Short product description.
|-
|disabled||boolean||Product disabled status.
|-
|external_url||URL||Product link.
|-
|extra1||HTML||Custom product field.
|-
|extra2||HTML||Custom product field.
|-
|extra3||HTML||Custom product field.
|-
|extra4||HTML||Custom product field.
|-
|extra5||HTML||Custom product field.
|-
|featured||boolean||Featured product.
|-
|file||URL||Product file 1.
|-
|file2||URL||Product file 2.
|-
|image||URL||Product image.
|-
|image_href||URL||Link to full product image.
|-
|additional_images||Additional product images.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|href||URL||Image thumbnail link.
|-
|image||URL||Image path.
|-
|description||string||Image description.
|}
|-
|last_modified||string||Product last modified date.
|-
|lowest_number||integer||Minimum required order size.
|-
|manufacturer||string||Product manufacturer.
|-
|manufacturer_href||URL||Manufacturer category link.
|-
|manufacturer_image||URL||Manufacturer image.
|-
|manufacturer_model||string||Product manufacturer model.
|-
|model||string||Product model.
|-
|name||string||Product name.
|-
|next_delivery_date||string||Next delivery date.
|-
|next_delivery_quantity||string||Next delivery quantity.
|-
|price||string||Product price.
|-
|price_rek||string||Recommended product price.
|-
|price_special||string||Special product price.
|-
|seo_link||URL||Product link.
|-
|stock||integer||Products in stock.
|-
|type||string||Product quantity type.
|-
|weight||string||Product weight.
|-
|}
|}

===Product added to shopping cart page (product_added.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product_added.checkout_href || 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
|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 info
|N/A
|-
|products_new.page_href_format
|URL
|Pagination link format
|N/A
|-
|products_new.products
|products
|A list of recently added products.
|list of products
|}

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

===Review page (product_reviews_info.html)===
{| class="wikitable"
!Variable name !! Type !! Description !! Format
|-
| product_reviews_info.back_href || URL || Link to the product reviews page. || N/A
|-
| product_reviews_info.write_href || URL || Link to the write review page. || N/A
|-
| product_reviews_info.product || product || The product. || N/A
|-
| product_reviews_info.review || dictionary || The displayed review.
|
{| class="wikitable"
!Key !! Type !! Description
|-
|author || string || Author of the review
|-
|date || string || The date the review was written
|-
|text || string || The review text, lines broken at every 60 characters
|-
|rating || 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 || Form handler. || N/A
|-
| product_reviews_write.back_href || URL || Link to the product reviews page. || N/A
|-
| product_reviews_write.product || product || The product. || N/A
|-
| product_reviews_write.customer || dictionary || Customer information.
|
{| class="wikitable"
!Key !! Type !! Description
|-
|firstname || string || First name of the customer writing the review.
|-
|lastname || 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
|A link to the page which handles the form
|N/A
|-
|question_about_product.back_href
|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 info
|N/A
|-
|reviews.page_href_format
|URL
|Pagination link format
|N/A
|-
|reviews.reviews
|list of dictionaries
|Product reviews
|
{| class="wikitable"
!Key
!Type
!Description
|-
|href
|URL
|A link to the review page
|-
|product
|string
|Product name
|-
|author
|string
|Review author
|-
|date
|string
|Review date
|-
|image
|string
|Product image
|-
|text
|HTML
|Abbreviated review text
|-
|full_text
|string
|Unabbreviated review text
|-
|rating
|HTML
|Product rating
|}
|}

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

===Tell a friend page (tell_a_friend.html)===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|tell_a_friend.form_action
|URL
|A link to the page which handles the form
|N/A
|-
|tell_a_friend.back_href
|URL
|Link back to the product page
|N/A
|-
|tell_a_friend.product
|product
|Product information.
|N/A
|}

Templating:Variables

2011-04-06T15:13:34Z

79.136.61.42: /* VAT select box */

[[Category:Templating]]
=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.
{| class="wikitable"
!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
|
{| class="wikitable"
!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
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.categories.tree
|list of dictionaries
|Contains a tree of displayed categories in menu
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.manufacturers.list
|list of dictionaries
|Lists all available manufacturers
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Name of manufacturer
|-
|href
|string
|Link to manufacturer page
|}
|}
===Search box===
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.information_pages.list
|list of dictionaries
|Lists all active information pages
|
{| class="wikitable"
!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"
|}
|}
===Language list===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.languages.list
|list of dictionaries
|Lists all languages
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Language name
|-
|href
|string
|Link to page that sets language to this one
|-
|image
|string
|Image (flag) for language if available
|}
|}
===Login box===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.login.form_href
|string
|Action link for login form
|N/A
|-
|boxes.login.password_forgotten_href
|string
|Link to retrieve forgotten password page
|N/A
|-
|boxes.login.account_history_href
|string
|Link to current customer's account history page. Contains orders and such
|N/A
|-
|boxes.login.account_href
|string
|Link to current customer's account page
|N/A
|-
|boxes.login.account_password_href
|string
|''Unknown''
|N/A
|-
|boxes.login.logoff_href
|string
|Link to log off current customer
|N/A
|-
|boxes.login.customer_first_name
|string
|Current customer's first name
|N/A
|-
|boxes.login.customer_last_name
|string
|Current customer's last name
|N/A
|}
===News list===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.news.list
|list of dictionaries
|Lists recent news. Limit set in administration
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|News name
|-
|href
|string
|Link to news page
|-
|summary
|string
|News summary
|}
|}
===Review===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.reviews.write_review_href
|string
|Link to write review page. Only set if customer is viewing a product page
|N/A
|-
|boxes.reviews.product
|dictionary
|Product and review data
|
{| class="wikitable"
!Key
!Type
!Description
|-
|product_name
|string
|Name of product
|-
|product_image
|string
|Link to product image
|-
|review_href
|string
|Link to full review
|-
|review_rating
|string
|Rating
|-
|review_text
|string
|Text of review
|}
|}
===Shopping cart===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.shopping_cart.list
|list of dictionaries
|List of products in shopping cart
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|ID of product
|-
|model
|string
|Model number for product
|-
|name
|string
|Name of product
|-
|image
|string
|Link to image of product
|-
|quantity
|string
|Number of this product in shopping cart
|-
|price
|string
|Price per product before discounts represented as a string with currency symbol
|-
|final_price
|string
|Price per product after discounts represented as a string with currency symbol
|-
|total_price
|string
|Total price for all products of this kind before discounts represented as a string with currency symbol
|-
|total_final_price
|string
|Total price for all products of this kind after discounts represented as a string with currency symbol
|-
|href
|string
|Link to product's page
|-
|new
|boolean
|''True'' if product was just added to the shopping cart
|}
|-
|boxes.shopping_cart.total
|string
|Total value of contents of shopping cart represented as a string with currency symbol
|N/A
|}

===Random special offer===
Contains a random special offer.
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.special_offers.product
|dictionary
|''True'' if prices are displayed including VAT, else ''false''.
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Name of product
|-
|href
|string
|Link to product page
|-
|image
|string
|Link to product image
|-
|price
|string
|Product standard price represented with currency symbol
|-
|special_price
|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
|''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)===
{| class="wikitable"
!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 [http://www.twig-project.org/doc/templates.html#raw raw] filter may be appropriate to use
|N/A
|}

Templating:Variables

2011-04-06T15:04:59Z

79.136.61.42: /* Shopping cart */

[[Category:Templating]]
=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.
{| class="wikitable"
!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
|
{| class="wikitable"
!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
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.categories.tree
|list of dictionaries
|Contains a tree of displayed categories in menu
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.manufacturers.list
|list of dictionaries
|Lists all available manufacturers
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Name of manufacturer
|-
|href
|string
|Link to manufacturer page
|}
|}
===Search box===
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.information_pages.list
|list of dictionaries
|Lists all active information pages
|
{| class="wikitable"
!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"
|}
|}
===Language list===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.languages.list
|list of dictionaries
|Lists all languages
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Language name
|-
|href
|string
|Link to page that sets language to this one
|-
|image
|string
|Image (flag) for language if available
|}
|}
===Login box===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.login.form_href
|string
|Action link for login form
|N/A
|-
|boxes.login.password_forgotten_href
|string
|Link to retrieve forgotten password page
|N/A
|-
|boxes.login.account_history_href
|string
|Link to current customer's account history page. Contains orders and such
|N/A
|-
|boxes.login.account_href
|string
|Link to current customer's account page
|N/A
|-
|boxes.login.account_password_href
|string
|''Unknown''
|N/A
|-
|boxes.login.logoff_href
|string
|Link to log off current customer
|N/A
|-
|boxes.login.customer_first_name
|string
|Current customer's first name
|N/A
|-
|boxes.login.customer_last_name
|string
|Current customer's last name
|N/A
|}
===News list===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.news.list
|list of dictionaries
|Lists recent news. Limit set in administration
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|News name
|-
|href
|string
|Link to news page
|-
|summary
|string
|News summary
|}
|}
===Review===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.reviews.write_review_href
|string
|Link to write review page. Only set if customer is viewing a product page
|N/A
|-
|boxes.reviews.product
|dictionary
|Product and review data
|
{| class="wikitable"
!Key
!Type
!Description
|-
|product_name
|string
|Name of product
|-
|product_image
|string
|Link to product image
|-
|review_href
|string
|Link to full review
|-
|review_rating
|string
|Rating
|-
|review_text
|string
|Text of review
|}
|}
===Shopping cart===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.shopping_cart.list
|list of dictionaries
|List of products in shopping cart
|
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|integer
|ID of product
|-
|model
|string
|Model number for product
|-
|name
|string
|Name of product
|-
|image
|string
|Link to image of product
|-
|quantity
|string
|Number of this product in shopping cart
|-
|price
|string
|Price per product before discounts represented as a string with currency symbol
|-
|final_price
|string
|Price per product after discounts represented as a string with currency symbol
|-
|total_price
|string
|Total price for all products of this kind before discounts represented as a string with currency symbol
|-
|total_final_price
|string
|Total price for all products of this kind after discounts represented as a string with currency symbol
|-
|href
|string
|Link to product's page
|-
|new
|boolean
|''True'' if product was just added to the shopping cart
|}
|-
|boxes.shopping_cart.total
|string
|Total value of contents of shopping cart represented as a string with currency symbol
|N/A
|}

===VAT select box===
{| class="wikitable"
!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)===
{| class="wikitable"
!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 [http://www.twig-project.org/doc/templates.html#raw raw] filter may be appropriate to use
|N/A
|}

Templating:Variables

2011-04-06T14:44:36Z

79.136.61.42: /* News list */

[[Category:Templating]]
=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.
{| class="wikitable"
!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
|
{| class="wikitable"
!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
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.categories.tree
|list of dictionaries
|Contains a tree of displayed categories in menu
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.manufacturers.list
|list of dictionaries
|Lists all available manufacturers
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Name of manufacturer
|-
|href
|string
|Link to manufacturer page
|}
|}
===Search box===
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.information_pages.list
|list of dictionaries
|Lists all active information pages
|
{| class="wikitable"
!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"
|}
|}
===Language list===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.languages.list
|list of dictionaries
|Lists all languages
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Language name
|-
|href
|string
|Link to page that sets language to this one
|-
|image
|string
|Image (flag) for language if available
|}
|}
===Login box===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.login.form_href
|string
|Action link for login form
|N/A
|-
|boxes.login.password_forgotten_href
|string
|Link to retrieve forgotten password page
|N/A
|-
|boxes.login.account_history_href
|string
|Link to current customer's account history page. Contains orders and such
|N/A
|-
|boxes.login.account_href
|string
|Link to current customer's account page
|N/A
|-
|boxes.login.account_password_href
|string
|''Unknown''
|N/A
|-
|boxes.login.logoff_href
|string
|Link to log off current customer
|N/A
|-
|boxes.login.customer_first_name
|string
|Current customer's first name
|N/A
|-
|boxes.login.customer_last_name
|string
|Current customer's last name
|N/A
|}
===News list===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.news.list
|list of dictionaries
|Lists recent news. Limit set in administration
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|News name
|-
|href
|string
|Link to news page
|-
|summary
|string
|News summary
|}
|}
===Review===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.reviews.write_review_href
|string
|Link to write review page. Only set if customer is viewing a product page
|N/A
|-
|boxes.reviews.product
|dictionary
|Product and review data
|
{| class="wikitable"
!Key
!Type
!Description
|-
|product_name
|string
|Name of product
|-
|product_image
|string
|Link to product image
|-
|review_href
|string
|Link to full review
|-
|review_rating
|string
|Rating
|-
|review_text
|string
|Text of review
|}
|}
===Shopping cart===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.shopping_cart.list
|list of dictionaries
|List of products in shopping cart
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Name of product
|-
|href
|string
|Link to product's page
|-
|new
|boolean
|''True'' if product was just added to the shopping cart
|}
|-
|boxes.shopping_cart.total
|string
|Total value of contents of shopping cart represented as a string with currency symbol
|N/A
|}

===VAT select box===
{| class="wikitable"
!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)===
{| class="wikitable"
!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 [http://www.twig-project.org/doc/templates.html#raw raw] filter may be appropriate to use
|N/A
|}

Templating:Variables

2011-04-06T14:36:25Z

79.136.61.42: /* Information page list */

[[Category:Templating]]
=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.
{| class="wikitable"
!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
|
{| class="wikitable"
!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
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.categories.tree
|list of dictionaries
|Contains a tree of displayed categories in menu
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.manufacturers.list
|list of dictionaries
|Lists all available manufacturers
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Name of manufacturer
|-
|href
|string
|Link to manufacturer page
|}
|}
===Search box===
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.information_pages.list
|list of dictionaries
|Lists all active information pages
|
{| class="wikitable"
!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"
|}
|}
===Language list===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.languages.list
|list of dictionaries
|Lists all languages
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Language name
|-
|href
|string
|Link to page that sets language to this one
|-
|image
|string
|Image (flag) for language if available
|}
|}
===Login box===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.login.form_href
|string
|Action link for login form
|N/A
|-
|boxes.login.password_forgotten_href
|string
|Link to retrieve forgotten password page
|N/A
|-
|boxes.login.account_history_href
|string
|Link to current customer's account history page. Contains orders and such
|N/A
|-
|boxes.login.account_href
|string
|Link to current customer's account page
|N/A
|-
|boxes.login.account_password_href
|string
|''Unknown''
|N/A
|-
|boxes.login.logoff_href
|string
|Link to log off current customer
|N/A
|-
|boxes.login.customer_first_name
|string
|Current customer's first name
|N/A
|-
|boxes.login.customer_last_name
|string
|Current customer's last name
|N/A
|}
===News list===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.news.list
|list of dictionaries
|Lists recent news. Limit set in administration
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|News name
|-
|href
|string
|Link to news page
|-
|summary
|string
|News summary
|}
|}
===News list===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.reviews.write_review_href
|string
|Link to write review page. Only set if customer is viewing a product page
|N/A
|-
|boxes.reviews.product
|dictionary
|Product and review data
|
{| class="wikitable"
!Key
!Type
!Description
|-
|product_name
|string
|Name of product
|-
|product_image
|string
|Link to product image
|-
|review_href
|string
|Link to full review
|-
|review_rating
|string
|Rating
|-
|review_text
|string
|Text of review
|}
|}

===VAT select box===
{| class="wikitable"
!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)===
{| class="wikitable"
!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 [http://www.twig-project.org/doc/templates.html#raw raw] filter may be appropriate to use
|N/A
|}

Templating:Variables

2011-04-06T14:07:32Z

79.136.61.42: /* Boxes */

[[Category:Templating]]
=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.
{| class="wikitable"
!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
|
{| class="wikitable"
!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
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.categories.tree
|list of dictionaries
|Contains a tree of displayed categories in menu
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.manufacturers.list
|list of dictionaries
|Lists all available manufacturers
|
{| class="wikitable"
!Key
!Type
!Description
|-
|name
|string
|Name of manufacturer
|-
|href
|string
|Link to manufacturer page
|}
|}
===Search box===
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.information_pages.list
|list of dictionaries
|Lists all active information pages
|
{| class="wikitable"
!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===
{| class="wikitable"
!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)===
{| class="wikitable"
!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 [http://www.twig-project.org/doc/templates.html#raw raw] filter may be appropriate to use
|N/A
|}

Templating:Variables

2011-04-06T14:02:06Z

79.136.61.42: /* Contact us page (contact.html) */

[[Category:Templating]]
=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.
{| class="wikitable"
!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
|
{| class="wikitable"
!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
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.categories.tree
|list of dictionaries
|Contains a tree of displayed categories in menu
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.manufacturers.list
|Lists all available manufacturers
<pre>
[
{
'name' : name_of_manufacturer,
'href' : link_to_manufacturer,
},
...
]</pre>
|}
===Search box===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.search.advanced_href
|URL to advanced search page
|-
|boxes.search.advanced_result_href
|Action URL for search form
|}
===Information page list===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.information_pages.list
|Lists all active information pages
<pre>
[
{
'name' : name_of_page,
'href' : url_to_page,
'active' : true_if_on_this_page,
'target' : true_if_expecting_target_blank
},
...
]</pre>
|}
===VAT select box===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.vat_select.display_with_vat
|''True'' if prices are displayed including VAT, else ''false''.
|-
|boxes.vat_select.with_href
|URL to page where VAT display is set to ''true''.
|-
|boxes.vat_select.without_href
|URL to page where VAT display is set to ''false''.
|}

==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)===
{| class="wikitable"
!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 [http://www.twig-project.org/doc/templates.html#raw raw] filter may be appropriate to use
|N/A
|}

Templating:Variables

2011-04-06T14:01:54Z

79.136.61.42: /* Contact us page (contact.html) */

[[Category:Templating]]
=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.
{| class="wikitable"
!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
|
{| class="wikitable"
!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
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.categories.tree
|list of dictionaries
|Contains a tree of displayed categories in menu
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.manufacturers.list
|Lists all available manufacturers
<pre>
[
{
'name' : name_of_manufacturer,
'href' : link_to_manufacturer,
},
...
]</pre>
|}
===Search box===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.search.advanced_href
|URL to advanced search page
|-
|boxes.search.advanced_result_href
|Action URL for search form
|}
===Information page list===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.information_pages.list
|Lists all active information pages
<pre>
[
{
'name' : name_of_page,
'href' : url_to_page,
'active' : true_if_on_this_page,
'target' : true_if_expecting_target_blank
},
...
]</pre>
|}
===VAT select box===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.vat_select.display_with_vat
|''True'' if prices are displayed including VAT, else ''false''.
|-
|boxes.vat_select.with_href
|URL to page where VAT display is set to ''true''.
|-
|boxes.vat_select.without_href
|URL to page where VAT display is set to ''false''.
|}

==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)===
{| class="wikitable"
!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 [http://www.twig-project.org/doc/templates.html#raw raw] filter may be appropriate to use.
|}

Templating:Variables

2011-04-06T13:59:22Z

79.136.61.42: /* Globals */

[[Category:Templating]]
=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.
{| class="wikitable"
!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
|
{| class="wikitable"
!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
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Type
!Description
!Format
|-
|boxes.categories.tree
|list of dictionaries
|Contains a tree of displayed categories in menu
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.manufacturers.list
|Lists all available manufacturers
<pre>
[
{
'name' : name_of_manufacturer,
'href' : link_to_manufacturer,
},
...
]</pre>
|}
===Search box===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.search.advanced_href
|URL to advanced search page
|-
|boxes.search.advanced_result_href
|Action URL for search form
|}
===Information page list===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.information_pages.list
|Lists all active information pages
<pre>
[
{
'name' : name_of_page,
'href' : url_to_page,
'active' : true_if_on_this_page,
'target' : true_if_expecting_target_blank
},
...
]</pre>
|}
===VAT select box===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.vat_select.display_with_vat
|''True'' if prices are displayed including VAT, else ''false''.
|-
|boxes.vat_select.with_href
|URL to page where VAT display is set to ''true''.
|-
|boxes.vat_select.without_href
|URL to page where VAT display is set to ''false''.
|}

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

Templating:Variables

2011-04-06T13:57:20Z

79.136.61.42: /* Category menu */

[[Category:Templating]]
=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.
{| class="wikitable"
!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
|
{| class="wikitable"
!Key
!Description
|-
|get
|Dictionary of data received from the ''GET'' query string
|-
|post
|Dictionary of 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
|
{| class="wikitable"
!Key
!Description
|-
|SMALL_IMAGE_WIDTH
|Integer width of small thumbnails in pixels
|-
|SMALL_IMAGE_HEIGHT
|Integer height of small thumbnails in pixels
|-
|STATISTICS_GOOGLE_ANALYTICS
|Google analytics tracking code, if specified
|-
|PRODUCT_PAGE_DESIGN
|''Internal''
|}
|}

==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 of dictionaries
|Contains a tree of displayed categories in menu
|
{| class="wikitable"
!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===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.manufacturers.list
|Lists all available manufacturers
<pre>
[
{
'name' : name_of_manufacturer,
'href' : link_to_manufacturer,
},
...
]</pre>
|}
===Search box===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.search.advanced_href
|URL to advanced search page
|-
|boxes.search.advanced_result_href
|Action URL for search form
|}
===Information page list===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.information_pages.list
|Lists all active information pages
<pre>
[
{
'name' : name_of_page,
'href' : url_to_page,
'active' : true_if_on_this_page,
'target' : true_if_expecting_target_blank
},
...
]</pre>
|}
===VAT select box===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.vat_select.display_with_vat
|''True'' if prices are displayed including VAT, else ''false''.
|-
|boxes.vat_select.with_href
|URL to page where VAT display is set to ''true''.
|-
|boxes.vat_select.without_href
|URL to page where VAT display is set to ''false''.
|}

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

Templating:Variables

2011-04-06T13:51:24Z

79.136.61.42: /* Globals */

[[Category:Templating]]
=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.
{| class="wikitable"
!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
|
{| class="wikitable"
!Key
!Description
|-
|get
|Dictionary of data received from the ''GET'' query string
|-
|post
|Dictionary of 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
|
{| class="wikitable"
!Key
!Description
|-
|SMALL_IMAGE_WIDTH
|Integer width of small thumbnails in pixels
|-
|SMALL_IMAGE_HEIGHT
|Integer height of small thumbnails in pixels
|-
|STATISTICS_GOOGLE_ANALYTICS
|Google analytics tracking code, if specified
|-
|PRODUCT_PAGE_DESIGN
|''Internal''
|}
|}

==Boxes==
Boxes are variables used for the side boxes. They are all prefixed with ''boxes''.
===Category menu===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.categories.tree
|Contains a tree of displayed categories in menu.
<pre>
[
{
'name' : name_of_category,
'href' : link_to_category,
'child_count' : number_of_direct_children,
'children' : [ child, ... ],
'selected' : is_current_category // Boolean
},
...
]</pre>
|}
===Manufacturer select===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.manufacturers.list
|Lists all available manufacturers
<pre>
[
{
'name' : name_of_manufacturer,
'href' : link_to_manufacturer,
},
...
]</pre>
|}
===Search box===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.search.advanced_href
|URL to advanced search page
|-
|boxes.search.advanced_result_href
|Action URL for search form
|}
===Information page list===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.information_pages.list
|Lists all active information pages
<pre>
[
{
'name' : name_of_page,
'href' : url_to_page,
'active' : true_if_on_this_page,
'target' : true_if_expecting_target_blank
},
...
]</pre>
|}
===VAT select box===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.vat_select.display_with_vat
|''True'' if prices are displayed including VAT, else ''false''.
|-
|boxes.vat_select.with_href
|URL to page where VAT display is set to ''true''.
|-
|boxes.vat_select.without_href
|URL to page where VAT display is set to ''false''.
|}

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

Templating:Variables

2011-03-29T20:19:40Z

79.136.61.42: /* Boxes */

[[Category:Templating]]
=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.
{| class="wikitable"
!Variable name
!Description
|-
|current_page
|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''
|-
|current_script
|Contains filename of current page
|-
|request
|A dictionary of recieved get and post data. ''{ 'get' : get_data, 'post' : post_data}''
|-
|current_customer_id
|Returns customer ID if customer is logged in, else None
|-
|settings
|A dictionary of some of the settings defined in the administration
|}
==Boxes==
Boxes are variables used for the side boxes. They are all prefixed with ''boxes''.
===Category menu===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.categories.tree
|Contains a tree of displayed categories in menu.
<pre>
[
{
'name' : name_of_category,
'href' : link_to_category,
'child_count' : number_of_direct_children,
'children' : [ child, ... ],
'selected' : is_current_category // Boolean
},
...
]</pre>
|}
===Manufacturer select===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.manufacturers.list
|Lists all available manufacturers
<pre>
[
{
'name' : name_of_manufacturer,
'href' : link_to_manufacturer,
},
...
]</pre>
|}
===Search box===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.search.advanced_href
|URL to advanced search page
|-
|boxes.search.advanced_result_href
|Action URL for search form
|}
===Information page list===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.information_pages.list
|Lists all active information pages
<pre>
[
{
'name' : name_of_page,
'href' : url_to_page,
'active' : true_if_on_this_page,
'target' : true_if_expecting_target_blank
},
...
]</pre>
|}
===VAT select box===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.vat_select.display_with_vat
|''True'' if prices are displayed including VAT, else ''false''.
|-
|boxes.vat_select.with_href
|URL to page where VAT display is set to ''true''.
|-
|boxes.vat_select.without_href
|URL to page where VAT display is set to ''false''.
|}

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

Templating:Variables

2011-03-27T12:47:29Z

79.136.61.42:

[[Category:Templating]]
=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.
{| class="wikitable"
!Variable name
!Description
|-
|current_page
|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''
|-
|current_script
|Contains filename of current page
|-
|request
|A dictionary of recieved get and post data. ''{ 'get' : get_data, 'post' : post_data}''
|-
|current_customer_id
|Returns customer ID if customer is logged in, else None
|-
|settings
|A dictionary of some of the settings defined in the administration
|}
==Boxes==
Boxes are variables used for the side boxes. They are all prefixed with ''boxes''.
===Category box===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.categories.tree
|Contains a tree of displayed categories in menu.
<pre>
[
{
'name' : name_of_category,
'href' : link_to_category,
'child_count' : number_of_direct_children,
'children' : [ child, ... ],
'selected' : is_current_category // Boolean
},
...
]</pre>
|}
===Category box===
{| class="wikitable"
!Variable name
!Description
|-
|boxes.manufacturers.list
|Lists all available manufacturers
<pre>
[
{
'name' : name_of_manufacturer,
'href' : link_to_manufacturer,
},
...
]</pre>
|}
==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)===
{| class="wikitable"
!Variable name
!Description
|-
|contact.form_href
|URL with target of form for handling user input data
|-
|contact.captcha
|Boolean value, whether Captcha should be used or not
|-
|contact.name
|Contains customer name if customer is logged in or validation if validation of a field failed
|-
|contact.email
|Contains customer e-mail if customer is logged in or validation if validation of a field failed
|-
|contact.heading
|Contains heading text
|-
|contact.text
|Contains a descriptive text of what the contact us page is. It most certainly contains HTML so the [http://www.twig-project.org/doc/templates.html#raw raw] filter may be appropriate to use.
|}

Templating:Variables

2011-03-27T12:29:41Z

79.136.61.42: Skapade sidan med 'Category:Templating =Variables= Templates get ==Globals== Globals are accessible anywhere in the templates, including macros. {| class="wikitable" !Variable name!!Description...'

[[Category:Templating]]
=Variables=
Templates get
==Globals==
Globals are accessible anywhere in the templates, including macros.
{| class="wikitable"
!Variable name!!Description
|-
|current_page
|Contains URL after domain name and before '''?'''
|-
|current_script
|Contains filename of current page
|-
|request
|A dictionary of recieved get and post data. '''{ 'get' : get_data, 'post' : post_data}
|-
|current_customer_id
|Returns customer ID if customer is logged in, else None
|-
|settings
|A dictionary of some of the settings defined in the administration
|}
==Boxes==
Boxes are variables used for the side boxes. They are all prefixed with '''boxes'''.
===Category box===
{| class="wikitable"
!Variable name!!Description
|-boxes.categories.tree|Contains a tree of displayed categories in menu.
<pre>
[
{
'name' : name_of_category,
'href' : link_to_category,
'child_count' : number_of_direct_children,
'children' : [ child, ... ],
'selected' : is_current_category // Boolean
},
...
]</pre>
|}
==Page specific==
===Contact page (contact.html)===