Documentation

Mage_Sales_Model_Order_Payment_Transaction extends Mage_Core_Model_Abstract
in package

Mage

Sales

Payment transaction model Tracks transaction history, allows to build transactions hierarchy By default transactions are saved as closed.

Constants

RAW_DETAILS : mixed = 'raw_details_info': Raw details key in additional info
TYPE_AUTH : mixed = 'authorization'
TYPE_CAPTURE : mixed = 'capture'
TYPE_ORDER : mixed = 'order'
TYPE_PAYMENT : string = 'payment': Supported transaction types
TYPE_REFUND : mixed = 'refund'
TYPE_VOID : mixed = 'void'

Properties

$_cacheTag : string|bool|array<string|int, mixed>: Model cache tag for clear cache in after save and after delete
$_children : array<string|int, mixed>: Child transactions, assoc array of transaction_id => instance
$_data : array<string|int, mixed>|null: Object attributes
$_dataSaveAllowed : bool: Flag which can stop data saving after before save Can be used for next sequence: we check data in _beforeSave, if data are not valid - we can set this flag to false value and save process will be stopped
$_dirty : array<string|int, mixed>
$_eventObject : string: Parameter name in event
$_eventPrefix : string: Prefix of model events names
$_hasChild : bool: Whether transaction has children
$_hasDataChanges : bool: Data changes flag (true after setData|unsetData call)
$_identifiedChildren : array<string|int, mixed>|false: Child transactions, assoc array of txn_id => instance Filled only in case when all child transactions have txn_id Used for quicker search of child transactions using isset() as opposite to foreaching $_children
$_idFieldName : string: Name of object id field
$_isDeleted : bool: Object delete flag
$_isFailsafe : bool: Whether to throw exceptions on different operations
$_isObjectNew : bool|null: Flag which allow detect object state: is it new object (without id) or existing one (with id)
$_oldFieldsMap : array<string|int, mixed>: Map short fields names to its full names
$_order : Mage_Sales_Model_Order|false: Order instance
$_orderWebsiteId : int|null
$_origData : array<string|int, mixed>|null: Original data that was loaded
$_parentTransaction : Mage_Sales_Model_Order_Payment_Transaction|false: Parent transaction instance
$_paymentObject : Mage_Sales_Model_Order_Payment: Payment instance. Required for most transaction writing and search operations
$_resource : Mage_Core_Model_Resource_Db_Abstract: Resource model instance
$_resourceCollectionName : string: Name of the resource collection model
$_resourceName : string: Name of the resource model
$_syncFieldsMap : mixed: Map of fields to sync to other fields upon changing their data
$_transactionsAutoLinking : bool: Whether to perform automatic actions on transactions, such as auto-closing and putting as a parent
$_underscoreCache : array<string|int, mixed>: Setter/Getter underscore transformation cache

Methods

