AbstractAgreement.php

Go to the documentation of this file.

<?php
namespace Magento\Paypal\Model\Payment\Method\Billing;

use Magento\Paypal\Model\Billing\Agreement;
use Magento\Quote\Api\Data\PaymentInterface;

abstract class AbstractAgreement extends \Magento\Payment\Model\Method\AbstractMethod
{
    const TRANSPORT_BILLING_AGREEMENT_ID = 'ba_agreement_id';

    const PAYMENT_INFO_REFERENCE_ID = 'ba_reference_id';

    protected $_infoBlockType = \Magento\Paypal\Block\Payment\Info\Billing\Agreement::class;

    protected $_formBlockType = \Magento\Paypal\Block\Payment\Form\Billing\Agreement::class;

    protected $_isAvailable = null;

    protected $_agreementFactory;

    public function __construct(
        \Magento\Framework\Model\Context $context,
        \Magento\Framework\Registry $registry,
        \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory,
        \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory,
        \Magento\Payment\Helper\Data $paymentData,
        \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
        \Magento\Payment\Model\Method\Logger $logger,
        \Magento\Paypal\Model\Billing\AgreementFactory $agreementFactory,
        \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
        \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
        array $data = []
    ) {
        $this->_agreementFactory = $agreementFactory;
        parent::__construct(
            $context,
            $registry,
            $extensionFactory,
            $customAttributeFactory,
            $paymentData,
            $scopeConfig,
            $logger,
            $resource,
            $resourceCollection,
            $data
        );
    }

    public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
    {
        if ($this->_isAvailable === null) {
            $this->_isAvailable = parent::isAvailable($quote) && $this->_isAvailable($quote);
            $this->_canUseCheckout = $this->_isAvailable && $this->_canUseCheckout;
            $this->_canUseInternal = $this->_isAvailable && $this->_canUseInternal;
        }
        return $this->_isAvailable;
    }

    public function assignData(\Magento\Framework\DataObject $data)
    {
        parent::assignData($data);

        $additionalData = $data->getData(PaymentInterface::KEY_ADDITIONAL_DATA);

        if (!is_array($additionalData) || !isset($additionalData[self::TRANSPORT_BILLING_AGREEMENT_ID])) {
            return $this;
        }

        $id = $additionalData[self::TRANSPORT_BILLING_AGREEMENT_ID];
        if (!$id || !is_numeric($id)) {
            return $this;
        }

        $info = $this->getInfoInstance();
        $ba = $this->_agreementFactory->create();
        $ba->load($id);

        if ($ba->getId() && $ba->getCustomerId() == $info->getQuote()->getCustomerId()) {
            $info->setAdditionalInformation(self::TRANSPORT_BILLING_AGREEMENT_ID, $id);
            $info->setAdditionalInformation(self::PAYMENT_INFO_REFERENCE_ID, $ba->getReferenceId());
        }

        return $this;
    }

    abstract protected function _isAvailable($quote);
}