PaymentCurrencies ​
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\PaymentCurrencies » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 2.0
Payment currency service.
Public Properties ​
| Property | Description |
|---|---|
| allPaymentCurrencies | craft\commerce\models\PaymentCurrency[], array |
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| nonPrimaryPaymentCurrencies | craft\commerce\models\PaymentCurrency[] |
| primaryPaymentCurrency | craft\commerce\models\PaymentCurrency, null – the primary currency all prices are entered as |
| primaryPaymentCurrencyIso | string – the primary currencies ISO code as a string |
allPaymentCurrencies ​
- Type
- craft\commerce\models\PaymentCurrency[], array
- Default value
null
nonPrimaryPaymentCurrencies ​
- Type
- craft\commerce\models\PaymentCurrency[]
- Default value
null
primaryPaymentCurrency ​
- Type
- craft\commerce\models\PaymentCurrency, null
- Default value
null
the primary currency all prices are entered as
primaryPaymentCurrencyIso ​
- Type
- string
- Default value
null
the primary currencies ISO code as a string
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | Constructor. |
| __get() | Returns the value of a component property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets the value of a component property. |
| __unset() | Sets a component property to be null. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| convert() | Convert an amount in site's primary currency to a different currency by its ISO code. |
| convertAmount() | |
| convertCurrency() | Convert an amount between currencies based on rates configured. |
| deletePaymentCurrencyById() | Delete a payment currency by its ID. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| getAllPaymentCurrencies() | Get all payment currencies. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getNonPrimaryPaymentCurrencies() | Returns the non primary payment currencies |
| getPaymentCurrencyById() | Get payment currency by its ID. |
| getPaymentCurrencyByIso() | Get a payment currency by its ISO code. |
| getPrimaryPaymentCurrency() | Returns the primary currency all prices are entered as. |
| getPrimaryPaymentCurrencyIso() | Return the primary currencies ISO code as a string. |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the object. |
| off() | Detaches an existing event handler from this component. |
| on() | Attaches an event handler to an event. |
| savePaymentCurrency() | Save a payment currency. |
| trigger() | Triggers an event. |
convert() ​
Convert an amount in site's primary currency to a different currency by its ISO code.
Arguments ​
$amount(float) – This is the unit of price in the primary store currency$currency
Throws ​
- craft\commerce\errors\CurrencyException
if currency not found by its ISO code - yii\base\InvalidConfigException
convertAmount() ​
- Since
- 5.0.0
Arguments ​
Returns ​
\Money\Money
Throws ​
- craft\commerce\errors\CurrencyException
- yii\base\InvalidConfigException
- craft\errors\SiteNotFoundException
convertCurrency() ​
DEPRECATED
Deprecated since version 5.0.0:
Convert an amount between currencies based on rates configured.
Arguments ​
Returns ​
Throws ​
- craft\commerce\errors\CurrencyException
if currency not found by its ISO code - yii\base\InvalidConfigException
deletePaymentCurrencyById() ​
Delete a payment currency by its ID.
Arguments ​
$id(integer)
Returns ​
Throws ​
getAllPaymentCurrencies() ​
Get all payment currencies.
Arguments ​
Returns ​
\Illuminate\Support\Collection<\craft\commerce\models\PaymentCurrency>
Throws ​
getNonPrimaryPaymentCurrencies() ​
Returns the non primary payment currencies
Arguments ​
$storeId
Returns ​
\Illuminate\Support\Collection<\craft\commerce\models\PaymentCurrency>
Throws ​
getPaymentCurrencyById() ​
Get payment currency by its ID.
Arguments ​
$id$storeId
Throws ​
- yii\base\InvalidConfigException
if currency has invalid iso code defined
getPaymentCurrencyByIso() ​
Get a payment currency by its ISO code.
Arguments ​
Returns ​
craft\commerce\models\PaymentCurrency, null
Throws ​
- craft\commerce\errors\CurrencyException
if currency does not exist with that iso code - yii\base\InvalidConfigException
- craft\errors\SiteNotFoundException
getPrimaryPaymentCurrency() ​
Returns the primary currency all prices are entered as.
Arguments ​
$storeId
Throws ​
getPrimaryPaymentCurrencyIso() ​
Return the primary currencies ISO code as a string.
Arguments ​
$storeId
savePaymentCurrency() ​
Save a payment currency.
Arguments ​
$model$runValidation(boolean) – Should we validate this payment currency before saving.