__call() : mixed: Set/Get attribute wrapper
__construct() : mixed: Constructor
__get() : mixed: Attribute getter (deprecated)
__set() : mixed: Attribute setter (deprecated)
__toArray() : array<string|int, mixed>: Convert object attributes to array
_getResource() : Mage_Sales_Model_Resource_Order_Payment_Transaction: Get resource instance
addData() : $this: Add data to the object.
afterCommitCallback() : $this: Callback function which called after transaction commit in resource model
afterLoad() : $this: Object after load processing. Implemented as public interface for supporting objects after load in collections
canVoidAuthorizationCompletely() : bool: Check whether authorization in current hierarchy can be voided completely Basically checks whether the authorization exists and it is not affected by a capture or void
cleanModelCache() : $this: Remove model object related cache
clearInstance() : $this: Clearing object for correct deleting by garbage collector
close() : $this: Close this transaction
closeAuthorization() : $this|false: Close an authorization transaction This method can be invoked from any child transaction of the transaction to be closed Returns the authorization transaction on success. Otherwise false.
closeCapture() : bool|false|$this: Close a capture transaction Logic is similar to closeAuthorization(), but for a capture transaction
dataHasChangedFor() : bool: Compare object data with original data
debug() : string|array<string|int, mixed>: Present object data as string in debug mode
delete() : $this: Delete object from database
flagDirty() : $this
getAdditionalInformation() : array<string|int, mixed>|null|mixed: Getter for entire additional_information value or one of its element by key
getBillingAddress() : Mage_Customer_Model_Address_Abstract|null
getCacheIdTags() : array<string|int, mixed>|false: Get cache tags associated with object id
getCacheTags() : array<string|int, mixed>|false: Get list of cache tags applied to model object.
getChildTransactions() : $this|array<string|int, mixed>|null: Child transaction(s) getter Will attempt to load them first Can be filtered by types and/or transaction_id Returns transaction object if transaction_id is specified, otherwise - array TODO: $recursive is not implemented
getCollection() : Mage_Sales_Model_Resource_Order_Payment_Transaction_Collection
getCreatedAt() : string|null
getData() : mixed: Object data getter
getDataByKey() : mixed: Get object data by particular key
getDataByPath() : mixed: Get object data by path
getDataSetDefault() : mixed: Fast get data or set default if value is not available
getDataUsingMethod() : mixed: Get object data by key with calling getter method
getEntityId() : int
getHtmlTxnId() : string: Get HTML format for transaction id
getId() : int|string|null: Retrieve model object identifier
getIdFieldName() : string: Retrieve identifier field name for model
getIsClosed() : bool|null
getOrder() : Mage_Sales_Model_Order|false: Retrieve order instance
getOrderId() : int|null: Order ID getter Attempts to get ID from set order payment object, if any, or from data by key 'order_id'
getOrderPaymentObject() : Mage_Sales_Model_Order_Payment: Order Payment instance getter Will attempt to load by payment_id if it is set in data
getOrderWebsiteId() : int: Retrieve order website id
getOrigData() : mixed: Get object loaded data (original data)
getParentId() : int|null
getParentTransaction() : $this|false: Parent transaction getter May attempt to load it.
getParentTxnId() : string|null
getPaymentId() : int|null
getResource() : Mage_Sales_Model_Resource_Order_Payment_Transaction: Retrieve model resource
getResourceCollection() : Mage_Sales_Model_Resource_Order_Payment_Transaction_Collection: Get collection instance
getResourceName() : string: Retrieve model resource name
getShippingAddress() : Mage_Customer_Model_Address_Abstract|null
getTransactionTypes() : array<string|int, mixed>: Retrieve transaction types
getTxnId() : string|null
getTxnType() : string|null
hasChildTransaction() : bool|$this: Getter/Setter of whether current transaction has a child transaction
hasData() : bool: If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.
hasDataChanges() : bool: Get data change status
hasErrors() : bool
isDeleted() : bool: Set _isDeleted flag value (if $isDeleted param is defined) and return current flag value
isDirty() : bool
isEmpty() : bool: checks whether the object is empty
isFailsafe() : bool|$this: Setter/Getter whether transaction is supposed to prevent exceptions on saving
isModuleEnabled() : bool
isObjectNew() : bool: Check object state (true - if it is object without id on object just created) This method can help detect if object just created in _afterSave method problem is what in after save object has id and we can't detect what object was created in this transaction
isVoided() : bool: Check whether this transaction is voided
jsonSerialize() : array<string|int, mixed>: Implementation of JsonSerializable::jsonSerialize()
load() : $this: Load object data
loadByTxnId() : $this: Load self by specified transaction ID. Requires the valid payment object to be set
offsetExists() : bool: Implementation of ArrayAccess::offsetExists()
offsetGet() : mixed: Implementation of ArrayAccess::offsetGet()
offsetSet() : void: Implementation of ArrayAccess::offsetSet()
offsetUnset() : void: Implementation of ArrayAccess::offsetUnset()
save() : $this: Save object data
serialize() : string: serialize object attributes
setAdditionalInformation() : $this: Additional information setter Updates data inside the 'additional_information' array Doesn't allow to set arrays
setAttribute() : $this
setCreatedAt() : static
setData() : $this: Overwrite data in the object.
setDataChanges() : $this: Clears data changes status
setDataUsingMethod() : $this: Set object data with calling setter method
setId() : $this: Declare model object identifier value
setIdFieldName() : $this: set name of object id field
setIsClosed() : static
setOrder() : $this: Set order instance for transaction depends on transaction behavior If $order equals to true, method isn't loading new order instance.
setOrderId() : static
setOrderPaymentObject() : $this: Payment instance setter
setOrderUrl() : static
setOrigData() : $this: Initialize object original data
setParentId() : static
setParentTxnId() : $this: Parent transaction ID setter Can set the transaction id as well
setPaymentId() : static
setTxnId() : $this: Transaction ID setter
setTxnType() : $this: Transaction type setter
setUpdatedAt() : static
toArray() : array<string|int, mixed>: Public wrapper for __toArray
toJson() : string: Public wrapper for __toJson
toString() : string: Public wrapper for __toString
toXml() : string: Public wrapper for __toXml
unsAdditionalInformation() : $this: Unsetter for entire additional_information value or one of its element by key
unsetData() : $this: Unset data from the object.
unsetOldData() : $this: Unset old fields data from the object.
__toJson() : string: Convert object attributes to JSON
__toXml() : string: Convert object attributes to XML
_addFullNames() : mixed
_afterDelete() : $this: Processing object after delete data
_afterDeleteCommit() : $this: Processing manipulation after main transaction commit
_afterLoad() : $this: Processing object after load data
_afterLoadByTxnId() : $this: Check object after loading by by specified transaction ID
_afterSave() : $this: Processing object after save data
_beforeDelete() : $this: Processing object before delete data
_beforeLoad() : $this: Processing object before load data
_beforeLoadByTxnId() : $this: Check object before loading by by specified transaction ID
_beforeSave() : $this: Verify data required for saving
_camelize() : string
_clearData() : $this: Clearing object's data
_clearReferences() : $this: Clearing cyclic references
_construct() : void: Internal constructor not depended on params. Can be used for object initialization
_getData() : mixed: Get value from _data array without parse key
_getEventData() : array<string|int, mixed>: Get array of objects transferred to default events processing
_hasModelChanged() : bool: Check whether model has changed data.
_init() : mixed: Standard model initialization
_initOldFieldsMap() : mixed: Inits mapping array of object's previously used fields to new fields.
_isVoided() : bool: Check whether this transaction is voided TODO: implement that there should be only one void per authorization
_loadChildren() : mixed: Load child transactions
_prepareArray() : array<string|int, mixed>: Set required array elements
_prepareSyncFieldsMap() : $this: Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.
_protectFromNonAdmin() : mixed: Safeguard func that will check, if we are in admin area
_setResourceModel() : mixed: Set resource names
_underscore() : string: Converts field names for setters and getters
_verifyPaymentObject() : Mage_Sales_Model_Order_Payment|null|false: Check whether the payment object is set and it has order object or there is an order_id is set $dryRun allows to not throw exception
_verifyThisTransactionExists() : mixed: Make sure this object is a valid transaction TODO for more restriction we can check for data consistency
_verifyTxnId() : mixed: Check whether specified transaction ID is valid
_verifyTxnType() : mixed: Check whether specified or set transaction type is supported

