Prints the sum that has been paid for with a gift card when paying for an order.

Kuvaus

If the visitor hasn't entered any gift card codes, the tag won't print anything.

To print the gift card's remaining balance, use the {GiftCardBalanceLeft} tag.

Syntaksi

{GiftCardBalanceReserved(
    html: boolean,
    exchanged: boolean,
    currencysymbol: boolean,
    decimals: int,
    decimalsep: string,
    thousandssep: string 
)}

Näkyvyys

Toimii näkyvyydessä: globaali

The tag is used in the {CartGiftCards} tag's helper attribute.

Implementing a gift card listing in a theme

Below you can see an implementation of a gift card listing in the default theme Barebones:

Barebones-teeman lahjakorttilistaus – helpers/full-cart.html
{CartGiftCards(
	helper: '{{
		<div class="FullCartSection FullCartTotal">
			{%CartPaidByGiftCard}: {GiftCardBalanceReserved}
		</div>
	}}',
	after: '
		{CartOpenTotal(
			before: '
				<div class="FullCartSection FullCartTotal">
					<span class="H4">{%CartOpenTotal}:&nbsp;',
			after: '</span></div>'
		)}',
	or: '
		{CartTotal(
			before: '<div class="FullCartSection FullCartTotal"><span class="H4">{%Total}:&nbsp;',
			after: '</span></div>'
		)}'
)}

The gift card listing itself is printed with the {CartGiftCards} tag.

The {GiftCardBalanceReserved} tag prints the sum paid with a gift card on the listing. After that the open balance is printed in the after attribute by using the {CartOpenTotal} tag.

If the customer hasn't used any gift cards, only the shopping cart total will be printed via the or attribute.

Attribuutit

html:

Defines whether the content should be printed wrapped in the default HTML markup.

Allowed values:true/false

exchanged:

Defines whether to take currency conversion into account in the output if the customer has placed an order in a currency other than euro.

The exchanged attribute is used only if the Currency Converter extension is in use.

This attribute works only after the customer has placed an order. So, you can use the attribute in order templates and e.g. inside the order products' tags.

Allowed values:true/false. The default value is false.

The content is always printed in euros if the value is false.

currencysymbol:

Determines whether the currency symbol is also displayed with the total. The output symbol is automatically determined based on the currency in use.

The currency symbol can also be printed using the {CurrencySymbol} tag.

Allowed values:true/false. The default value is false.

decimals:

Sets the decimal print precision (default is 2 decimal places).

Allowed values:integers.

decimalsep:

Defines the decimal separator character. The most popular decimal separators are comma and dot, the use of which depends on the store's locale.

Sallitut arvot: merkki jota halutaan käyttää desimaalierottimena (esim. desimaalipiste = decimalsep: '.'). Oletusarvo on pilkku.

thousandssep:

Specifies the character used as the thousands separator.

Commonly used thousands separators are space, comma, and period. You may want to define thousands separators according to the locale.

Allowed values: a character that should be used as the thousands separator in prices.

By default, the thousands separator is a non-breaking space &nbsp;

after/before:

By using the after and before attributes you can define content that is output either after or before the tag's output.

Allowed values:HTML and Interface markup.

E.g.

  • before: '<p>Tämä merkkaus näkyy ennen tagin omaa sisältöä.</p>'
  • after: '<p>Tämä taas näkyy tagin oman sisällön jälkeen.</p>'

If the tag does not produce any content, neither the content of the after and before attributes will be output.

escape:

Adds an escape character before quotation marks in the output.

The attribute makes it easier to process the tag-produced content when using JavaScript.

Allowed values:true/false. The default value is false.

or:

Defines alternative content that is displayed if the tag itself does not produce any content.

Allowed values:HTML and Interface markup.

E.g. or:'Sisältöä ei löytynyt.'