Class Mage_Sales_Model_Order_Payment_Transaction

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

Varien_Object

Mage_Core_Model_Abstract

Mage_Sales_Model_Order_Payment_Transaction

Package: Mage\Sales
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Sales/Model/Order/Payment/Transaction.php

Methods summary
`protected`	# `_construct( )` Initialize resource model Initialize resource model
`public Mage_Sales_Model_Order_Payment_Transaction`	# `setOrderPaymentObject( Mage_Sales_Model_Order_Payment $payment )` Payment instance setter Payment instance setter Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `Mage_Sales_Model_Order_Payment_Transaction`
`public Mage_Sales_Model_Order_Payment_Transaction`	# `setTxnId( string $txnId )` Transaction ID setter Transaction ID setter Parameters `$txnId` `string` $txnId Returns `Mage_Sales_Model_Order_Payment_Transaction`
`public Mage_Sales_Model_Order_Payment_Transaction`	# `setParentTxnId( string $parentTxnId, string $txnId = null )` Parent transaction ID setter Can set the transaction id as well Parent transaction ID setter Can set the transaction id as well Parameters `$parentTxnId` `string` $parentTxnId `$txnId` `string` $txnId Returns `Mage_Sales_Model_Order_Payment_Transaction` Throws `Mage_Core_Exception`
`public Mage_Sales_Model_Order_Payment_Transaction`	# `setTxnType( mixed $txnType )` Transaction type setter Transaction type setter Parameters `$txnType` `mixed` $txnType Returns `Mage_Sales_Model_Order_Payment_Transaction`
`public Mage_Sales_Model_Order_Payment_Transaction\|false`	# `getParentTransaction( boolean $shouldLoad = true )` Parent transaction getter May attempt to load it. Parent transaction getter May attempt to load it. Parameters `$shouldLoad` `boolean` $shouldLoad Returns `Mage_Sales_Model_Order_Payment_Transaction\|false`
`public Mage_Sales_Model_Order_Payment_Transaction\|array\|null`	# `getChildTransactions( array\|string $types = null, string $txnId = null, boolean $recursive = false )` 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 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 Parameters `$types` `array\|string` $types `$txnId` `string` $txnId `$recursive` `boolean` $recursive Returns `Mage_Sales_Model_Order_Payment_Transaction\|array\|null`
`public Mage_Sales_Model_Order_Payment_Transaction\|false`	# `closeAuthorization( boolean $shouldSave = true, boolean $dryRun = 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. $dryRun = true prevents actual closing, it just allows to check whether this operation is possible 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. $dryRun = true prevents actual closing, it just allows to check whether this operation is possible Parameters `$shouldSave` `boolean` $shouldSave `$dryRun` `boolean` $dryRun Returns `Mage_Sales_Model_Order_Payment_Transaction\|false` Throws `Exception`
`public`	# `closeCapture( unknown_type $shouldSave = true )` Close a capture transaction Logic is similar to closeAuthorization(), but for a capture transaction Close a capture transaction Logic is similar to closeAuthorization(), but for a capture transaction Parameters `$shouldSave` `unknown_type` $shouldSave See `Mage_Sales_Model_Order_Payment_Transaction::closeAuthorization()` Para, bool $shouldSave
`public boolean`	# `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 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 Returns `boolean`
`public boolean\|Mage_Sales_Model_Order_Payment_Transaction`	# `hasChildTransaction( boolean $whetherHasChild = null )` Getter/Setter of whether current transaction has a child transaction Getter/Setter of whether current transaction has a child transaction Parameters `$whetherHasChild` `boolean` $whetherHasChild Returns `boolean\|Mage_Sales_Model_Order_Payment_Transaction`
`protected Mage_Sales_Model_Order_Payment_Transaction`	# `_beforeLoadByTxnId( mixed $txnId )` Check object before loading by by specified transaction ID Check object before loading by by specified transaction ID Parameters `$txnId` `mixed` $txnId Returns `Mage_Sales_Model_Order_Payment_Transaction`
`public Mage_Sales_Model_Order_Payment_Transaction`	# `loadByTxnId( string $txnId )` Load self by specified transaction ID. Requires the valid payment object to be set Load self by specified transaction ID. Requires the valid payment object to be set Parameters `$txnId` `string` $txnId Returns `Mage_Sales_Model_Order_Payment_Transaction`
`protected Mage_Sales_Model_Order_Payment_Transaction`	# `_afterLoadByTxnId( )` Check object after loading by by specified transaction ID Check object after loading by by specified transaction ID Returns `Mage_Sales_Model_Order_Payment_Transaction`
`public Mage_Sales_Model_Order_Payment_Transaction`	# `setAdditionalInformation( string $key, mixed $value )` Additional information setter Updates data inside the 'additional_information' array Doesn't allow to set arrays Additional information setter Updates data inside the 'additional_information' array Doesn't allow to set arrays Parameters `$key` `string` $key `$value` `mixed` $value Returns `Mage_Sales_Model_Order_Payment_Transaction` Throws `Mage_Core_Exception`
`public array\|null\|mixed`	# `getAdditionalInformation( string $key = null )` Getter for entire additional_information value or one of its element by key Getter for entire additional_information value or one of its element by key Parameters `$key` `string` $key Returns `array\|null\|mixed`
`public Mage_Sales_Model_Order_Payment_Transaction`	# `unsAdditionalInformation( string $key = null )` Unsetter for entire additional_information value or one of its element by key Unsetter for entire additional_information value or one of its element by key Parameters `$key` `string` $key Returns `Mage_Sales_Model_Order_Payment_Transaction`
`public Mage_Sales_Model_Order_Payment_Transaction`	# `close( boolean $shouldSave = true )` Close this transaction Close this transaction Parameters `$shouldSave` `boolean` $shouldSave Returns `Mage_Sales_Model_Order_Payment_Transaction` Throws `Mage_Core_Exception`
`public Mage_Sales_Model_Order_Payment`	# `getOrderPaymentObject( boolean $shouldLoad = true )` Order Payment instance getter Will attempt to load by payment_id if it is set in data Order Payment instance getter Will attempt to load by payment_id if it is set in data Parameters `$shouldLoad` `boolean` $shouldLoad Returns `Mage_Sales_Model_Order_Payment`
`public integer\|null`	# `getOrderId( )` Order ID getter Attempts to get ID from set order payment object, if any, or from data by key 'order_id' Order ID getter Attempts to get ID from set order payment object, if any, or from data by key 'order_id' Returns `integer\|null`
`public Mage_Sales_Model_Order`	# `getOrder( )` Retrieve order instance Retrieve order instance Returns `Mage_Sales_Model_Order`
`public Mage_Sales_Model_Order_Payment_Transaction`	# `setOrder( Mage_Sales_Model_Order\|null\|boolean $order = null )` Set order instance for transaction depends on transaction behavior If $order equals to true, method isn't loading new order instance. Set order instance for transaction depends on transaction behavior If $order equals to true, method isn't loading new order instance. Parameters `$order` `Mage_Sales_Model_Order\|null\|boolean` $order Returns `Mage_Sales_Model_Order_Payment_Transaction`
`public`	# `isFailsafe( boolean $setFailsafe = null )` Setter/Getter whether transaction is supposed to prevent exceptions on saving Setter/Getter whether transaction is supposed to prevent exceptions on saving Parameters `$setFailsafe` `boolean` $failsafe
`protected Mage_Sales_Model_Order_Payment_Transaction`	# `_beforeSave( )` Verify data required for saving Verify data required for saving Returns `Mage_Sales_Model_Order_Payment_Transaction` Throws `Mage_Core_Exception` Overrides `Mage_Core_Model_Abstract::_beforeSave()`
`protected`	# `_loadChildren( )` Load child transactions Load child transactions Throws `Mage_Core_Exception`
`protected boolean`	# `_isVoided( )` Check whether this transaction is voided TODO: implement that there should be only one void per authorization Check whether this transaction is voided TODO: implement that there should be only one void per authorization Returns `boolean`
`public boolean`	# `isVoided( )` Check whether this transaction is voided Check whether this transaction is voided Returns `boolean`
`public array`	# `getTransactionTypes( )` Retrieve transaction types Retrieve transaction types Returns `array`
`public integer`	# `getOrderWebsiteId( )` Retrieve order website id Retrieve order website id Returns `integer`
`protected`	# `_verifyTxnType( string $txnType = null )` Check whether specified or set transaction type is supported Check whether specified or set transaction type is supported Parameters `$txnType` `string` $txnType Throws `Mage_Core_Exception`
`protected Mage_Sales_Model_Order_Payment\|null\|false`	# `_verifyPaymentObject( boolean $dryRun = 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 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 Parameters `$dryRun` `boolean` $dryRun Returns `Mage_Sales_Model_Order_Payment\|null\|false` Throws `Mage_Core_Exception`
`protected`	# `_verifyTxnId( string $txnId )` Check whether specified transaction ID is valid Check whether specified transaction ID is valid Parameters `$txnId` `string` $txnId Throws `Mage_Core_Exception`
`protected`	# `_verifyThisTransactionExists( )` Make sure this object is a valid transaction TODO for more restriction we can check for data consistency Make sure this object is a valid transaction TODO for more restriction we can check for data consistency Throws `Mage_Core_Exception`