RAW_DETAILS

Raw details key in additional info


    public
        mixed
    RAW_DETAILS
    = 'raw_details_info'

TYPE_AUTH


    public
        mixed
    TYPE_AUTH
    = 'authorization'

TYPE_CAPTURE


    public
        mixed
    TYPE_CAPTURE
    = 'capture'

TYPE_ORDER


    public
        mixed
    TYPE_ORDER
    = 'order'

TYPE_PAYMENT

Supported transaction types


    public
        string
    TYPE_PAYMENT
    = 'payment'

TYPE_REFUND


    public
        mixed
    TYPE_REFUND
    = 'refund'

TYPE_VOID


    public
        mixed
    TYPE_VOID
    = 'void'

$_cacheTag

Model cache tag for clear cache in after save and after delete


        protected
            string|bool|array<string|int, mixed>
    $_cacheTag
     = \false

When you use true - all cache will be clean

$_children

Child transactions, assoc array of transaction_id => instance


        protected
            array<string|int, mixed>
    $_children
     = \null

$_data

Object attributes


        protected
            array<string|int, mixed>|null
    $_data
     = []

$_dataSaveAllowed

Flag which can stop data saving after before save Can be used for next sequence: we check data in _beforeSave, if data are not valid - we can set this flag to false value and save process will be stopped


        protected
            bool
    $_dataSaveAllowed
     = \true

$_dirty


        protected
            array<string|int, mixed>
    $_dirty

$_eventObject

Parameter name in event


        protected
            string
    $_eventObject
     = 'order_payment_transaction'

$_eventPrefix

Prefix of model events names


        protected
            string
    $_eventPrefix
     = 'sales_order_payment_transaction'

$_hasChild

Whether transaction has children


        protected
            bool
    $_hasChild
     = \null

$_hasDataChanges

Data changes flag (true after setData|unsetData call)


        protected
            bool
    $_hasDataChanges
     = false

$_identifiedChildren

Child transactions, assoc array of txn_id => instance Filled only in case when all child transactions have txn_id Used for quicker search of child transactions using isset() as opposite to foreaching $_children


        protected
            array<string|int, mixed>|false
    $_identifiedChildren
     = \null

$_idFieldName

Name of object id field


        protected
            string
    $_idFieldName
     = null

$_isDeleted

Object delete flag


        protected
            bool
    $_isDeleted
     = false

$_isFailsafe

Whether to throw exceptions on different operations


        protected
            bool
    $_isFailsafe
     = \false

$_isObjectNew

Flag which allow detect object state: is it new object (without id) or existing one (with id)


        protected
            bool|null
    $_isObjectNew
     = \null

$_oldFieldsMap

Map short fields names to its full names


        protected
            array<string|int, mixed>
    $_oldFieldsMap
     = []

$_order

Order instance


        protected
            Mage_Sales_Model_Order|false
    $_order
     = \null

$_orderWebsiteId


        protected
            int|null
    $_orderWebsiteId
     = \null

$_origData

Original data that was loaded


        protected
            array<string|int, mixed>|null
    $_origData

$_parentTransaction

Parent transaction instance


        protected
            Mage_Sales_Model_Order_Payment_Transaction|false
    $_parentTransaction
     = \null

$_paymentObject

Payment instance. Required for most transaction writing and search operations


        protected
            Mage_Sales_Model_Order_Payment
    $_paymentObject
     = \null

$_resource

Resource model instance


        protected
            Mage_Core_Model_Resource_Db_Abstract
    $_resource

$_resourceCollectionName

Name of the resource collection model


        protected
            string
    $_resourceCollectionName

$_resourceName

Name of the resource model


        protected
            string
    $_resourceName

$_syncFieldsMap

Map of fields to sync to other fields upon changing their data


        protected
            mixed
    $_syncFieldsMap
     = []

$_transactionsAutoLinking

