Transaction

Type

Class

Namespace

craft\commerce\models

Inherits

craft\commerce\models\Transaction » craft\commerce\base\Model » craft\base\Model (opens new window) » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)

Implements

ArrayAccess (opens new window), IteratorAggregate (opens new window), yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)

Uses traits

craft\base\ClonefixTrait (opens new window), yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)

Since

2.0

Class Transaction

View source (opens new window)

Public Properties

Property	Description
activeValidators (opens new window)	yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
amount	float (opens new window) – Amount
amountAsCurrency	string (opens new window)
attributes (opens new window)	array (opens new window) – Attribute values (name => value).
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
childTransactions	array (opens new window), craft\commerce\models\Transaction[] – child transactions
code	string (opens new window) – Code
currency	string (opens new window) – Currency
dateCreated	DateTime (opens new window), null (opens new window) – The date that the transaction was created
dateUpdated	DateTime (opens new window), null (opens new window) – The date that the transaction was last updated
errors (opens new window)	array (opens new window) – Errors for all attributes or the specified attribute. Empty array is returned if no error. See getErrors() (opens new window) for detailed description. Note that when returning errors for all attributes, the result is a two-dimensional array, like the following: php [ 'username' => [ 'Username is required.', 'Username must contain only word characters.', ], 'email' => [ 'Email address is invalid.', ] ] .
firstErrors (opens new window)	array (opens new window) – The first errors. The array keys are the attribute names, and the array values are the corresponding error messages. An empty array will be returned if there is no error.
gateway	craft\commerce\base\Gateway
gatewayId	integer (opens new window) – Gateway ID
hash	string (opens new window) – Hash
id	integer (opens new window) – ID
iterator (opens new window)	ArrayIterator (opens new window) – An iterator for traversing the items in the list.
message	string (opens new window) – Message
note	string (opens new window) – Note
order	craft\commerce\elements\Order
orderId	integer (opens new window) – Order ID
parent	craft\commerce\models\Transaction
parentId	integer (opens new window) – Parent transaction ID
paymentAmount	float (opens new window) – Payment Amount
paymentAmountAsCurrency	string (opens new window)
paymentCurrency	string (opens new window) – Payment currency
paymentRate	float (opens new window) – Payment Rate
reference	string (opens new window) – Reference
refundableAmount	float (opens new window)
refundableAmountAsCurrency	string (opens new window)
response	mixed – Response
scenario (opens new window)	string (opens new window) – The scenario that this model is in. Defaults to SCENARIO_DEFAULT (opens new window).
status	string (opens new window) – Status
type	string (opens new window) – Transaction Type
userId	integer (opens new window) – User ID
validators (opens new window)	ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

amount

Type

float (opens new window)

Default value

null

Amount

View source (opens new window)

amountAsCurrency

Type

string (opens new window)

Default value

null

View source (opens new window)

childTransactions

Type

array (opens new window), craft\commerce\models\Transaction[]

Default value

null

child transactions

View source (opens new window)

code

Type

string (opens new window)

Default value

null

Code

View source (opens new window)

currency

Type

string (opens new window)

Default value

null

Currency

View source (opens new window)

dateCreated

Type

DateTime (opens new window), null (opens new window)

Default value

null

The date that the transaction was created

View source (opens new window)

dateUpdated

Type

DateTime (opens new window), null (opens new window)

Default value

null

The date that the transaction was last updated

View source (opens new window)

gateway

Type

craft\commerce\base\Gateway

Default value

null

View source (opens new window)

gatewayId

Type

integer (opens new window)

Default value

null

Gateway ID

View source (opens new window)

hash

Type

string (opens new window)

Default value

null

Hash

View source (opens new window)

id

Type

integer (opens new window)

Default value

null

ID

View source (opens new window)

message

Type

string (opens new window)

Default value

null

Message

View source (opens new window)

note

Type

string (opens new window)

Default value

''

Note

View source (opens new window)

order

Type

craft\commerce\elements\Order

Default value

null

View source (opens new window)

orderId

Type

integer (opens new window)

Default value

null

Order ID

View source (opens new window)

parent

Type

craft\commerce\models\Transaction

Default value

null

View source (opens new window)

parentId

Type

integer (opens new window)

Default value

null

Parent transaction ID

View source (opens new window)

paymentAmount

Type

float (opens new window)

Default value

null

Payment Amount

View source (opens new window)

paymentAmountAsCurrency

Type

string (opens new window)

Default value

null

View source (opens new window)

paymentCurrency

Type

string (opens new window)

Default value

null

Payment currency

View source (opens new window)

paymentRate

Type

float (opens new window)

Default value

null

Payment Rate

View source (opens new window)

reference

Type

string (opens new window)

Default value

null

Reference

View source (opens new window)

refundableAmount

Type

float (opens new window)

Default value

null

View source (opens new window)

refundableAmountAsCurrency

Type

string (opens new window)

Default value

null

View source (opens new window)

response

Type

mixed

Default value

null

Response

View source (opens new window)

status

Type

string (opens new window)

Default value

null

Status

View source (opens new window)

type

Type

string (opens new window)

Default value

null

Transaction Type

View source (opens new window)

userId

Type

integer (opens new window)

Default value

null

User ID

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

__construct()

Constructor.

The default implementation does two things:

• Initializes the object with the given configuration $config.
• Call init() (opens new window).

If this method is overridden in a child class, it is recommended that

• the last parameter of the constructor is a configuration array, like $config here.
• call the parent implementation at the end of the constructor.

View source (opens new window)

Arguments

• $attributes

addChildTransaction()

Adds a child transaction.

View source (opens new window)

Arguments

• $transaction (craft\commerce\models\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 (opens new window)

Returns

array (opens new window) – List of attribute names.

behaviors()

View source (opens new window)

canCapture()

View source (opens new window)

Returns

boolean (opens new window)

canRefund()

View source (opens new window)

Returns

boolean (opens new window)

currencyAttributes()

View source (opens new window)

Returns

array (opens new window), string (opens new window)[]

extraFields()

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

This method is similar to fields() (opens new window) except that the list of fields returned by this method are not returned by default by toArray() (opens new window). Only when field names to be expanded are explicitly specified when calling toArray() (opens new window), 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 (opens new window)

Returns

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

getChildTransactions()

Returns child transactions.

View source (opens new window)

Returns

craft\commerce\models\Transaction[]

getGateway()

View source (opens new window)

Returns

craft\commerce\base\Gateway, null (opens new window)

getOrder()

View source (opens new window)

Returns

craft\commerce\elements\Order, null (opens new window)

getParent()

View source (opens new window)

Returns

craft\commerce\models\Transaction, null (opens new window)

getRefundableAmount()

View source (opens new window)

Returns

float (opens new window)

setChildTransactions()

Sets child transactions.

View source (opens new window)

Arguments

• $transactions (array (opens new window))

setGateway()

View source (opens new window)

Arguments

• $gateway (craft\commerce\base\Gateway)

setOrder()

View source (opens new window)

Arguments

• $order (craft\commerce\elements\Order)

Protected Methods

Method	Description
defineRules()	Returns the validation rules for attributes.
extractFieldsFor() (opens new window)	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() (opens new window)	Extracts the root field names from nested fields.
resolveFields() (opens new window)	Determines which fields can be returned by toArray() (opens new window).

defineRules()

Returns the validation rules for attributes.

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

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

View source (opens new window)

Returns

array (opens new window)

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.