subtotal
Returns the subtotal cost, exclusive of sales tax, of all the items placed
in the named cart so far.
Summary
| Parameter
|
Description
|
Default
|
| name |
The name of the cart to report on. |
main |
| cart |
Alias for name. |
main |
| convert |
Convert the amount according to the PriceDivide value for the current locale. |
No
|
| display |
Display the currency identifier as a symbol, as plain text or not at all. |
symbol
|
| locale |
Override the current locale for the currency format. |
None |
| noformat |
Suppress currency formatting from the amount. |
No
|
Examples
Tag expansion example
Perl example
$Tag->subtotal({
name => $name,
noformat => $noformat
});
|
or similarly with positional parameters:
|
$Tag->subtotal($name, $noformat);
|
Description
Returns the subtotal cost, exclusive of sales tax, of all the items placed
in the named cart so far.
If the noformat parameter is true then the raw number
with no currency formatting will be returned.
|
Note
The output of this tag can be overridden with the use of the [assign] tag.
|
Parameters
mode
The name of the cart to report on.
The default is "main".
convert
If true then convert the amount according to the
PriceDivide value for the current locale.
See the [currency] tag for a
usage example.
display
The currency identifier will usually be displayed as a symbol
(i.e. "£" or "$" etc.).
If this parameter is set to "text" then the currency
identifier will be displayed as plain text
(i.e. "GBP" or "USD" etc.), depending upon the locale settings.
If this parameter is set to "none" then the currency
identifier will not be displayed at all.
See the [currency] tag.
locale
This parameter allows you to override the current locale that would
be used to format the result and provide the exchange rate.
See the [currency] tag.
|
|
Note
Setting this parameter causes the convert parameter to
also be set, unless you specify "convert=0".
|
noformat
If true then suppress currency formatting from the value
returned from this tag.
See the [currency] tag.