Whether to perform automatic actions on transactions, such as auto-closing and putting as a parent


        protected
            bool
    $_transactionsAutoLinking
     = \true

$_underscoreCache

Setter/Getter underscore transformation cache


        protected
        static    array<string|int, mixed>
    $_underscoreCache
     = []

__call()

Set/Get attribute wrapper


    public
                    __call(string $method, array<string|int, mixed> $args) : mixed

Parameters

$method : string
$args : array<string|int, mixed>

__construct()

Constructor


    public
                    __construct() : mixed

By default, is looking for first argument as array and assigns it as object attributes This behaviour may change in child classes

__get()

Attribute getter (deprecated)


    public
                    __get(string $var) : mixed

Parameters

$var : string

__set()

Attribute setter (deprecated)


    public
                    __set(string $var, mixed $value) : mixed

Parameters

$var : string
$value : mixed

__toArray()

Convert object attributes to array


    public
                    __toArray([array<string|int, mixed> $arrAttributes = [] ]) : array<string|int, mixed>

Parameters

$arrAttributes : array<string|int, mixed> = []: array of required attributes

Return values

array<string|int, mixed>

_getResource()

Get resource instance


    public
                    _getResource() : Mage_Sales_Model_Resource_Order_Payment_Transaction

Return values

Mage_Sales_Model_Resource_Order_Payment_Transaction

addData()

Add data to the object.


    public
                    addData(array<string|int, mixed> $arr) : $this

Retains previous data in the object.

Parameters

$arr : array<string|int, mixed>

Return values

$this

afterCommitCallback()

Callback function which called after transaction commit in resource model


    public
                    afterCommitCallback() : $this

Return values

$this

afterLoad()

Object after load processing. Implemented as public interface for supporting objects after load in collections


    public
                    afterLoad() : $this

Return values

$this

canVoidAuthorizationCompletely()

Check whether authorization in current hierarchy can be voided completely Basically checks whether the authorization exists and it is not affected by a capture or void


    public
                    canVoidAuthorizationCompletely() : bool

Return values

bool

cleanModelCache()

Remove model object related cache


    public
                    cleanModelCache() : $this

Return values

$this

clearInstance()

Clearing object for correct deleting by garbage collector


    public
        final            clearInstance() : $this

Return values

$this

close()

Close this transaction


    public
                    close([bool $shouldSave = true ]) : $this

Parameters

$shouldSave : bool = true

Return values

$this

closeAuthorization()

Close an authorization transaction This method can be invoked from any child transaction of the transaction to be closed Returns the authorization transaction on success. Otherwise false.


    public
                    closeAuthorization([bool $shouldSave = true ][, bool $dryRun = false ]) : $this|false

$dryRun = true prevents actual closing, it just allows to check whether this operation is possible

Parameters

$shouldSave : bool = true
$dryRun : bool = false

Return values

$this|false

closeCapture()

Close a capture transaction Logic is similar to closeAuthorization(), but for a capture transaction


    public
                    closeCapture([bool $shouldSave = true ]) : bool|false|$this

Parameters

$shouldSave : bool = true

Return values

bool|false|$this

dataHasChangedFor()

Compare object data with original data


    public
                    dataHasChangedFor(string $field) : bool

Parameters

$field : string

Return values

bool

debug()

Present object data as string in debug mode


    public
                    debug([mixed $data = null ][, array<string|int, mixed> &$objects = [] ]) : string|array<string|int, mixed>

Parameters

$data : mixed = null
$objects : array<string|int, mixed> = []

Return values

string|array<string|int, mixed>

delete()

Delete object from database


    public
                    delete() : $this

Return values

$this

flagDirty()


    public
                    flagDirty(string $field[, bool $flag = true ]) : $this

Parameters

$field : string
$flag : bool = true

Return values

$this

getAdditionalInformation()

Getter for entire additional_information value or one of its element by key


    public
                    getAdditionalInformation([string $key = null ]) : array<string|int, mixed>|null|mixed

Parameters

$key : string = null

Return values

array<string|int, mixed>|null|mixed

getBillingAddress()


    public
                    getBillingAddress() : Mage_Customer_Model_Address_Abstract|null

Return values

Mage_Customer_Model_Address_Abstract|null

getCacheIdTags()

Get cache tags associated with object id


    public
                    getCacheIdTags() : array<string|int, mixed>|false

Return values

array<string|int, mixed>|false

getCacheTags()

Get list of cache tags applied to model object.


    public
                    getCacheTags() : array<string|int, mixed>|false

Return false if cache tags are not supported by model

Return values

array<string|int, mixed>|false

getChildTransactions()

Child transaction(s) getter Will attempt to load them first Can be filtered by types and/or transaction_id Returns transaction object if transaction_id is specified, otherwise - array TODO: $recursive is not implemented


    public
                    getChildTransactions([array<string|int, mixed>|string $types = null ][, string $txnId = null ][, bool $recursive = false ]) : $this|array<string|int, mixed>|null

Parameters

$types : array<string|int, mixed>|string = null
$txnId : string = null
$recursive : bool = false

