Transaction

Type

Class

Namespace

craft\commerce\models

Inherits

craft\commerce\models\Transaction » 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

Class Transaction

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
amount	float – Amount
amountAsCurrency	string
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
childTransactions	array, craft\commerce\models\Transaction[] – child transactions
code	string, null – Code
currency	string, null – Currency
dateCreated	DateTime, null – The date that the transaction was created
dateUpdated	DateTime, null – The date that the transaction was last updated
errors	array – Errors for all attributes or the specified attribute.
firstErrors	array – The first errors.
gateway	craft\commerce\base\Gateway
gatewayId	integer, null – Gateway ID
hash	string, null – Hash
id	integer, null – ID
iterator	ArrayIterator – An iterator for traversing the items in the list.
message	string, null – Message
note	string – Note
order	craft\commerce\elements\Order
orderId	integer, null – Order ID
parent	craft\commerce\models\Transaction
parentId	integer, null – Parent transaction ID
paymentAmount	float – Payment Amount
paymentAmountAsCurrency	string
paymentCurrency	string, null – Payment currency
paymentRate	float – Payment Rate
reference	string, null – Reference
refundableAmount	float
refundableAmountAsCurrency	string
response	mixed – Response
scenario	string – The scenario that this model is in.
status	string, null – Status
type	string, null – Transaction Type
userId	integer, null – User ID
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

amount

Type

float

Default value

null

Amount

View source

amountAsCurrency

Type

string

Default value

null

View source

childTransactions

Type

array, craft\commerce\models\Transaction[]

Default value

null

child transactions

View source

code

Type

string, null

Default value

null

Code

View source

currency

Type

string, null

Default value

null

Currency

View source

dateCreated

Type

DateTime, null

Default value

null

The date that the transaction was created

View source

dateUpdated

Type

DateTime, null

Default value

null

The date that the transaction was last updated

View source

gateway

Type

craft\commerce\base\Gateway

Default value

null

View source

gatewayId

Type

integer, null

Default value

null

Gateway ID

View source

hash

Type

string, null

Default value

null

Hash

View source

id

Type

integer, null

Default value

null

ID

View source

message

Type

string, null

Default value

null

Message

View source

note

Type

string

Default value

''

Note

View source

order

Type

craft\commerce\elements\Order

Default value

null

View source

orderId

Type

integer, null

Default value

null

Order ID

View source

parent

Type

craft\commerce\models\Transaction

Default value

null

View source

parentId

Type

integer, null

Default value

null

Parent transaction ID

View source

paymentAmount

Type

float

Default value

null

Payment Amount

View source

paymentAmountAsCurrency

Type

string

Default value

null

View source

paymentCurrency

Type

string, null

Default value

null

Payment currency

View source

paymentRate

Type

float

Default value

null

Payment Rate

View source

reference

Type

string, null

Default value

null

Reference

View source

refundableAmount

Type

float

Default value

null

View source

refundableAmountAsCurrency

Type

string

Default value

null

View source

response

Type

mixed

Default value

null

Response

View source

status

Type

string, null

Default value

null

Status

View source

type

Type

string, null

Default value

null

Transaction Type

View source

userId

Type

integer, null

Default value

null

User ID

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.
__unset()	Sets a component property to be null.
activeAttributes()	Returns the attribute names that are subject to validation in the current scenario.
addChildTransaction()	Adds a child transaction.
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()
canCapture()
canGetProperty()	Returns a value indicating whether a property can be read.
canRefund()
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().
currencyAttributes()
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.
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.
getChildTransactions()	Returns child transactions.
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.
getGateway()
getIterator()	Returns an iterator for traversing the attributes in the model.
getOrder()
getParent()
getRefundableAmount()
getScenario()	Returns the scenario that this model is used in.
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()	Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios()	Returns a list of scenarios and the corresponding active attributes.
setAttributes()	Sets the attribute values in a massive way.
setChildTransactions()	Sets child transactions.
setGateway()
setOrder()
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.

__construct()

View source

Arguments

• $attributes

addChildTransaction()

Adds a child transaction.

View source

Arguments

• $transaction

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.

behaviors()

View source

canCapture()

View source

Throws

• yii\base\InvalidConfigException

canRefund()

View source

Throws

• yii\base\InvalidConfigException

currencyAttributes()

View source

Returns

array

extraFields()

Returns the list of fields that can be expanded further and returned by toArray().

This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray(). Only when field names to be expanded are explicitly specified when calling toArray(), will their values be exported.

The default implementation returns an empty array.

You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).

View source

Returns

array – The list of expandable field names or field definitions. Please refer to fields() on the format of the return value.

getChildTransactions()

Returns child transactions.

View source

Returns

craft\commerce\models\Transaction[]

Throws

• yii\base\InvalidConfigException

getGateway()

View source

Throws

• yii\base\InvalidConfigException

getOrder()

View source

Throws

• yii\base\InvalidConfigException

getParent()

View source

Throws

• yii\base\InvalidConfigException

getRefundableAmount()

View source

Throws

• yii\base\InvalidConfigException

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

setChildTransactions()

Sets child transactions.

View source

Arguments

• $transactions

setGateway()

View source

Arguments

• $gateway

setOrder()

View source

Arguments

• $order

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.