-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathConfig.php
executable file
·411 lines (372 loc) · 14 KB
/
Config.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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
<?php
/*
* Copyright Magmodules.eu. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Mollie\Subscriptions;
use Exception;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\App\ProductMetadataInterface;
use Magento\Store\Api\Data\StoreInterface;
use Magento\Store\Model\ScopeInterface;
use Magento\Store\Model\StoreManagerInterface;
/**
* Config repository class
*/
class Config
{
const EXTENSION_CODE = 'Mollie_Subscriptions';
const XML_PATH_DEBUG_ERROR_EMAIL_TEMPLATE = 'mollie_subscriptions/debug/error_email_template';
const XML_PATH_DEBUG_ENABLE_ERROR_EMAILS = 'mollie_subscriptions/debug/enable_error_emails';
const XML_PATH_DEBUG_ERROR_SENDER_EMAIL = 'mollie_subscriptions/debug/error_sender_email';
const XML_PATH_DEBUG_ERROR_RECEIVER_EMAIL = 'mollie_subscriptions/debug/error_receiver_email';
const XML_PATH_EXTENSION_VERSION = 'mollie_subscriptions/general/version';
const XML_PATH_EXTENSION_ENABLE = 'mollie_subscriptions/general/enable';
const XML_PATH_EXTENSION_SHIPPING_METHOD = 'mollie_subscriptions/general/shipping_method';
const XML_PATH_DEBUG = 'mollie_subscriptions/general/debug';
const XML_PATH_PREPAYMENT_REMINDER_DAYS_BEFORE_REMINDER = 'mollie_subscriptions/prepayment_reminder/days_before_reminder';
const XML_PATH_PREPAYMENT_REMINDER_NEXT_PAYMENT_DATE_FORMAT = 'mollie_subscriptions/prepayment_reminder/next_payment_date_format';
const XML_PATH_PREPAYMENT_REMINDER_ENABLED = 'mollie_subscriptions/prepayment_reminder/enabled';
const XML_PATH_PREPAYMENT_REMINDER_TEMPLATE = 'mollie_subscriptions/prepayment_reminder/template';
const XML_PATH_PREPAYMENT_REMINDER_SEND_BCC_TO = 'mollie_subscriptions/prepayment_reminder/send_bcc_to';
const XML_PATH_EMAILS_ENABLE_ADMIN_NOTIFICATION = 'mollie_subscriptions/emails/enable_admin_notification';
const XML_PATH_EMAILS_ADMIN_NOTIFICATION_TEMPLATE = 'mollie_subscriptions/emails/admin_notification_template';
const XML_PATH_EMAILS_ENABLE_CUSTOMER_NOTIFICATION = 'mollie_subscriptions/emails/enable_customer_notification';
const XML_PATH_EMAILS_CUSTOMER_NOTIFICATION_TEMPLATE = 'mollie_subscriptions/emails/customer_notification_template';
const XML_PATH_EMAILS_ENABLE_ADMIN_RESTART_NOTIFICATION = 'mollie_subscriptions/emails/enable_admin_restart_notification';
const XML_PATH_EMAILS_ADMIN_RESTART_NOTIFICATION_TEMPLATE = 'mollie_subscriptions/emails/admin_restart_notification_template';
const XML_PATH_EMAILS_ENABLE_CUSTOMER_RESTART_NOTIFICATION = 'mollie_subscriptions/emails/enable_customer_restart_notification';
const XML_PATH_EMAILS_CUSTOMER_RESTART_NOTIFICATION_TEMPLATE = 'mollie_subscriptions/emails/customer_restart_notification_template';
const XML_PATH_EMAILS_ENABLE_ADMIN_CANCEL_NOTIFICATION = 'mollie_subscriptions/emails/enable_admin_cancel_notification';
const XML_PATH_EMAILS_ADMIN_CANCEL_NOTIFICATION_TEMPLATE = 'mollie_subscriptions/emails/admin_cancel_notification_template';
const XML_PATH_EMAILS_ENABLE_CUSTOMER_CANCEL_NOTIFICATION = 'mollie_subscriptions/emails/enable_customer_cancel_notification';
const XML_PATH_EMAILS_CUSTOMER_CANCEL_NOTIFICATION_TEMPLATE = 'mollie_subscriptions/emails/customer_cancel_notification_template';
const XML_PATH_DISABLE_NEW_ORDER_CONFIRMATION = 'mollie_subscriptions/emails/disable_new_order_confirmation';
const XML_PATH_ALLOW_ONE_TIME_PURCHASE = 'mollie_subscriptions/general/allow_one_time_purchases';
const MODULE_SUPPORT_LINK = 'https://www.magmodules.eu/help/%s';
/**
* @var StoreManagerInterface
*/
private $storeManager;
/**
* @var ScopeConfigInterface
*/
private $scopeConfig;
/**
* @var ProductMetadataInterface
*/
private $metadata;
public function __construct(
StoreManagerInterface $storeManager,
ScopeConfigInterface $scopeConfig,
ProductMetadataInterface $metadata
) {
$this->storeManager = $storeManager;
$this->scopeConfig = $scopeConfig;
$this->metadata = $metadata;
}
/**
* Get Configuration data
*
* @param string $path
* @param int|null $storeId
* @param string|null $scope
*
* @return string
*/
private function getStoreValue(
string $path,
$storeId = null,
string $scope = null
): string {
if (!$storeId) {
$storeId = (int)$this->getStore()->getId();
}
$scope = $scope ?? ScopeInterface::SCOPE_STORE;
return (string)$this->scopeConfig->getValue($path, $scope, (int)$storeId);
}
/**
* @return string
*/
public function getExtensionVersion(): string
{
return $this->getStoreValue(self::XML_PATH_EXTENSION_VERSION);
}
/**
* @return StoreInterface
*/
public function getStore(): StoreInterface
{
try {
return $this->storeManager->getStore();
} catch (Exception $e) {
if ($store = $this->storeManager->getDefaultStoreView()) {
return $store;
}
}
$stores = $this->storeManager->getStores();
return reset($stores);
}
/**
* @return string
*/
public function getMagentoVersion(): string
{
return $this->metadata->getVersion();
}
/**
* Get config value flag
*
* @param string $path
* @param int|null $storeId
* @param string|null $scope
*
* @return bool
*/
private function getFlag(string $path, int $storeId = null, string $scope = null): bool
{
if (!$storeId) {
$storeId = (int)$this->getStore()->getId();
}
$scope = $scope ?? ScopeInterface::SCOPE_STORE;
return $this->scopeConfig->isSetFlag($path, $scope, (int)$storeId);
}
/**
* @return string
*/
public function getExtensionCode(): string
{
return self::EXTENSION_CODE;
}
/**
* @param int|null $storeId
* @return bool
*/
public function isEnabled(int $storeId = null): bool
{
return $this->getFlag(self::XML_PATH_EXTENSION_ENABLE, $storeId);
}
/**
* @param int $storeId
* @param string $scope
* @return bool
*/
public function isErrorEmailEnabled(int $storeId = null, string $scope = ScopeInterface::SCOPE_STORE): bool
{
return $this->getFlag(self::XML_PATH_DEBUG_ENABLE_ERROR_EMAILS, $storeId, $scope);
}
/**
* @param int|null $storeId
* @param string $scope
* @return string
*/
public function errorEmailSender(int $storeId = null, string $scope = ScopeInterface::SCOPE_STORE): string
{
return $this->getStoreValue(self::XML_PATH_DEBUG_ERROR_SENDER_EMAIL, $storeId, $scope);
}
/**
* @param int|null $storeId
* @param string $scope
* @return string
*/
public function errorEmailReceiver(int $storeId = null, string $scope = ScopeInterface::SCOPE_STORE): string
{
return $this->getStoreValue(self::XML_PATH_DEBUG_ERROR_RECEIVER_EMAIL, $storeId, $scope);
}
/**
* @param int|null $storeId
* @return string
*/
public function getShippingMethod(int $storeId = null): string
{
return $this->getStoreValue(self::XML_PATH_EXTENSION_SHIPPING_METHOD, $storeId);
}
/**
* Support link for extension.
*
* @return string
*/
public function getSupportLink(): string
{
return sprintf(
self::MODULE_SUPPORT_LINK,
$this->getExtensionCode()
);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return bool
*/
public function isPrepaymentReminderEnabled($storeId = null, $scope = ScopeInterface::SCOPE_STORE): bool
{
return $this->getFlag(static::XML_PATH_PREPAYMENT_REMINDER_ENABLED, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return string|null
*/
public function prepaymentReminderTemplate($storeId = null, $scope = ScopeInterface::SCOPE_STORE): ?string
{
return $this->getStoreValue(static::XML_PATH_PREPAYMENT_REMINDER_TEMPLATE, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return string|null
*/
public function daysBeforePrepaymentReminder($storeId = null, $scope = ScopeInterface::SCOPE_STORE): ?string
{
return $this->getStoreValue(static::XML_PATH_PREPAYMENT_REMINDER_DAYS_BEFORE_REMINDER, $storeId, $scope);
}
public function nextPaymentDateFormat($storeId = null, $scope = ScopeInterface::SCOPE_STORE): string
{
return $this->getStoreValue(static::XML_PATH_PREPAYMENT_REMINDER_NEXT_PAYMENT_DATE_FORMAT, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return string|null
*/
public function prepaymentSendBccTo($storeId = null, $scope = ScopeInterface::SCOPE_STORE): ?string
{
return $this->getStoreValue(static::XML_PATH_PREPAYMENT_REMINDER_SEND_BCC_TO, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return bool
*/
public function allowOneTimePurchase($storeId = null, $scope = ScopeInterface::SCOPE_STORE): bool
{
return $this->getFlag(static::XML_PATH_ALLOW_ONE_TIME_PURCHASE, $storeId, $scope);
}
/**
* @param int $storeId
* @param string $scope
* @return null|string
*/
public function subscriptionErrorAdminNotificationTemplate(int $storeId = null, string $scope = ScopeInterface::SCOPE_STORE): ?string
{
return $this->getStoreValue(static::XML_PATH_DEBUG_ERROR_EMAIL_TEMPLATE, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return bool
*/
public function enableAdminNotificationEmail($storeId = null, $scope = ScopeInterface::SCOPE_STORE): bool
{
return $this->getFlag(static::XML_PATH_EMAILS_ENABLE_ADMIN_NOTIFICATION, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return string|null
*/
public function getAdminNotificationTemplate($storeId = null, $scope = ScopeInterface::SCOPE_STORE): ?string
{
return $this->getStoreValue(static::XML_PATH_EMAILS_ADMIN_NOTIFICATION_TEMPLATE, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return bool
*/
public function enableCustomerNotificationEmail($storeId = null, $scope = ScopeInterface::SCOPE_STORE): bool
{
return $this->getFlag(static::XML_PATH_EMAILS_ENABLE_CUSTOMER_NOTIFICATION, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return string|null
*/
public function getCustomerNotificationTemplate($storeId = null, $scope = ScopeInterface::SCOPE_STORE): ?string
{
return $this->getStoreValue(static::XML_PATH_EMAILS_CUSTOMER_NOTIFICATION_TEMPLATE, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return bool
*/
public function enableAdminRestartNotificationEmail($storeId = null, $scope = ScopeInterface::SCOPE_STORE): bool
{
return $this->getFlag(static::XML_PATH_EMAILS_ENABLE_ADMIN_RESTART_NOTIFICATION, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return string|null
*/
public function getAdminRestartNotificationTemplate($storeId = null, $scope = ScopeInterface::SCOPE_STORE): ?string
{
return $this->getStoreValue(static::XML_PATH_EMAILS_ADMIN_RESTART_NOTIFICATION_TEMPLATE, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return bool
*/
public function enableCustomerRestartNotificationEmail($storeId = null, $scope = ScopeInterface::SCOPE_STORE): bool
{
return $this->getFlag(static::XML_PATH_EMAILS_ENABLE_CUSTOMER_RESTART_NOTIFICATION, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return string|null
*/
public function getCustomerRestartNotificationTemplate($storeId = null, $scope = ScopeInterface::SCOPE_STORE): ?string
{
return $this->getStoreValue(static::XML_PATH_EMAILS_CUSTOMER_RESTART_NOTIFICATION_TEMPLATE, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return bool
*/
public function enableAdminCancelNotificationEmail($storeId = null, $scope = ScopeInterface::SCOPE_STORE): bool
{
return $this->getFlag(static::XML_PATH_EMAILS_ENABLE_ADMIN_CANCEL_NOTIFICATION, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return string|null
*/
public function getAdminCancelNotificationTemplate($storeId = null, $scope = ScopeInterface::SCOPE_STORE): ?string
{
return $this->getStoreValue(static::XML_PATH_EMAILS_ADMIN_CANCEL_NOTIFICATION_TEMPLATE, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return bool
*/
public function enableCustomerCancelNotificationEmail($storeId = null, $scope = ScopeInterface::SCOPE_STORE): bool
{
return $this->getFlag(static::XML_PATH_EMAILS_ENABLE_CUSTOMER_CANCEL_NOTIFICATION, $storeId, $scope);
}
/**
* @param null|int|string $storeId
* @param string $scope
* @return string|null
*/
public function getCustomerCancelNotificationTemplate($storeId = null, $scope = ScopeInterface::SCOPE_STORE): ?string
{
return $this->getStoreValue(static::XML_PATH_EMAILS_CUSTOMER_CANCEL_NOTIFICATION_TEMPLATE, $storeId, $scope);
}
/**
* @param $storeId
* @param $scope
* @return bool
*/
public function disableNewOrderConfirmation($storeId = null, $scope = ScopeInterface::SCOPE_STORE): bool
{
return $this->getFlag(static::XML_PATH_DISABLE_NEW_ORDER_CONFIRMATION, $storeId, $scope);
}
}