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.

View source

# Public Properties

# allPaymentCurrencies

Type
craft\commerce\models\PaymentCurrency[]
Access
Read-only

View source

# primaryPaymentCurrency

Type
craft\commerce\models\PaymentCurrency, null
Access
Read-only

View source

# primaryPaymentCurrencyIso

Type
string
Access
Read-only

View source

# 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 currecny by its ISO code.
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.
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 currecny by its ISO code.

View source

Arguments

  • $amount (float) – This is the unit of price in the primary store currency
  • $currency (string)

Returns

float

Throws

# deletePaymentCurrencyById()

Delete a payment currency by its ID.

View source

Arguments

  • $id

Returns

boolean

# getAllPaymentCurrencies()

Get all payment currencies.

View source

Returns

craft\commerce\models\PaymentCurrency[]

Throws

# getPaymentCurrencyById()

Get payment currency by its ID.

View source

Arguments

Returns

craft\commerce\models\PaymentCurrency, null

Throws

# getPaymentCurrencyByIso()

Get a payment currency by its ISO code.

View source

Arguments

Returns

craft\commerce\models\PaymentCurrency, null

Throws

# getPrimaryPaymentCurrency()

Returns the primary currency all prices are entered as.

View source

Returns

craft\commerce\models\PaymentCurrency, null

# getPrimaryPaymentCurrencyIso()

Return the primary currencies ISO code as a string.

View source

Returns

string

# savePaymentCurrency()

Save a payment currency.

View source

Arguments

Returns

boolean

Throws