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, 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

PropertyDescription
$activeValidatorsyii\validators\Validator – The validators applicable to the current $scenario.
$amountfloat – Amount
$attributesarray – Attribute values (name => value).
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$childTransactionscraft\commerce\models\Transaction[]
$codestring – Code
$currencystring – Currency
$dateCreatedDateTime, null – The date that the transaction was created
$dateUpdatedDateTime, null – The date that the transaction was last updated
$errorsarray – Errors for all attributes or the specified attribute.
$firstErrorsarray – The first errors.
$gatewaycraft\commerce\base\Gateway, null
$gatewayIdinteger – Gateway ID
$hashstring – Hash
$idinteger – ID
$iteratorArrayIterator – An iterator for traversing the items in the list.
$messagestring – Message
$notestring – Note
$ordercraft\commerce\elements\Order, null
$orderIdinteger – Order ID
$parentcraft\commerce\models\Transaction, null
$parentIdinteger – Parent transaction ID
$paymentAmountfloat – Payment Amount
$paymentCurrencystring – Payment currency
$paymentRatefloat – Payment Rate
$referencestring – Reference
$refundableAmountfloat
$responseMixed – Response
$scenariostring – The scenario that this model is in.
$statusstring – Status
$typestring – Transaction Type
$userIdinteger – User ID
$validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

$amount

Signature

public float $amount = null

$childTransactions

Signature

public craft\commerce\models\Transaction[] getChildTransactions ( )
public void setChildTransactions ( array $transactions )

$code

Signature

public string $code = null

$currency

Type
string

Currency

View source

Signature

public string $currency = null

$dateCreated

Type
DateTime, null

The date that the transaction was created

View source

Signature

public DateTime, null $dateCreated = null

$dateUpdated

Type
DateTime, null

The date that the transaction was last updated

View source

Signature

public DateTime, null $dateUpdated = null

$gateway

Signature

public craft\commerce\base\Gateway, null getGateway ( )
public void setGateway ( craft\commerce\base\Gateway $gateway )

$gatewayId

Type
integer

Gateway ID

View source

Signature

public integer $gatewayId = null

$hash

Signature

public string $hash = null

$id

Signature

public integer $id = null

$message

Signature

public string $message = null

$note

Signature

public string $note = ''

$order

Signature

public craft\commerce\elements\Order, null getOrder ( )
public void setOrder ( craft\commerce\elements\Order $order )

$orderId

Type
integer

Order ID

View source

Signature

public integer $orderId = null

$parent

Signature

public craft\commerce\models\Transaction, null getParent ( )

$parentId

Type
integer

Parent transaction ID

View source

Signature

public integer $parentId = null

$paymentAmount

Type
float

Payment Amount

View source

Signature

public float $paymentAmount = null

$paymentCurrency

Type
string

Payment currency

View source

Signature

public string $paymentCurrency = null

$paymentRate

Type
float

Payment Rate

View source

Signature

public float $paymentRate = null

$reference

Type
string

Reference

View source

Signature

public string $reference = null

$refundableAmount

Type
float
Access
Read-only

View source

Signature

public float getRefundableAmount ( )

$response

Type
Mixed

Response

View source

Signature

public Mixed $response = null

$status

Signature

public string $status = null

$type

Type
string

Transaction Type

View source

Signature

public string $type = null

$userId

Signature

public integer $userId = null

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__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.
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()Returns a list of behaviors that this component should behave as.
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().
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.
getError()Returns the first error of the specified attribute.
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.
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()

Constructor.

The default implementation does two things:

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

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

Arguments

  • $attributes

Signature

public void __construct ( $attributes = null )

addChildTransaction()

Adds a child transaction.

View source

Arguments

Signature

public void addChildTransaction ( craft\commerce\models\Transaction $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

array – List of attribute names.

Signature

public array attributes ( )

canCapture()

Signature

public boolean canCapture ( )

canRefund()

Signature

public boolean canRefund ( )

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.

Signature

public array extraFields ( )

getChildTransactions()

Returns child transactions.

View source

Returns

craft\commerce\models\Transaction[]

Signature

public craft\commerce\models\Transaction[] getChildTransactions ( )

getGateway()

Signature

public craft\commerce\base\Gateway, null getGateway ( )

getOrder()

Signature

public craft\commerce\elements\Order, null getOrder ( )

getParent()

Signature

public craft\commerce\models\Transaction, null getParent ( )

getRefundableAmount()

Signature

public float getRefundableAmount ( )

rules()

Returns the validation rules for attributes.

Validation rules are used by validate() to check if attribute values are valid. Child classes may override this method to declare different validation rules.

Each rule is an array with the following structure:

[
    ['attribute1', 'attribute2'],
    'validator type',
    'on' => ['scenario1', 'scenario2'],
    //...other parameters...
]

where

  • attribute list: required, specifies the attributes array to be validated, for single attribute you can pass a string;
  • validator type: required, specifies the validator to be used. It can be a built-in validator name, a method name of the model class, an anonymous function, or a validator class name.
  • on: optional, specifies the scenarios array in which the validation rule can be applied. If this option is not set, the rule will apply to all scenarios.
  • additional name-value pairs can be specified to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties.

A validator can be either an object of a class extending \craft\commerce\models\Validator, or a model class method (called inline validator) that has the following signature:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

In the above $attribute refers to the attribute currently being validated while $params contains an array of validator configuration options such as max in case of string validator. The value of the attribute currently being validated can be accessed as $this->$attribute. Note the $ before attribute; this is taking the value of the variable $attribute and using it as the name of the property to access.

Yii also provides a set of \craft\commerce\models\Validator::builtInValidators. Each one has an alias name which can be used when specifying a validation rule.

Below are some examples:

[
    // built-in "required" validator
    [['username', 'password'], 'required'],
    // built-in "string" validator customized with "min" and "max" properties
    ['username', 'string', 'min' => 3, 'max' => 12],
    // built-in "compare" validator that is used in "register" scenario only
    ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
    // an inline validator defined via the "authenticate()" method in the model class
    ['password', 'authenticate', 'on' => 'login'],
    // a validator of class "DateRangeValidator"
    ['dateRange', 'DateRangeValidator'],
];

Note, in order to inherit rules defined in the parent class, a child class needs to merge the parent rules with child rules using functions such as array_merge().

View source

Returns

array – Validation rules

Signature

public array rules ( )

setChildTransactions()

Sets child transactions.

View source

Arguments

Signature

public void setChildTransactions ( array $transactions )

setGateway()

Signature

public void setGateway ( craft\commerce\base\Gateway $gateway )

setOrder()

Signature

public void setOrder ( craft\commerce\elements\Order $order )

Protected Methods

MethodDescription
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().

Constants

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.