PaymentCurrencies

Type: Class
Namespace: craft\commerce\services
Inherits: craft\commerce\services\PaymentCurrencies » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: yii\base\Configurable (opens new window)
Since: 2.0

Payment currency service.

# Public Properties

Property	Description
allPaymentCurrencies	craft\commerce\models\PaymentCurrency[], array (opens new window)
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
nonPrimaryPaymentCurrencies	craft\commerce\models\PaymentCurrency[]
primaryPaymentCurrency	craft\commerce\models\PaymentCurrency, null (opens new window) – the primary currency all prices are entered as
primaryPaymentCurrencyIso	string (opens new window) – the primary currencies ISO code as a string

# `allPaymentCurrencies`

Type: craft\commerce\models\PaymentCurrency[], array (opens new window)
Default value: null

View source (opens new window)

# `nonPrimaryPaymentCurrencies`

Type: craft\commerce\models\PaymentCurrency[]
Default value: null
Access: Read-only

View source (opens new window)

# `primaryPaymentCurrency`

Type: craft\commerce\models\PaymentCurrency, null (opens new window)
Default value: null

the primary currency all prices are entered as

View source (opens new window)

# `primaryPaymentCurrencyIso`

Type: string (opens new window)
Default value: null

the primary currencies ISO code as a string

View source (opens new window)

# Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone() (opens new window)	This method is called after the object is created by cloning an existing one.
__construct() (opens new window)	Constructor.
__get() (opens new window)	Returns the value of a component property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets the value of a component property.
__unset() (opens new window)	Sets a component property to be null.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
className() (opens new window)	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.
convertCurrency()	Convert an amount between currencies based on rates configured.
deletePaymentCurrencyById()	Delete a payment currency by its ID.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
getAllPaymentCurrencies()	Get all payment currencies.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	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() (opens new window)	Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window)	Returns a value indicating whether a method is defined.
hasProperty() (opens new window)	Returns a value indicating whether a property is defined for this component.
init() (opens new window)	Initializes the object.
off() (opens new window)	Detaches an existing event handler from this component.
on() (opens new window)	Attaches an event handler to an event.
savePaymentCurrency()	Save a payment currency.
trigger() (opens new window)	Triggers an event.