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
177
178
179
180
181
182
183
184
185
186
187
188
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Newsletter\Model\Plugin;
use Magento\Customer\Api\CustomerRepositoryInterface as CustomerRepository;
use Magento\Customer\Api\Data\CustomerInterface;
use Magento\Newsletter\Model\SubscriberFactory;
use Magento\Framework\Api\ExtensionAttributesFactory;
use Magento\Newsletter\Model\ResourceModel\Subscriber;
use Magento\Customer\Api\Data\CustomerExtensionInterface;
/**
* Newsletter Plugin for customer
*/
class CustomerPlugin
{
/**
* Factory used for manipulating newsletter subscriptions
*
* @var SubscriberFactory
*/
private $subscriberFactory;
/**
* @var ExtensionAttributesFactory
*/
private $extensionFactory;
/**
* @var Subscriber
*/
private $subscriberResource;
/**
* @var array
*/
private $customerSubscriptionStatus = [];
/**
* Initialize dependencies.
*
* @param SubscriberFactory $subscriberFactory
* @param ExtensionAttributesFactory $extensionFactory
* @param Subscriber $subscriberResource
*/
public function __construct(
SubscriberFactory $subscriberFactory,
ExtensionAttributesFactory $extensionFactory,
Subscriber $subscriberResource
) {
$this->subscriberFactory = $subscriberFactory;
$this->extensionFactory = $extensionFactory;
$this->subscriberResource = $subscriberResource;
}
/**
* Plugin after create customer that updates any newsletter subscription that may have existed.
*
* If we have extension attribute (is_subscribed) we need to subscribe that customer
*
* @param CustomerRepository $subject
* @param CustomerInterface $result
* @param CustomerInterface $customer
* @return CustomerInterface
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function afterSave(CustomerRepository $subject, CustomerInterface $result, CustomerInterface $customer)
{
$resultId = $result->getId();
/** @var \Magento\Newsletter\Model\Subscriber $subscriber */
$subscriber = $this->subscriberFactory->create();
$subscriber->updateSubscription($resultId);
// update the result only if the original customer instance had different value.
$initialExtensionAttributes = $result->getExtensionAttributes();
if ($initialExtensionAttributes === null) {
/** @var CustomerExtensionInterface $initialExtensionAttributes */
$initialExtensionAttributes = $this->extensionFactory->create(CustomerInterface::class);
$result->setExtensionAttributes($initialExtensionAttributes);
}
$newExtensionAttributes = $customer->getExtensionAttributes();
if ($newExtensionAttributes
&& $initialExtensionAttributes->getIsSubscribed() !== $newExtensionAttributes->getIsSubscribed()
) {
if ($newExtensionAttributes->getIsSubscribed()) {
$subscriber->subscribeCustomerById($resultId);
} else {
$subscriber->unsubscribeCustomerById($resultId);
}
}
$isSubscribed = $subscriber->isSubscribed();
$this->customerSubscriptionStatus[$resultId] = $isSubscribed;
$initialExtensionAttributes->setIsSubscribed($isSubscribed);
return $result;
}
/**
* Plugin around delete customer that updates any newsletter subscription that may have existed.
*
* @param CustomerRepository $subject
* @param callable $deleteCustomerById Function we are wrapping around
* @param int $customerId Input to the function
* @return bool
*/
public function aroundDeleteById(
CustomerRepository $subject,
callable $deleteCustomerById,
$customerId
) {
$customer = $subject->getById($customerId);
$result = $deleteCustomerById($customerId);
/** @var \Magento\Newsletter\Model\Subscriber $subscriber */
$subscriber = $this->subscriberFactory->create();
$subscriber->loadByEmail($customer->getEmail());
if ($subscriber->getId()) {
$subscriber->delete();
}
return $result;
}
/**
* Plugin after delete customer that updates any newsletter subscription that may have existed.
*
* @param CustomerRepository $subject
* @param bool $result
* @param CustomerInterface $customer
* @return bool
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function afterDelete(CustomerRepository $subject, $result, CustomerInterface $customer)
{
$subscriber = $this->subscriberFactory->create();
$subscriber->loadByEmail($customer->getEmail());
if ($subscriber->getId()) {
$subscriber->delete();
}
return $result;
}
/**
* Plugin after getById customer that obtains newsletter subscription status for given customer.
*
* @param CustomerRepository $subject
* @param CustomerInterface $customer
* @return CustomerInterface
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function afterGetById(CustomerRepository $subject, CustomerInterface $customer)
{
$extensionAttributes = $customer->getExtensionAttributes();
if ($extensionAttributes === null) {
/** @var CustomerExtensionInterface $extensionAttributes */
$extensionAttributes = $this->extensionFactory->create(CustomerInterface::class);
$customer->setExtensionAttributes($extensionAttributes);
}
if ($extensionAttributes->getIsSubscribed() === null) {
$isSubscribed = $this->isSubscribed($customer);
$extensionAttributes->setIsSubscribed($isSubscribed);
}
return $customer;
}
/**
* This method returns newsletters subscription status for given customer.
*
* @param CustomerInterface $customer
* @return bool
*/
private function isSubscribed(CustomerInterface $customer)
{
$customerId = $customer->getId();
if (!isset($this->customerSubscriptionStatus[$customerId])) {
$subscriber = $this->subscriberResource->loadByCustomerData($customer);
$this->customerSubscriptionStatus[$customerId] = isset($subscriber['subscriber_status'])
&& $subscriber['subscriber_status'] == 1;
}
return $this->customerSubscriptionStatus[$customerId];
}
}