Skip to content

Commit f45ecc6

Browse files
Stepa4manStepa4man
committed
MC-15295: rename Address and AddressConverter
1 parent 279c713 commit f45ecc6

File tree

6 files changed

+55
-61
lines changed

6 files changed

+55
-61
lines changed

‎app/code/Magento/Newsletter/Model/Queue/TransportBuilder.php

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@
1010
use Magento\Email\Model\AbstractTemplate;
1111
use Magento\Framework\Exception\MailException;
1212
use Magento\Framework\Mail\EmailMessageInterfaceFactory;
13-
use Magento\Framework\Mail\MailAddressConverter;
14-
use Magento\Framework\Mail\MailAddressList;
13+
use Magento\Framework\Mail\AddressConverter;
1514
use Magento\Framework\Mail\MessageInterface;
1615
use Magento\Framework\Mail\MessageInterfaceFactory;
1716
use Magento\Framework\Mail\MimeMessageInterfaceFactory;
@@ -57,9 +56,9 @@ class TransportBuilder extends \Magento\Framework\Mail\Template\TransportBuilder
5756
private $mimePartInterfaceFactory;
5857

5958
/**
60-
* @var MailAddressConverter|null
59+
* @var AddressConverter|null
6160
*/
62-
private $mailAddressConverter;
61+
private $addressConverter;
6362

