Currency

Type

Class

Namespace

craft\commerce\helpers

Inherits

craft\commerce\helpers\Currency

Since

2.0

Class Currency

View source

Public Methods

Method	Description
defaultDecimals()
formatAsCurrency()	Formats and optionally converts a currency amount into the supplied valid payment currency as per the rate setup in payment currencies.
moneyInputHtml()
round()	Rounds the amount as per the currency minor unit information. Not passing a currency model results in rounding in default currency.

defaultDecimals()

View source

Returns

integer

Throws

• craft\commerce\errors\CurrencyException
• yii\base\InvalidConfigException

formatAsCurrency()

Formats and optionally converts a currency amount into the supplied valid payment currency as per the rate setup in payment currencies.

View source

Arguments

• $amount (mixed)
• $currency (mixed)
• $convert (boolean)
• $format (boolean)
• $stripZeros (boolean)

Returns

string

Throws

• craft\commerce\errors\CurrencyException
• yii\base\InvalidConfigException

moneyInputHtml()

Since

5.0.0

View source

Arguments

• $value (mixed)
• $config (array)

Returns

string

Throws

• yii\base\InvalidConfigException
• craft\web\twig\TemplateLoaderException

round()

Rounds the amount as per the currency minor unit information. Not passing a currency model results in rounding in default currency.

View source

Arguments

• $amount (float) – The amount as a decimal/float
• $currency (craft\commerce\models\PaymentCurrency, string, \Money\Currency, null)

Returns

float