Return values

$this|array<string|int, mixed>|null

getCollection()


    public
                    getCollection() : Mage_Sales_Model_Resource_Order_Payment_Transaction_Collection

()

Return values

Mage_Sales_Model_Resource_Order_Payment_Transaction_Collection

getCreatedAt()


    public
                    getCreatedAt() : string|null

Return values

string|null

getData()

Object data getter


    public
                    getData([string $key = '' ][, string|int $index = null ]) : mixed

If $key is not defined will return all the data as an array. Otherwise, it will return value of the element specified by $key. It is possible to use keys like a/b/c for access nested array data

If $index is specified it will assume that attribute data is an array and retrieve corresponding member. If data is the string - it will be explode by new line character and converted to array.

Parameters

$key : string = ''
$index : string|int = null

getDataByKey()

Get object data by particular key


    public
                    getDataByKey(string $key) : mixed

Parameters

$key : string

getDataByPath()

Get object data by path


    public
                    getDataByPath(string $path) : mixed

Method consider the path as chain of keys: a/b/c => ['a']['b']['c']

Parameters

$path : string

getDataSetDefault()

Fast get data or set default if value is not available


    public
                    getDataSetDefault(string $key, mixed $default) : mixed

Parameters

$key : string
$default : mixed

getDataUsingMethod()

Get object data by key with calling getter method


    public
                    getDataUsingMethod(string $key[, mixed $args = null ]) : mixed

Parameters

$key : string
$args : mixed = null

getEntityId()


    public
                    getEntityId() : int

Return values

int

getHtmlTxnId()

Get HTML format for transaction id


    public
                    getHtmlTxnId() : string

Return values

string

getId()

Retrieve model object identifier


    public
                    getId() : int|string|null

#[Override]

Return values

int|string|null

getIdFieldName()

Retrieve identifier field name for model


    public
                    getIdFieldName() : string

#[Override]

Return values

string

getIsClosed()


    public
                    getIsClosed() : bool|null

Return values

bool|null

getOrder()

Retrieve order instance


    public
                    getOrder() : Mage_Sales_Model_Order|false

Return values

Mage_Sales_Model_Order|false

getOrderId()

Order ID getter Attempts to get ID from set order payment object, if any, or from data by key 'order_id'


    public
                    getOrderId() : int|null

Return values

int|null

getOrderPaymentObject()

Order Payment instance getter Will attempt to load by payment_id if it is set in data


    public
                    getOrderPaymentObject([bool $shouldLoad = true ]) : Mage_Sales_Model_Order_Payment

Parameters

$shouldLoad : bool = true

Return values

Mage_Sales_Model_Order_Payment

getOrderWebsiteId()

Retrieve order website id


    public
                    getOrderWebsiteId() : int

Return values

int

getOrigData()

Get object loaded data (original data)


    public
                    getOrigData([string $key = null ]) : mixed

Parameters

$key : string = null

getParentId()


    public
                    getParentId() : int|null

Return values

int|null

getParentTransaction()

Parent transaction getter May attempt to load it.


    public
                    getParentTransaction([bool $shouldLoad = true ]) : $this|false

Parameters

$shouldLoad : bool = true

Return values

$this|false

getParentTxnId()


    public
                    getParentTxnId() : string|null

Return values

string|null

getPaymentId()


    public
                    getPaymentId() : int|null

Return values

int|null

getResource()

Retrieve model resource


    public
                    getResource() : Mage_Sales_Model_Resource_Order_Payment_Transaction

Return values

Mage_Sales_Model_Resource_Order_Payment_Transaction

getResourceCollection()

Get collection instance


    public
                    getResourceCollection() : Mage_Sales_Model_Resource_Order_Payment_Transaction_Collection

Return values

Mage_Sales_Model_Resource_Order_Payment_Transaction_Collection

getResourceName()

Retrieve model resource name


    public
                    getResourceName() : string

Return values

string

getShippingAddress()


    public
                    getShippingAddress() : Mage_Customer_Model_Address_Abstract|null

Return values

Mage_Customer_Model_Address_Abstract|null

getTransactionTypes()

Retrieve transaction types


    public
                    getTransactionTypes() : array<string|int, mixed>

Return values

array<string|int, mixed>

getTxnId()


    public
                    getTxnId() : string|null

Return values

string|null

getTxnType()


    public
                    getTxnType() : string|null

Return values

string|null

hasChildTransaction()

Getter/Setter of whether current transaction has a child transaction


    public
                    hasChildTransaction([bool $whetherHasChild = null ]) : bool|$this

Parameters

$whetherHasChild : bool = null

Return values

bool|$this

hasData()

If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.


    public
                    hasData([string $key = '' ]) : bool

Parameters

$key : string = ''

Return values

bool

hasDataChanges()

Get data change status


    public
                    hasDataChanges() : bool

Return values

bool

hasErrors()


    public
                    hasErrors() : bool

Return values

bool

isDeleted()

Set _isDeleted flag value (if $isDeleted param is defined) and return current flag value


    public
                    isDeleted([bool $isDeleted = null ]) : bool

