How is \Magento\Sales\Model\Order\Payment::transactionAdditionalInfo declared and used?

dmitry_fedyuk · May 7, 2016, 6:16am

Declaration

magento/magento2/blob/ffea3cd/app/code/Magento/Sales/Model/Order/Payment.php#L66-L71


/**
 * Transaction additional information container
 *
 * @var array
 */
protected $transactionAdditionalInfo = [];

Usage

1. \Magento\Sales\Model\Order\Payment::addTransaction()

github.com

magento/magento2/blob/ffea3cd/app/code/Magento/Sales/Model/Order/Payment.php#L1117-L1136


/**
 * Public access to _addTransaction method
 *
 * @param string $type
 * @param \Magento\Sales\Model\AbstractModel $salesDocument
 * @param bool $failSafe
 * @return null|Transaction
 */
public function addTransaction($type, $salesDocument = null, $failSafe = false)
{
    $builder = $this->transactionBuilder->setPayment($this)
        ->setOrder($this->getOrder())
        ->setFailSafe($failSafe)
        ->setTransactionId($this->getTransactionId())
        ->setAdditionalInformation($this->transactionAdditionalInfo);
    if ($salesDocument) {
        $builder->setSalesDocument($salesDocument);
    }
    return $builder->build($type);
}

Details: How is \Magento\Sales\Model\Order\Payment::addTransaction() implemented and used?

2. \Magento\Sales\Model\Order\Payment::setTransactionAdditionalInfo()

github.com

magento/magento2/blob/ffea3cd/app/code/Magento/Sales/Model/Order/Payment.php#L1289-L1299


/**
 * Additional transaction info setter
 *
 * @param string $key
 * @param string $value
 * @return void
 */
public function setTransactionAdditionalInfo($key, $value)
{
    $this->transactionAdditionalInfo[$key] = $value;
}

Details: How is \Magento\Sales\Model\Order\Payment::setTransactionAdditionalInfo() implemented and used?

3. \Magento\Sales\Model\Order\Payment::getTransactionAdditionalInfo()

github.com

magento/magento2/blob/ffea3cd/app/code/Magento/Sales/Model/Order/Payment.php#L1301-L1309


/**
 * Additional transaction info setter
 *
 * @return array
 */
public function getTransactionAdditionalInfo()
{
    return $this->transactionAdditionalInfo;
}

4. \Magento\Sales\Model\Order\Payment::resetTransactionAdditionalInfo()

github.com

magento/magento2/blob/ffea3cd/app/code/Magento/Sales/Model/Order/Payment.php#L1311-L1320


/**
 * Reset transaction additional info property
 *
 * @return $this
 */
public function resetTransactionAdditionalInfo()
{
    $this->transactionAdditionalInfo = [];
    return $this;
}