PaymentCurrency

Type

Class

Namespace

craft\commerce\models

Inherits

craft\commerce\models\PaymentCurrency » craft\commerce\base\Model » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, craft\base\ModelInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

Since

2.0

Currency model.

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
alphabeticCode	string
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
code	string, null
cpEditUrl	string
currency	\Money\Currency
dateCreated	DateTime, null
dateUpdated	DateTime, null
entity	string
errors	array – Errors for all attributes or the specified attribute.
firstErrors	array – The first errors.
id	integer, null – ID
iso	string, null – ISO code
iterator	ArrayIterator – An iterator for traversing the items in the list.
minorUnit	integer
name	null, string
numericCode	integer
primary	boolean
rate	float – Exchange rate vs primary currency
scenario	string – The scenario that this model is in.
store	craft\commerce\models\Store
storeId	integer, null – Store ID
subUnit	integer, null
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

alphabeticCode

Type

string

Default value

null

View source

code

Type

string, null

Default value

null

Access

Read-only

View source

cpEditUrl

Type

string

Default value

null

View source

currency

Type

\Money\Currency

Default value

null

View source

dateCreated

Type

DateTime, null

Default value

null

Since

3.4

View source

dateUpdated

Type

DateTime, null

Default value

null

Since

3.4

View source

entity

Type

string

Default value

null

View source

id

Type

integer, null

Default value

null

ID

View source

iso

Type

string, null

Default value

null

ISO code

View source

minorUnit

Type

integer

Default value

null

View source

name

Type

null, string

Default value

null

View source

numericCode

Type

integer

Default value

null

View source

primary

Type

boolean

Default value

null

Access

Read-only

View source

rate

Type

float

Default value

1

Exchange rate vs primary currency

View source

store

Type

craft\commerce\models\Store

Default value

null

Access

Read-only

View source

storeId

Type

integer, null

Default value

null

Store ID

View source

subUnit

Type

integer, null

Default value

null

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()
__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.
__toString()
__unset()	Sets a component property to be null.
activeAttributes()	Returns the attribute names that are subject to validation in the current scenario.
addError()	Adds a new error to the specified attribute.
addErrors()	Adds a list of errors.
addModelErrors()	Adds errors from another model, with a given attribute name prefix.
afterValidate()	This method is invoked after validation ends.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
attributeHints()	Returns the attribute hints.
attributeLabels()	Returns the attribute labels.
attributes()	Returns the list of attribute names.
beforeValidate()	This method is invoked before validation starts.
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.
clearErrors()	Removes errors for all attributes or a single attribute.
createValidators()	Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()	Returns the names of any attributes that should hold DateTime values.
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.
extraFields()	Returns the list of fields that can be expanded further and returned by toArray().
fields()	Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
formName()	Returns the form name that this model class should use.
generateAttributeLabel()	Generates a user friendly attribute label based on the give attribute name.
getActiveValidators()	Returns the validators applicable to the current scenario.
getAlphabeticCode()
getAttributeHint()	Returns the text hint for the specified attribute.
getAttributeLabel()	Returns the text label for the specified attribute.
getAttributes()	Returns attribute values.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getCode()
getCpEditUrl()
getCurrency()
getEntity()
getErrorSummary()	Returns the errors for all attributes as a one-dimensional array.
getErrors()	Returns the errors for all attributes or a single attribute.
getFirstError()	Returns the first error of the specified attribute.
getFirstErrors()	Returns the first error of every attribute in the model.
getIterator()	Returns an iterator for traversing the attributes in the model.
getMinorUnit()
getName()	Returns alias of getCurrency()
getNumericCode()
getPrimary()
getScenario()	Returns the scenario that this model is used in.
getStore()
getSubUnit()
getValidators()	Returns all the validators declared in rules().
hasErrors()	Returns a value indicating whether there is any validation error.
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.
instance()	Returns static class instance, which can be used to obtain meta information.
isAttributeActive()	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired()	Returns a value indicating whether the attribute is required.
isAttributeSafe()	Returns a value indicating whether the attribute is safe for massive assignments.
load()	Populates the model with input data.
loadMultiple()	Populates a set of models with the data from end user.
off()	Detaches an existing event handler from this component.
offsetExists()	Returns whether there is an element at the specified offset.
offsetGet()	Returns the element at the specified offset.
offsetSet()	Sets the element at the specified offset.
offsetUnset()	Sets the element value at the specified offset to null.
on()	Attaches an event handler to an event.
onUnsafeAttribute()	This method is invoked when an unsafe attribute is being massively assigned.
rules()	Returns the validation rules for attributes.
safeAttributes()
scenarios()	Returns a list of scenarios and the corresponding active attributes.
setAttributes()	Sets the attribute values in a massive way.
setScenario()	Sets the scenario for the model.
toArray()	Converts the model into an array.
trigger()	Triggers an event.
validate()	Performs the data validation.
validateMultiple()	Validates multiple models.

__toString()

View source

attributes()

Returns the list of attribute names.

By default, this method returns all public non-static properties of the class. You may override this method to change the default behavior.

View source

Returns

string[] – List of attribute names.

getAlphabeticCode()

View source

Returns

string, null

getCode()

View source

Returns

string, null

getCpEditUrl()

View source

Returns

string

Throws

• yii\base\InvalidConfigException

getCurrency()

View source

Returns

\Money\Currency

getEntity()

View source

getMinorUnit()

DEPRECATED

Deprecated Use getSubUnit() instead.

View source

Returns

integer, null

Throws

• yii\base\InvalidConfigException

getName()

Returns alias of getCurrency()

View source

getNumericCode()

View source

Returns

integer, null

Throws

• yii\base\InvalidConfigException

getPrimary()

View source

Returns

boolean

Throws

• yii\base\InvalidConfigException

getStore()

View source

Returns

craft\commerce\models\Store

Throws

• yii\base\InvalidConfigException

getSubUnit()

View source

Returns

integer, null

Throws

• yii\base\InvalidConfigException

safeAttributes()

View source

Protected Methods

Method	Description
defineBehaviors()	Returns the behaviors to attach to this class.
defineRules()	Returns the validation rules for attributes.
extractFieldsFor()	Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields()	Extracts the root field names from nested fields.
resolveFields()	Determines which fields can be returned by toArray().

defineRules()

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source

Returns

array

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.