Parameters

$isDeleted : bool = null

Return values

bool

isDirty()


    public
                    isDirty([string $field = null ]) : bool

Parameters

$field : string = null

Return values

bool

isEmpty()

checks whether the object is empty


    public
                    isEmpty() : bool

Return values

bool

isFailsafe()

Setter/Getter whether transaction is supposed to prevent exceptions on saving


    public
                    isFailsafe([bool|null $setFailsafe = null ]) : bool|$this

Parameters

$setFailsafe : bool|null = null

Return values

bool|$this

isModuleEnabled()


    public
                    isModuleEnabled(string $moduleName[, string $helperAlias = 'core' ]) : bool

Parameters

$moduleName : string
$helperAlias : string = 'core'

Return values

bool

isObjectNew()

Check object state (true - if it is object without id on object just created) This method can help detect if object just created in _afterSave method problem is what in after save object has id and we can't detect what object was created in this transaction


    public
                    isObjectNew([bool $flag = null ]) : bool

Parameters

$flag : bool = null

Return values

bool

isVoided()

Check whether this transaction is voided


    public
                    isVoided() : bool

Return values

bool

jsonSerialize()

Implementation of JsonSerializable::jsonSerialize()


    public
                    jsonSerialize() : array<string|int, mixed>

Prepares the object data for JSON serialization. Returns all object data as an array, with special handling for nested DataObject instances:

If a nested DataObject has a custom jsonSerialize() implementation, it's preserved as-is
If a nested DataObject has a custom toJson() method, it's converted to JSON string
If a nested DataObject uses only the base implementations, it's excluded from output

This prevents infinite recursion and circular references when serializing object hierarchies.

#[Override]

Return values

array<string|int, mixed>

load()

Load object data


    public
                    load(string|null|int $id[, string|null $field = null ]) : $this

Parameters

$id : string|null|int
$field : string|null = null

Return values

$this

loadByTxnId()

Load self by specified transaction ID. Requires the valid payment object to be set


    public
                    loadByTxnId(string $txnId) : $this

Parameters

$txnId : string

Return values

$this

offsetExists()

Implementation of ArrayAccess::offsetExists()


    public
                    offsetExists(string $offset) : bool

Parameters

$offset : string

Return values

bool

offsetGet()

Implementation of ArrayAccess::offsetGet()


    public
                    offsetGet(string $offset) : mixed

Parameters

$offset : string

offsetSet()

Implementation of ArrayAccess::offsetSet()


    public
                    offsetSet(string $offset, mixed $value) : void

Parameters

$offset : string
$value : mixed

offsetUnset()

Implementation of ArrayAccess::offsetUnset()


    public
                    offsetUnset(string $offset) : void

Parameters

$offset : string

save()

Save object data


    public
                    save() : $this

Return values

$this

serialize()

serialize object attributes


    public
                    serialize([array<string|int, mixed> $attributes = [] ][, string $valueSeparator = '=' ][, string $fieldSeparator = ' ' ][, string $quote = '"' ]) : string

Parameters

$attributes : array<string|int, mixed> = []
$valueSeparator : string = '='
$fieldSeparator : string = ' '
$quote : string = '"'

Return values

string

setAdditionalInformation()

Additional information setter Updates data inside the 'additional_information' array Doesn't allow to set arrays


    public
                    setAdditionalInformation(string $key, mixed $value) : $this

Parameters

$key : string
$value : mixed

Return values

$this

setAttribute()


    public
                    setAttribute(Mage_Eav_Model_Entity_Attribute_Abstract $value) : $this

Parameters

$value : Mage_Eav_Model_Entity_Attribute_Abstract

Return values

$this

setCreatedAt()


    public
                    setCreatedAt(string|null $value) : static

Parameters

$value : string|null

Return values

static

setData()

Overwrite data in the object.


    public
                    setData(string|array<string|int, mixed> $key[, mixed $value = null ]) : $this

$key can be string or array. If $key is string, the attribute value will be overwritten by $value

If $key is an array, it will overwrite all the data in the object.

Parameters

$key : string|array<string|int, mixed>
$value : mixed = null

Return values

$this

setDataChanges()

Clears data changes status


    public
                    setDataChanges(bool $value) : $this

Parameters

$value : bool

Return values

$this

setDataUsingMethod()

Set object data with calling setter method


    public
                    setDataUsingMethod(string $key[, mixed $args = [] ]) : $this

Parameters

$key : string
$args : mixed = []

Return values

$this

setId()

Declare model object identifier value


    public
                    setId(mixed $id) : $this

Parameters

$id : mixed

#[Override]

Return values

$this

setIdFieldName()

set name of object id field


    public
                    setIdFieldName(string $name) : $this

Parameters

$name : string

Return values

$this

setIsClosed()


    public
                    setIsClosed([bool|null $value = true ]) : static

Parameters

$value : bool|null = true

Return values

static

setOrder()

Set order instance for transaction depends on transaction behavior If $order equals to true, method isn't loading new order instance.


    public
                    setOrder([Mage_Sales_Model_Order_Payment|null|bool $order = null ]) : $this

