1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Paypal\Helper;
use Magento\Framework\App\ObjectManager;
use Magento\Payment\Api\Data\PaymentMethodInterface;
use Magento\Payment\Api\PaymentMethodListInterface;
use Magento\Payment\Model\Method\InstanceFactory;
use Magento\Payment\Model\MethodInterface;
use Magento\Paypal\Model\Billing\Agreement\MethodInterface as BillingAgreementMethodInterface;
/**
* Paypal Data helper
*/
class Data extends \Magento\Framework\App\Helper\AbstractHelper
{
const HTML_TRANSACTION_ID =
'<a target="_blank" href="https://www%1$s.paypal.com/cgi-bin/webscr?cmd=_view-a-trans&id=%2$s">%2$s</a>';
/**
* Cache for shouldAskToCreateBillingAgreement()
*
* @var bool
*/
protected static $_shouldAskToCreateBillingAgreement = null;
/**
* @var \Magento\Payment\Helper\Data
*/
protected $_paymentData;
/**
* @var \Magento\Paypal\Model\Billing\AgreementFactory
*/
protected $_agreementFactory;
/**
* @var array
*/
private $methodCodes;
/**
* @var \Magento\Paypal\Model\ConfigFactory
*/
private $configFactory;
/**
* @var PaymentMethodListInterface
*/
private $paymentMethodList;
/**
* @var InstanceFactory
*/
private $paymentMethodInstanceFactory;
/**
* @param \Magento\Framework\App\Helper\Context $context
* @param \Magento\Payment\Helper\Data $paymentData
* @param \Magento\Paypal\Model\Billing\AgreementFactory $agreementFactory
* @param \Magento\Paypal\Model\ConfigFactory $configFactory
* @param array $methodCodes
*/
public function __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
) {
$this->_paymentData = $paymentData;
$this->_agreementFactory = $agreementFactory;
$this->methodCodes = $methodCodes;
$this->configFactory = $configFactory;
parent::__construct($context);
}
/**
* Check whether customer should be asked confirmation whether to sign a billing agreement
*
* @param \Magento\Paypal\Model\Config $config
* @param int $customerId
* @return bool
*/
public function shouldAskToCreateBillingAgreement(\Magento\Paypal\Model\Config $config, $customerId)
{
if (null === self::$_shouldAskToCreateBillingAgreement) {
self::$_shouldAskToCreateBillingAgreement = false;
if ($customerId && $config->shouldAskToCreateBillingAgreement()) {
if ($this->_agreementFactory->create()->needToCreateForCustomer($customerId)) {
self::$_shouldAskToCreateBillingAgreement = true;
}
}
}
return self::$_shouldAskToCreateBillingAgreement;
}
/**
* Retrieve available billing agreement methods
*
* @param null|string|bool|int|\Magento\Store\Model\Store $store
* @param \Magento\Quote\Model\Quote|null $quote
* @return BillingAgreementMethodInterface[]
*/
public function getBillingAgreementMethods($store = null, $quote = null)
{
$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;
}
/**
* Get HTML representation of transaction id
*
* @param string $methodCode
* @param string $txnId
* @return string
*/
public function getHtmlTransactionId($methodCode, $txnId)
{
if (in_array($methodCode, $this->methodCodes)) {
/** @var \Magento\Paypal\Model\Config $config */
$config = $this->configFactory->create()->setMethod($methodCode);
$sandboxFlag = ($config->getValue('sandboxFlag') ? '.sandbox' : '');
return sprintf(self::HTML_TRANSACTION_ID, $sandboxFlag, $txnId);
}
return $txnId;
}
/**
* Get payment method list.
*
* @return PaymentMethodListInterface
* @deprecated 100.2.0
*/
private function getPaymentMethodList()
{
if ($this->paymentMethodList === null) {
$this->paymentMethodList = ObjectManager::getInstance()->get(
PaymentMethodListInterface::class
);
}
return $this->paymentMethodList;
}
/**
* Get payment method instance factory.
*
* @return InstanceFactory
* @deprecated 100.2.0
*/
private function getPaymentMethodInstanceFactory()
{
if ($this->paymentMethodInstanceFactory === null) {
$this->paymentMethodInstanceFactory = ObjectManager::getInstance()->get(
InstanceFactory::class
);
}
return $this->paymentMethodInstanceFactory;
}
}