Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Payment\Helper\Data $paymentData, \Magento\Paypal\Model\Billing\AgreementFactory $agreementFactory, \Magento\Paypal\Model\ConfigFactory $configFactory, array $methodCodes)
	shouldAskToCreateBillingAgreement (\Magento\Paypal\Model\Config $config, $customerId)
	getBillingAgreementMethods ($store=null, $quote=null)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	HTML_TRANSACTION_ID

Protected Attributes
	$_paymentData
	$_agreementFactory
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Static Protected Attributes
static	$_shouldAskToCreateBillingAgreement = null

Additional Inherited Members
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Detailed Description

Paypal Data helper

Definition at line 18 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Payment\Helper\Data	$paymentData,
		\Magento\Paypal\Model\Billing\AgreementFactory	$agreementFactory,
		\Magento\Paypal\Model\ConfigFactory	$configFactory,
		array	$methodCodes
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Payment\Helper\Data	$paymentData
\Magento\Paypal\Model\Billing\AgreementFactory	$agreementFactory
\Magento\Paypal\Model\ConfigFactory	$configFactory
array	$methodCodes

Definition at line 67 of file Data.php.

      {
        $this->_paymentData = $paymentData;
        $this->_agreementFactory = $agreementFactory;
        $this->methodCodes = $methodCodes;
        $this->configFactory = $configFactory;
        parent::__construct($context);
    }

Member Function Documentation

getBillingAgreementMethods()

getBillingAgreementMethods	(		$store = null,
			$quote = null
	)

Retrieve available billing agreement methods

Parameters

null | string | bool | int | \Magento\Store\Model\Store	$store
\Magento\Quote\Model\Quote | null	$quote

Returns

BillingAgreementMethodInterface[]

Definition at line 108 of file Data.php.

    {
        $activeMethods = array_map(
            function (PaymentMethodInterface $method) {
                return $this->getPaymentMethodInstanceFactory()->create($method);
            },
            $this->getPaymentMethodList()->getActiveList($store)
        );

        $result = array_filter(
            $activeMethods,
            function (MethodInterface $method) use ($quote) {
                return $method instanceof BillingAgreementMethodInterface && $method->isAvailable($quote);
            }
        );

        return $result;
    }

shouldAskToCreateBillingAgreement()

shouldAskToCreateBillingAgreement	(	\Magento\Paypal\Model\Config	$config,
			$customerId
	)

Check whether customer should be asked confirmation whether to sign a billing agreement

Parameters

\Magento\Paypal\Model\Config	$config
int	$customerId

Returns

bool

Definition at line 88 of file Data.php.

    {
        if (null === self::$_shouldAskToCreateBillingAgreement) {
            self::$_shouldAskToCreateBillingAgreement = false;
            if ($customerId && $config->shouldAskToCreateBillingAgreement()) {
                if ($this->_agreementFactory->create()->needToCreateForCustomer($customerId)) {
                    self::$_shouldAskToCreateBillingAgreement = true;
                }
            }
        }
        return self::$_shouldAskToCreateBillingAgreement;
    }

Field Documentation

$_agreementFactory

$_agreementFactory

protected

Definition at line 38 of file Data.php.

$_paymentData

$_paymentData

protected

Definition at line 33 of file Data.php.

$_shouldAskToCreateBillingAgreement

$_shouldAskToCreateBillingAgreement = null

staticprotected

Definition at line 28 of file Data.php.

HTML_TRANSACTION_ID

const HTML_TRANSACTION_ID

Initial value:

=
        '<a target="_blank" href="https://www%1$s.paypal.com/cgi-bin/webscr?cmd=_view-a-trans&id=%2$s">%2$s</a>'

Definition at line 20 of file Data.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-paypal/Helper/Data.php