Parameters

$order : Mage_Sales_Model_Order_Payment|null|bool = null

Return values

$this

setOrderId()


    public
                    setOrderId(int|null $value) : static

Parameters

$value : int|null

Return values

static

setOrderPaymentObject()

Payment instance setter


    public
                    setOrderPaymentObject(Mage_Sales_Model_Order_Payment $payment) : $this

Parameters

$payment : Mage_Sales_Model_Order_Payment

Return values

$this

setOrderUrl()


    public
                    setOrderUrl(string|null $value) : static

Parameters

$value : string|null

Return values

static

setOrigData()

Initialize object original data


    public
                    setOrigData([string $key = null ][, mixed $data = null ]) : $this

Parameters

$key : string = null
$data : mixed = null

Return values

$this

setParentId()


    public
                    setParentId(int|null $value) : static

Parameters

$value : int|null

Return values

static

setParentTxnId()

Parent transaction ID setter Can set the transaction id as well


    public
                    setParentTxnId(string $parentTxnId[, string $txnId = null ]) : $this

Parameters

$parentTxnId : string
$txnId : string = null

Return values

$this

setPaymentId()


    public
                    setPaymentId(int|null $value) : static

Parameters

$value : int|null

Return values

static

setTxnId()

Transaction ID setter


    public
                    setTxnId(string $txnId) : $this

Parameters

$txnId : string

Return values

$this

setTxnType()

Transaction type setter


    public
                    setTxnType(string $txnType) : $this

Parameters

$txnType : string

Return values

$this

setUpdatedAt()


    public
                    setUpdatedAt(string|null $value) : static

Parameters

$value : string|null

Return values

static

toArray()

Public wrapper for __toArray


    public
                    toArray([array<string|int, mixed> $arrAttributes = [] ]) : array<string|int, mixed>

Parameters

$arrAttributes : array<string|int, mixed> = []

Return values

array<string|int, mixed>

toJson()