6463
/**
6564
* TransportBuilder constructor
@@ -73,7 +72,7 @@ class TransportBuilder extends \Magento\Framework\Mail\Template\TransportBuilder
7372
* @param EmailMessageInterfaceFactory|null $emailMessageInterfaceFactory
7473
* @param MimeMessageInterfaceFactory|null $mimeMessageInterfaceFactory
7574
* @param MimePartInterfaceFactory|null $mimePartInterfaceFactory
76-
* @param MailAddressConverter|null $mailAddressConverter
75+
* @param AddressConverter|null $addressConverter
7776
*/
7877
public function __construct(
7978
FactoryInterface $templateFactory,
@@ -85,7 +84,7 @@ public function __construct(
8584
EmailMessageInterfaceFactory $emailMessageInterfaceFactory = null,
8685
MimeMessageInterfaceFactory $mimeMessageInterfaceFactory = null,
8786
MimePartInterfaceFactory $mimePartInterfaceFactory = null,
88-
MailAddressConverter $mailAddressConverter = null
87+
AddressConverter $addressConverter = null
8988
) {
9089
parent::__construct(
9190
$templateFactory,
@@ -97,16 +96,16 @@ public function __construct(
9796
$emailMessageInterfaceFactory,
9897
$mimeMessageInterfaceFactory,
9998
$mimePartInterfaceFactory,
100-
$mailAddressConverter
99+
$addressConverter
101100
);
102101
$this->emailMessageInterfaceFactory = $emailMessageInterfaceFactory ?: $this->objectManager
103102
->get(EmailMessageInterfaceFactory::class);
104103
$this->mimeMessageInterfaceFactory = $mimeMessageInterfaceFactory ?: $this->objectManager
105104
->get(MimeMessageInterfaceFactory::class);
106105
$this->mimePartInterfaceFactory = $mimePartInterfaceFactory ?: $this->objectManager
107106
->get(MimePartInterfaceFactory::class);
108-
$this->mailAddressConverter = $mailAddressConverter ?: $this->objectManager
109-
->get(MailAddressConverter::class);
107+
$this->addressConverter = $addressConverter ?: $this->objectManager
108+
->get(AddressConverter::class);
110109
}
111110

112111
/**
@@ -285,11 +284,11 @@ private function getMailAddresses(string $addressType, $emailOrList, ?string $na
285284
if (is_array($emailOrList)) {
286285
$this->messageData[$addressType] = array_merge(
287286
$this->messageData[$addressType],
288-
$this->mailAddressConverter->convertMany($emailOrList)
287+
$this->addressConverter->convertMany($emailOrList)
289288
);
290289

291290
return;
292291
}
293-
$this->messageData[$addressType][] = $this->mailAddressConverter->convert($emailOrList, $name);
292+
$this->messageData[$addressType][] = $this->addressConverter->convert($emailOrList, $name);
294293
}
295294
}

‎lib/internal/Magento/Framework/Mail/MailAddress.php renamed to ‎lib/internal/Magento/Framework/Mail/Address.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
/**
1111
* Class MailAddress
1212
*/
13-
class MailAddress
13+
class Address
1414
{
1515
/**
1616
* @var string|null

‎lib/internal/Magento/Framework/Mail/MailAddressConverter.php renamed to ‎lib/internal/Magento/Framework/Mail/AddressConverter.php

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,24 @@
1616
use Magento\Framework\Exception\MailException;
1717

1818
/**
19-
* Class MailAddressConverter
19+
* Class AddressConverter
2020
*/
21-
class MailAddressConverter
21+
class AddressConverter
2222
{
2323
/**
24-
* @var MailAddressFactory
24+
* @var AddressFactory
2525
*/
26-
private $mailAddressFactory;
26+
private $addressFactory;
2727

2828
/**
29-
* MailAddressConverter constructor
29+
* AddressConverter constructor
3030
*
31-
* @param MailAddressFactory $mailAddressFactory
31+
* @param AddressFactory $addressFactory
3232
*/
3333
public function __construct(
34-
MailAddressFactory $mailAddressFactory
34+
AddressFactory $addressFactory
3535
) {
36-
$this->mailAddressFactory = $mailAddressFactory;
36+
$this->addressFactory = $addressFactory;
3737
}
3838

3939
/**
@@ -42,11 +42,11 @@ public function __construct(
4242
* @param string $email
4343
* @param string|null $name
4444
*
45-
* @return MailAddress
45+
* @return Address
4646
*/
47-
public function convert(string $email, ?string $name = null): MailAddress
47+
public function convert(string $email, ?string $name = null): Address
4848
{
49-
return $this->mailAddressFactory->create(
49+
return $this->addressFactory->create(
5050
[
5151
'name' => $name,
5252
'email' => $email
@@ -59,7 +59,7 @@ public function convert(string $email, ?string $name = null): MailAddress
5959
*
6060
* @param array $addresses
6161
*
62-
* @return MailAddress[]
62+
* @return Address[]
6363
* @throws MailException
6464
*/
6565
public function convertMany(array $addresses): array

‎lib/internal/Magento/Framework/Mail/EmailMessage.php

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -29,27 +29,22 @@ class EmailMessage implements EmailMessageInterface
2929
private $mimeMessageFactory;
3030

3131
/**
32-
* @var MailAddressListFactory
32+
* @var AddressFactory
3333
*/
34-
private $mailAddressListFactory;
35-
36-
/**
37-
* @var MailAddressFactory
38-
*/
39-
private $mailAddressFactory;
34+
private $addressFactory;
4035

4136
/**
4237
* EmailMessage constructor
4338
*
4439
* @param MimeMessageInterface $body
4540
* @param array $to
4641
* @param MimeMessageInterfaceFactory $mimeMessageFactory
47-
* @param MailAddressFactory $mailAddressFactory
48-
* @param MailAddress[]|null $from
49-
* @param MailAddress[]|null $cc
50-
* @param MailAddress[]|null $bcc
51-
* @param MailAddress[]|null $replyTo
52-
* @param MailAddress|null $sender
42+
* @param AddressFactory $addressFactory
43+
* @param Address[]|null $from
44+
* @param Address[]|null $cc
45+
* @param Address[]|null $bcc
46+
* @param Address[]|null $replyTo
47+
* @param Address|null $sender
5348
* @param string|null $subject
5449
* @param string|null $encoding
5550
*
@@ -60,12 +55,12 @@ public function __construct(
6055
MimeMessageInterface $body,
6156
array $to,
6257
MimeMessageInterfaceFactory $mimeMessageFactory,
63-
MailAddressFactory $mailAddressFactory,
58+
AddressFactory $addressFactory,
6459
?array $from = null,
6560
?array $cc = null,
6661
?array $bcc = null,
6762
?array $replyTo = null,
68-
?MailAddress $sender = null,
63+
?Address $sender = null,
6964
?string $subject = '',
7065
?string $encoding = ''
7166
) {
@@ -101,7 +96,7 @@ public function __construct(
10196
$this->convertMailAddressArrayToZendAddressList($bcc)
10297
);
10398
$this->mimeMessageFactory = $mimeMessageFactory;
104-
$this->mailAddressFactory = $mailAddressFactory;
99+
$this->addressFactory = $addressFactory;
105100
}
106101

107102
/**
@@ -163,14 +158,14 @@ public function getReplyTo(): ?array
163158
/**
164159
* @inheritDoc
165160
*/
166-
public function getSender(): ?MailAddress
161+
public function getSender(): ?Address
167162
{
168163
/** @var ZendAddress $zendSender */
169164
if (!$zendSender = $this->message->getSender()) {
170165
return null;
171166
}
172167

173-
return $this->mailAddressFactory->create(
168+
return $this->addressFactory->create(
174169
[
175170
'email' => $zendSender->getEmail(),
176171
'name' => $zendSender->getName()
@@ -224,14 +219,14 @@ public function toString(): string
224219
* Converts AddressList to array
225220
*
226221
* @param AddressList $addressList
227-
* @return MailAddress[]
222+
* @return Address[]
228223
*/
229224
private function convertAddressListToMailAddressList(AddressList $addressList): array
230225
{
231226
$arrayList = [];
232227
foreach ($addressList as $address) {
233228
$arrayList[] =
234-
$this->mailAddressFactory->create(
229+
$this->addressFactory->create(
235230
[
236231
'email' => $address->getEmail(),
237232
'name' => $address->getName()
@@ -245,7 +240,7 @@ private function convertAddressListToMailAddressList(AddressList $addressList):
245240
/**
246241
* Converts MailAddress array to AddressList
247242
*
248-
* @param MailAddress[] $arrayList
243+
* @param Address[] $arrayList
249244
* @return AddressList
250245
*/
251246
private function convertMailAddressArrayToZendAddressList(array $arrayList): AddressList

‎lib/internal/Magento/Framework/Mail/EmailMessageInterface.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,44 +28,44 @@ public function getHeaders(): array;
2828
/**
2929
* Retrieve list of From senders
3030
*
31-
* @return MailAddress[]|null
31+
* @return Address[]|null
3232
*/
3333
public function getFrom(): ?array;
3434

3535
/**
3636
* Access the address list of the To header
3737
*
38-
* @return MailAddress[]
38+
* @return Address[]
3939
*/
4040
public function getTo(): array;
4141

4242
/**
4343
* Retrieve list of CC recipients
4444
*
45-
* @return MailAddress[]|null
45+
* @return Address[]|null
4646
*/
4747
public function getCc(): ?array;
4848

4949
/**
5050
* Retrieve list of Bcc recipients
5151
*
52-
* @return MailAddress[]|null
52+
* @return Address[]|null
5353
*/
5454
public function getBcc(): ?array;
5555

5656
/**
5757
* Access the address list of the Reply-To header
5858
*
59-
* @return MailAddress[]|null
59+
* @return Address[]|null
6060
*/
6161
public function getReplyTo(): ?array;
6262

6363
/**
6464
* Retrieve the sender address, if any
6565
*
66-
* @return MailAddress|null
66+
* @return Address|null
6767
*/
68-
public function getSender(): ?MailAddress;
68+
public function getSender(): ?Address;
6969

7070
/**
7171
* Get the message subject header value

‎lib/internal/Magento/Framework/Mail/Template/TransportBuilder.php

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
use Magento\Framework\Exception\MailException;
1515
use Magento\Framework\Mail\EmailMessageInterface;
1616
use Magento\Framework\Mail\EmailMessageInterfaceFactory;
17-
use Magento\Framework\Mail\MailAddressConverter;
17+
use Magento\Framework\Mail\AddressConverter;
1818
use Magento\Framework\Mail\MessageInterface;
1919
use Magento\Framework\Mail\MessageInterfaceFactory;
2020
use Magento\Framework\Mail\MimeInterface;
@@ -125,9 +125,9 @@ class TransportBuilder
125125
private $mimePartInterfaceFactory;
126126

127127
/**
128-
* @var MailAddressConverter|null
128+
* @var AddressConverter|null
129129
*/
130-
private $mailAddressConverter;
130+
private $addressConverter;
131131

132132
/**
133133
* TransportBuilder constructor
@@ -141,7 +141,7 @@ class TransportBuilder
141141
* @param EmailMessageInterfaceFactory|null $emailMessageInterfaceFactory
142142
* @param MimeMessageInterfaceFactory|null $mimeMessageInterfaceFactory
143143
* @param MimePartInterfaceFactory|null $mimePartInterfaceFactory
144-
* @param MailAddressConverter|null $mailAddressConverter
144+
* @param addressConverter|null $addressConverter
145145
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
146146
*/
147147
public function __construct(
@@ -154,7 +154,7 @@ public function __construct(
154154
EmailMessageInterfaceFactory $emailMessageInterfaceFactory = null,
155155
MimeMessageInterfaceFactory $mimeMessageInterfaceFactory = null,
156156
MimePartInterfaceFactory $mimePartInterfaceFactory = null,
157-
MailAddressConverter $mailAddressConverter=null
157+
AddressConverter $addressConverter=null
158158
) {
159159
$this->templateFactory = $templateFactory;
160160
$this->objectManager = $objectManager;
@@ -166,8 +166,8 @@ public function __construct(
166166
->get(MimeMessageInterfaceFactory::class);
167167
$this->mimePartInterfaceFactory = $mimePartInterfaceFactory ?: $this->objectManager
168168
->get(MimePartInterfaceFactory::class);
169-
$this->mailAddressConverter = $mailAddressConverter ?: $this->objectManager
170-
->get(MailAddressConverter::class);
169+
$this->addressConverter = $addressConverter ?: $this->objectManager
170+
->get(AddressConverter::class);
171171
}
172172

173173
/**
@@ -416,11 +416,11 @@ private function getMailAddresses(string $addressType, $emailOrList, ?string $na
416416
if (is_array($emailOrList)) {
417417
$this->messageData[$addressType] = array_merge(
418418
$this->messageData[$addressType],
419-
$this->mailAddressConverter->convertMany($emailOrList)
419+
$this->addressConverter->convertMany($emailOrList)
420420
);
421421

422422
return;
423423
}
424-
$this->messageData[$addressType][] = $this->mailAddressConverter->convert($emailOrList, $name);
424+
$this->messageData[$addressType][] = $this->addressConverter->convert($emailOrList, $name);
425425
}
426426
}

0 commit comments

Comments
 (0)