Skillnad mellan versioner av "Templating:Variables"

Från Vendre Help
Hoppa till: navigering, sök
(login.html)
(Containboxes)
Rad 457: Rad 457:
 
|string
 
|string
 
|URL to page where VAT display is set to ''false''.
 
|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
 
|N/A
 
|}
 
|}

Versionen från 3 juni 2011 kl. 10.10

Variables

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

Globals

Globals are accessible anywhere in the templates, including macros.

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

Boxes

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

Category menu

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

Manufacturer select

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

Search box

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

Information page list

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

Language list

Variable name Type Description Format
boxes.languages.list list of dictionaries Lists all languages
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

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

Variable name Type Description Format
boxes.news.list list of dictionaries Lists recent news. Limit set in administration
Key Type Description
name string News name
href string Link to news page
summary string News summary

Review

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
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

Variable name Type Description Format
boxes.shopping_cart.list list of dictionaries List of products in shopping cart
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.

Variable name Type Description Format
boxes.special_offers.product dictionary True if prices are displayed including VAT, else false.
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

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)

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)

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)

Variable name Type Description Format
containboxes.password_forgotten_box.form_action URL A link to the page which handles the form N/A

Page specific

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

Contact us page (contact.html)

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

Manufacturers page (manufacturers.html)

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

Kolli page (kolli.html)

Variable name Type Description Format
kolli.heading string Page heading N/A
kolli.text HTML Page text N/A

Log off page (logoff.html)

Variable name Type Description Format
logoff.continue_href string Link presented to the user after logging off. N/A

Password forgotten page (password_forgotten.html)

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

Cookie usage page (cookie_usage.html)

Variable name Type Description Format
cookie_usage.continue_href string A link to the next page (index.php) N/A

Advanced search page (advanced_search.html)

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.

Login page (login.html)

Variable name Type Description Format
login.heading string Page heading N/A
Hämtad från "https://wiki.vendre.se/index.php?title=Templating:Variables&oldid=24"