Public wrapper for __toJson


    public
                    toJson([array<string|int, mixed> $arrAttributes = [] ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []

Return values

string

toString()

Public wrapper for __toString


    public
                    toString([string $format = '' ]) : string

Will use $format as an template and substitute {{key}} for attributes

Parameters

$format : string = ''

Return values

string

toXml()

Public wrapper for __toXml


    public
                    toXml([array<string|int, mixed> $arrAttributes = [] ][, string $rootName = 'item' ][, bool $addOpenTag = false ][, bool $addCdata = true ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []
$rootName : string = 'item'
$addOpenTag : bool = false
$addCdata : bool = true

Return values

string

unsAdditionalInformation()

Unsetter for entire additional_information value or one of its element by key


    public
                    unsAdditionalInformation([string $key = null ]) : $this

Parameters

$key : string = null

Return values

$this

unsetData()

Unset data from the object.


    public
                    unsetData([string $key = null ]) : $this

$key can be a string only. Array will be ignored.

Parameters

$key : string = null

Return values

$this

unsetOldData()

Unset old fields data from the object.


    public
                    unsetOldData([string $key = null ]) : $this

$key can be a string only. Array will be ignored.

Parameters

$key : string = null

Return values

$this

__toJson()

Convert object attributes to JSON


    protected
                    __toJson([array<string|int, mixed> $arrAttributes = [] ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []: array of required attributes

Return values

string

__toXml()

Convert object attributes to XML


    protected
                    __toXml([array<string|int, mixed> $arrAttributes = [] ][, string $rootName = 'item' ][, bool $addOpenTag = false ][, bool $addCdata = true ]) : string

Parameters

$arrAttributes : array<string|int, mixed> = []: array of required attributes
$rootName : string = 'item': name of the root element
$addOpenTag : bool = false
$addCdata : bool = true

Return values

string

_addFullNames()


    protected
                    _addFullNames() : mixed

_afterDelete()

Processing object after delete data


    protected
                    _afterDelete() : $this

Return values

$this

_afterDeleteCommit()

Processing manipulation after main transaction commit


    protected
                    _afterDeleteCommit() : $this

Return values

$this

_afterLoad()

Processing object after load data


    protected
                    _afterLoad() : $this

Return values

$this

_afterLoadByTxnId()

Check object after loading by by specified transaction ID


    protected
                    _afterLoadByTxnId() : $this

Return values

$this

_afterSave()

Processing object after save data


    protected
                    _afterSave() : $this

Return values

$this

_beforeDelete()

Processing object before delete data


    protected
                    _beforeDelete() : $this

Return values

$this

_beforeLoad()

Processing object before load data


    protected
                    _beforeLoad(int $id[, string|null $field = null ]) : $this

Parameters

$id : int
$field : string|null = null

Return values

$this

_beforeLoadByTxnId()

Check object before loading by by specified transaction ID


    protected
                    _beforeLoadByTxnId(int $txnId) : $this

Parameters

$txnId : int

Return values

$this

_beforeSave()

Verify data required for saving


    protected
                    _beforeSave() : $this

Return values

$this

_camelize()


    protected
                    _camelize(string $name) : string

Parameters

$name : string

Return values

string

_clearData()

Clearing object's data


    protected
                    _clearData() : $this

Return values

$this

_clearReferences()

Clearing cyclic references


    protected
                    _clearReferences() : $this

Return values

$this

_construct()

Internal constructor not depended on params. Can be used for object initialization


    protected
                    _construct() : void

#[Override]

_getData()

Get value from _data array without parse key


    protected
                    _getData(string $key) : mixed

Parameters

$key : string

_getEventData()

Get array of objects transferred to default events processing


    protected
                    _getEventData() : array<string|int, mixed>

Return values

array<string|int, mixed>

_hasModelChanged()

Check whether model has changed data.


    protected
                    _hasModelChanged() : bool

Can be overloaded in child classes to perform advanced check whether model needs to be saved e.g. using resourceModel->hasDataChanged() or any other technique

Return values

bool

_init()

Standard model initialization


    protected
                    _init(string $resourceModel) : mixed

Parameters

$resourceModel : string

_initOldFieldsMap()

Inits mapping array of object's previously used fields to new fields.


    protected
                    _initOldFieldsMap() : mixed

Must be overloaded by descendants to set concrete fields map.

_isVoided()

Check whether this transaction is voided TODO: implement that there should be only one void per authorization


    protected
                    _isVoided() : bool

Return values

bool

_loadChildren()

Load child transactions


    protected
                    _loadChildren() : mixed

_prepareArray()

Set required array elements


    protected
                    _prepareArray(array<string|int, mixed> &$arr[, array<string|int, mixed> $elements = [] ]) : array<string|int, mixed>

Parameters

$arr : array<string|int, mixed>
$elements : array<string|int, mixed> = []

Return values

array<string|int, mixed>

_prepareSyncFieldsMap()

Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.


    protected
                    _prepareSyncFieldsMap() : $this

Return values

$this

_protectFromNonAdmin()

Safeguard func that will check, if we are in admin area


    protected
                    _protectFromNonAdmin() : mixed

_setResourceModel()

Set resource names


    protected
                    _setResourceModel(string $resourceName[, string|null $resourceCollectionName = null ]) : mixed

If collection name is omitted, resource name will be used with _collection appended

Parameters

$resourceName : string
$resourceCollectionName : string|null = null

_underscore()

Converts field names for setters and getters


    protected
                    _underscore(string $name) : string

$this->setMyField($value) === $this->setData('my_field', $value) Uses cache to eliminate unnecessary preg_replace

Parameters

$name : string

Return values

string

_verifyPaymentObject()

Check whether the payment object is set and it has order object or there is an order_id is set $dryRun allows to not throw exception


    protected
                    _verifyPaymentObject([bool $dryRun = false ]) : Mage_Sales_Model_Order_Payment|null|false

Parameters

$dryRun : bool = false

Return values

Mage_Sales_Model_Order_Payment|null|false

_verifyThisTransactionExists()

Make sure this object is a valid transaction TODO for more restriction we can check for data consistency


    protected
                    _verifyThisTransactionExists() : mixed

_verifyTxnId()

Check whether specified transaction ID is valid


    protected
                    _verifyTxnId(string $txnId) : mixed

Parameters

$txnId : string

_verifyTxnType()

Check whether specified or set transaction type is supported


    protected
                    _verifyTxnType([string $txnType = null ]) : mixed

Parameters

$txnType : string = null

Mage_Sales_Model_Order_Payment_Transaction extends Mage_Core_Model_Abstract in package Mage Sales

Table of Contents

Constants

Properties

Methods

Constants

RAW_DETAILS

TYPE_AUTH

TYPE_CAPTURE

TYPE_ORDER

TYPE_PAYMENT

TYPE_REFUND

TYPE_VOID

Properties

$_cacheTag

$_children

$_data

$_dataSaveAllowed

$_dirty

$_eventObject

Tags

Attributes

$_eventPrefix

Tags

Attributes

$_hasChild

$_hasDataChanges

$_identifiedChildren

$_idFieldName

$_isDeleted

$_isFailsafe

$_isObjectNew

$_oldFieldsMap

$_order

$_orderWebsiteId

$_origData

$_parentTransaction

$_paymentObject

$_resource

$_resourceCollectionName

$_resourceName

$_syncFieldsMap

$_transactionsAutoLinking

$_underscoreCache

Methods

__call()

Parameters

__construct()

__get()

Parameters

__set()

Parameters

__toArray()

Parameters

Return values

_getResource()

Return values

addData()

Parameters

Return values

afterCommitCallback()

Return values

afterLoad()

Return values

canVoidAuthorizationCompletely()

Return values

cleanModelCache()

Return values

clearInstance()

Return values

close()

Parameters

Tags

Return values

closeAuthorization()

Parameters

Tags

Return values

closeCapture()

Parameters

Mage_Sales_Model_Order_Payment_Transaction extends Mage_Core_Model_Abstract
in package

Mage

Sales