Currencies

Type
Class
Namespace
craft\commerce\services
Inherits
craft\commerce\services\Currencies » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
2.0

Currency service.

View source

Public Properties

PropertyDescription
$allCurrenciescraft\commerce\models\Currency[]
$behaviorsyii\base\Behavior – List of behaviors attached to this component

$allCurrencies

Signature

public craft\commerce\models\Currency[] getAllCurrencies ( )

Public Methods

MethodDescription
__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 an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to 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.
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.
getAllCurrencies()Get a list of all available currencies.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getCurrencyByIso()Get a currency by it's ISO code.
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.
init()Initializes the object.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
trigger()Triggers an event.

getAllCurrencies()

Get a list of all available currencies.

View source

Returns

craft\commerce\models\Currency[]

Signature

public craft\commerce\models\Currency[] getAllCurrencies ( )

getCurrencyByIso()

Get a currency by it's ISO code.

View source

Arguments

Returns

craft\commerce\models\Currency, null

Signature

public craft\commerce\models\Currency, null getCurrencyByIso ( \craft\commerce\services\string $iso )