Builder.php

Go to the documentation of this file.

<?php
namespace Magento\Sales\Model\Order\Payment\Transaction;

use Magento\Sales\Api\Data\OrderInterface;
use Magento\Sales\Api\Data\OrderPaymentInterface;
use Magento\Sales\Api\Data\TransactionInterface;
use Magento\Sales\Api\TransactionRepositoryInterface;
use Magento\Sales\Model\AbstractModel;
use Magento\Sales\Model\Order\Payment;

class Builder implements BuilderInterface
{
    protected $payment;

    protected $order;

    protected $document;

    protected $failSafe = false;

    protected $message;

    protected $transactionId;

    protected $transactionAdditionalInfo = [];

    protected $transactionRepository;

    public function __construct(TransactionRepositoryInterface $transactionRepository)
    {
        $this->transactionRepository = $transactionRepository;
    }

    public function setPayment(OrderPaymentInterface $payment)
    {
        $this->payment = $payment;
        return $this;
    }

    public function setOrder(OrderInterface $order)
    {
        $this->order = $order;
        return $this;
    }

    public function setSalesDocument(\Magento\Sales\Model\AbstractModel $document)
    {
        $this->document = $document;
        return $this;
    }

    public function setFailSafe($failSafe)
    {
        $this->failSafe = $failSafe;
        return $this;
    }

    public function setMessage($message)
    {
        $this->message = $message;
        return $this;
    }

    public function setTransactionId($transactionId)
    {
        $this->transactionId = $transactionId;
        return $this;
    }

    public function setAdditionalInformation(array $value)
    {
        $this->transactionAdditionalInfo = $value;
        return $this;
    }

    public function addAdditionalInformation($key, $value)
    {
        $this->transactionAdditionalInfo[$key] = $value;
        return $this;
    }

    public function reset()
    {
        unset($this->payment);
        unset($this->document);
        unset($this->order);
        unset($this->message);
        unset($this->transactionId);
        $this->failSafe = false;
        $this->transactionAdditionalInfo = [];
        return $this;
    }

    protected function isPaymentExists()
    {
        if ($this->payment) {
            if ($this->payment->getSkipTransactionCreation()) {
                $this->payment->unsTransactionId();
                return false;
            }
            return true;
        }
        return false;
    }

    public function build($type)
    {
        if ($this->isPaymentExists() && $this->transactionId !== null) {
            $transaction = $this->transactionRepository->getByTransactionId(
                $this->transactionId,
                $this->payment->getId(),
                $this->order->getId()
            );
            if (!$transaction) {
                $transaction = $this->transactionRepository->create()->setTxnId($this->transactionId);
            }
            $transaction->setPaymentId($this->payment->getId())
                ->setPayment($this->payment)
                ->setOrderId($this->order->getId())
                ->setOrder($this->order)
                ->setTxnType($type)
                ->isFailsafe($this->failSafe);

            if ($this->payment->hasIsTransactionClosed()) {
                $transaction->setIsClosed((int)$this->payment->getIsTransactionClosed());
            }
            if ($this->transactionAdditionalInfo) {
                foreach ($this->transactionAdditionalInfo as $key => $value) {
                    $transaction->setAdditionalInformation($key, $value);
                }
            }
            $this->transactionAdditionalInfo = [];

            $this->payment->setLastTransId($transaction->getTxnId());
            $this->payment->setCreatedTransaction($transaction);
            $this->order->addRelatedObject($transaction);
            if ($this->document && $this->document instanceof AbstractModel) {
                $this->document->setTransactionId($transaction->getTxnId());
            }

            return $this->linkWithParentTransaction($transaction);
        }
        return null;
    }

    protected function linkWithParentTransaction(TransactionInterface $transaction)
    {
        $parentTransactionId = $this->payment->getParentTransactionId();

        if ($parentTransactionId) {
            $transaction->setParentTxnId($parentTransactionId);
            if ($this->payment->getShouldCloseParentTransaction()) {
                $parentTransaction = $this->transactionRepository->getByTransactionId(
                    $parentTransactionId,
                    $this->payment->getid(),
                    $this->order->getId()
                );
                if ($parentTransaction) {
                    if (!$parentTransaction->getIsClosed()) {
                        $parentTransaction->isFailsafe($this->failSafe)->close(false);
                    }
                    $this->order->addRelatedObject($parentTransaction);
                }
            }
        }
        return $transaction;
    }
}