-
Notifications
You must be signed in to change notification settings - Fork 9.4k
/
Copy pathTemplate.php
240 lines (223 loc) · 7.81 KB
/
Template.php
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Newsletter\Model;
/**
* Template model
*
* @method \Magento\Newsletter\Model\ResourceModel\Template _getResource()
* @method \Magento\Newsletter\Model\ResourceModel\Template getResource()
* @method string getTemplateCode()
* @method \Magento\Newsletter\Model\Template setTemplateCode(string $value)
* @method \Magento\Newsletter\Model\Template setTemplateText(string $value)
* @method \Magento\Newsletter\Model\Template setTemplateTextPreprocessed(string $value)
* @method string getTemplateStyles()
* @method \Magento\Newsletter\Model\Template setTemplateStyles(string $value)
* @method int getTemplateType()
* @method \Magento\Newsletter\Model\Template setTemplateType(int $value)
* @method string getTemplateSubject()
* @method \Magento\Newsletter\Model\Template setTemplateSubject(string $value)
* @method string getTemplateSenderName()
* @method \Magento\Newsletter\Model\Template setTemplateSenderName(string $value)
* @method string getTemplateSenderEmail()
* @method \Magento\Newsletter\Model\Template setTemplateSenderEmail(string $value)
* @method int getTemplateActual()
* @method \Magento\Newsletter\Model\Template setTemplateActual(int $value)
* @method string getAddedAt()
* @method \Magento\Newsletter\Model\Template setAddedAt(string $value)
* @method string getModifiedAt()
* @method \Magento\Newsletter\Model\Template setModifiedAt(string $value)
*
* @author Magento Core Team <[email protected]>
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*
* @api
*/
class Template extends \Magento\Email\Model\AbstractTemplate
{
/**
* Store manager to emulate design
*
* @var \Magento\Store\Model\StoreManagerInterface
*/
protected $_storeManager;
/**
* Http-request, used to determine current store in multi-store mode
*
* @var \Magento\Framework\App\RequestInterface
*/
protected $_request;
/**
* Filter factory
*
* @var \Magento\Newsletter\Model\Template\FilterFactory
*/
protected $_filterFactory;
/**
* @param \Magento\Framework\Model\Context $context
* @param \Magento\Framework\View\DesignInterface $design
* @param \Magento\Framework\Registry $registry
* @param \Magento\Store\Model\App\Emulation $appEmulation
* @param \Magento\Store\Model\StoreManagerInterface $storeManager
* @param \Magento\Framework\View\Asset\Repository $assetRepo
* @param \Magento\Framework\Filesystem $filesystem
* @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
* @param \Magento\Email\Model\Template\Config $emailConfig
* @param \Magento\Email\Model\TemplateFactory $templateFactory The template directive requires an email
* template model, not newsletter model, as templates overridden in backend are loaded from email table.
* @param \Magento\Framework\Filter\FilterManager $filterManager
* @param \Magento\Framework\Url|\Magento\Framework\UrlInterface $urlModel
* @param \Magento\Framework\App\RequestInterface $request
* @param \Magento\Newsletter\Model\Template\FilterFactory $filterFactory ,
* @param array $data
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
*/
public function __construct(
\Magento\Framework\Model\Context $context,
\Magento\Framework\View\DesignInterface $design,
\Magento\Framework\Registry $registry,
\Magento\Store\Model\App\Emulation $appEmulation,
\Magento\Store\Model\StoreManagerInterface $storeManager,
\Magento\Framework\View\Asset\Repository $assetRepo,
\Magento\Framework\Filesystem $filesystem,
\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
\Magento\Email\Model\Template\Config $emailConfig,
\Magento\Email\Model\TemplateFactory $templateFactory,
\Magento\Framework\Filter\FilterManager $filterManager,
\Magento\Framework\UrlInterface $urlModel,
\Magento\Framework\App\RequestInterface $request,
\Magento\Newsletter\Model\Template\FilterFactory $filterFactory,
array $data = []
) {
parent::__construct(
$context,
$design,
$registry,
$appEmulation,
$storeManager,
$assetRepo,
$filesystem,
$scopeConfig,
$emailConfig,
$templateFactory,
$filterManager,
$urlModel,
$data
);
$this->_storeManager = $storeManager;
$this->_request = $request;
$this->_filterFactory = $filterFactory;
}
/**
* Initialize resource model
*
* @return void
*/
protected function _construct()
{
$this->_init(\Magento\Newsletter\Model\ResourceModel\Template::class);
}
/**
* Validate Newsletter template
*
* @return void
* @throws \Magento\Framework\Exception\LocalizedException
*/
public function validate()
{
$validators = [
'template_code' => [\Zend_Filter_Input::ALLOW_EMPTY => false],
'template_type' => 'Int',
'template_sender_email' => 'EmailAddress',
'template_sender_name' => [\Zend_Filter_Input::ALLOW_EMPTY => false],
];
$data = [];
foreach (array_keys($validators) as $validateField) {
$data[$validateField] = $this->getDataUsingMethod($validateField);
}
$validateInput = new \Zend_Filter_Input([], $validators, $data);
if (!$validateInput->isValid()) {
$errorMessages = [];
foreach ($validateInput->getMessages() as $messages) {
if (is_array($messages)) {
foreach ($messages as $message) {
$errorMessages[] = $message;
}
} else {
$errorMessages[] = $messages;
}
}
throw new \Magento\Framework\Exception\LocalizedException(__(join("\n", $errorMessages)));
}
}
/**
* Processing object before save data
*
* @return $this
*/
public function beforeSave()
{
$this->validate();
parent::beforeSave();
return $this;
}
/**
* Getter for template type
*
* @return int|string
*/
public function getType()
{
return $this->getTemplateType();
}
/**
* Retrieve processed template subject
*
* @param array $variables
* @return string
*/
public function getProcessedTemplateSubject(array $variables)
{
$variables['this'] = $this;
return $this->getTemplateFilter()
->setVariables($variables)
->filter($this->getTemplateSubject());
}
/**
* Retrieve template text wrapper
*
* @return string
*/
public function getTemplateText()
{
if (!$this->getData('template_text') && !$this->getId()) {
$this->setData(
'template_text',
__(
'Follow this link to unsubscribe <!-- This tag is for unsubscribe link -->' .
'<a href="{{var subscriber.getUnsubscriptionLink()}}">{{var subscriber.getUnsubscriptionLink()}}' .
'</a>'
)
);
}
return $this->getData('template_text');
}
/**
* @return \Magento\Newsletter\Model\Template\FilterFactory
*/
protected function getFilterFactory()
{
return $this->_filterFactory;
}
/**
* Check if template can be added to newsletter queue
*
* @return boolean
*/
public function isValidForSend()
{
return $this->getTemplateSenderName() && $this->getTemplateSenderEmail() && $this->getTemplateSubject();
}
}