Methods inherited from Mage_Core_Model_Abstract
_afterDelete(), _afterDeleteCommit(), _afterLoad(), _afterSave(), _beforeDelete(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save(), setId()

Constants summary
`string`	`TYPE_PAYMENT`	`'payment'`	# Supported transaction types Supported transaction types
`string`	`TYPE_ORDER`	`'order'`	#
`string`	`TYPE_AUTH`	`'authorization'`	#
`string`	`TYPE_CAPTURE`	`'capture'`	#
`string`	`TYPE_VOID`	`'void'`	#
`string`	`TYPE_REFUND`	`'refund'`	#
`string`	`RAW_DETAILS`	`'raw_details_info'`	# Raw details key in additional info Raw details key in additional info

Properties summary
`protected Mage_Sales_Model_Order_Payment`	`$_paymentObject`	`null`	# Payment instance. Required for most transaction writing and search operations Payment instance. Required for most transaction writing and search operations
`protected Mage_Sales_Model_Order_Payment`	`$_order`	`null`	# Order instance Order instance
`protected Mage_Sales_Model_Order_Payment_Transaction`	`$_parentTransaction`	`null`	# Parent transaction instance Parent transaction instance
`protected array`	`$_children`	`null`	# Child transactions, assoc array of transaction_id => instance Child transactions, assoc array of transaction_id => instance
`protected array`	`$_identifiedChildren`	`null`	# 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 oposite to foreaching $_children 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 oposite to foreaching $_children
`protected boolean`	`$_transactionsAutoLinking`	`true`	# Whether to perform automatic actions on transactions, such as auto-closing and putting as a parent Whether to perform automatic actions on transactions, such as auto-closing and putting as a parent
`protected boolean`	`$_isFailsafe`	`false`	# Whether to throw exceptions on different operations Whether to throw exceptions on different operations
`protected boolean`	`$_hasChild`	`null`	# Whether transaction has children Whether transaction has children
`protected string`	`$_eventPrefix`	`'sales_order_payment_transaction'`	# Event object prefix Event object prefix See Mage_Core_Model_Absctract::$_eventPrefix
`protected string`	`$_eventObject`	`'order_payment_transaction'`	# Event object prefix Event object prefix See Mage_Core_Model_Absctract::$_eventObject
`protected integer`	`$_orderWebsiteId`	`null`	# Order website id Order website id

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Interfaces

Class Mage_Sales_Model_Order_Payment_Transaction

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

See

Para,

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Throws

Overrides

Throws

Returns

Returns

Returns

Returns

Parameters

Throws

Parameters

Returns

Throws

Parameters

Throws

Throws

See

See