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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
/**
* Persistent Shopping Cart Data Helper
*/
namespace Magento\Persistent\Helper;
use Magento\Framework\Module\Dir;
use Magento\Store\Model\ScopeInterface;
/**
* Helper for persistence
*
* @api
* @since 100.0.2
*/
class Data extends \Magento\Framework\App\Helper\AbstractHelper
{
const XML_PATH_ENABLED = 'persistent/options/enabled';
const XML_PATH_LIFE_TIME = 'persistent/options/lifetime';
const XML_PATH_LOGOUT_CLEAR = 'persistent/options/logout_clear';
const XML_PATH_REMEMBER_ME_ENABLED = 'persistent/options/remember_enabled';
const XML_PATH_REMEMBER_ME_DEFAULT = 'persistent/options/remember_default';
const XML_PATH_PERSIST_SHOPPING_CART = 'persistent/options/shopping_cart';
/**
* Name of config file
*
* @var string
*/
protected $_configFileName = 'persistent.xml';
/**
* @var \Magento\Framework\Escaper
*/
protected $_escaper;
/**
* @var \Magento\Framework\Module\Dir\Reader
*/
protected $_modulesReader;
/**
* @param \Magento\Framework\App\Helper\Context $context
* @param \Magento\Framework\Module\Dir\Reader $modulesReader
* @param \Magento\Framework\Escaper $escaper
*/
public function __construct(
\Magento\Framework\App\Helper\Context $context,
\Magento\Framework\Module\Dir\Reader $modulesReader,
\Magento\Framework\Escaper $escaper
) {
$this->_modulesReader = $modulesReader;
$this->_escaper = $escaper;
parent::__construct(
$context
);
}
/**
* Checks whether Persistence Functionality is enabled
*
* @param int|string|\Magento\Store\Model\Store $store
* @return bool
* @codeCoverageIgnore
*/
public function isEnabled($store = null)
{
return $this->scopeConfig->isSetFlag(
self::XML_PATH_ENABLED,
ScopeInterface::SCOPE_STORE,
$store
);
}
/**
* Checks whether "Remember Me" enabled
*
* @param int|string|\Magento\Store\Model\Store $store
* @return bool
* @codeCoverageIgnore
*/
public function isRememberMeEnabled($store = null)
{
return $this->scopeConfig->isSetFlag(
self::XML_PATH_REMEMBER_ME_ENABLED,
ScopeInterface::SCOPE_STORE,
$store
);
}
/**
* Is "Remember Me" checked by default
*
* @param int|string|\Magento\Store\Model\Store $store
* @return bool
* @codeCoverageIgnore
*/
public function isRememberMeCheckedDefault($store = null)
{
return $this->scopeConfig->isSetFlag(
self::XML_PATH_REMEMBER_ME_DEFAULT,
ScopeInterface::SCOPE_STORE,
$store
);
}
/**
* Is shopping cart persist
*
* @param int|string|\Magento\Store\Model\Store $store
* @return bool
* @codeCoverageIgnore
*/
public function isShoppingCartPersist($store = null)
{
return $this->scopeConfig->isSetFlag(
self::XML_PATH_PERSIST_SHOPPING_CART,
ScopeInterface::SCOPE_STORE,
$store
);
}
/**
* Get Persistence Lifetime
*
* @param int|string|\Magento\Store\Model\Store $store
* @return int
*/
public function getLifeTime($store = null)
{
$lifeTime = (int)$this->scopeConfig->getValue(
self::XML_PATH_LIFE_TIME,
ScopeInterface::SCOPE_STORE,
$store
);
return $lifeTime < 0 ? 0 : $lifeTime;
}
/**
* Check if set `Clear on Logout` in config settings
*
* @return bool
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
* @codeCoverageIgnore
*/
public function getClearOnLogout()
{
return $this->scopeConfig->isSetFlag(
self::XML_PATH_LOGOUT_CLEAR,
ScopeInterface::SCOPE_STORE
);
}
/**
* Retrieve url for unset long-term cookie
*
* @return string
* @codeCoverageIgnore
*/
public function getUnsetCookieUrl()
{
return $this->_getUrl('persistent/index/unsetCookie');
}
/**
* Retrieve path for config file
*
* @return string
*/
public function getPersistentConfigFilePath()
{
return $this->_modulesReader->getModuleDir(Dir::MODULE_ETC_DIR, $this->_getModuleName())
. '/' . $this->_configFileName;
}
/**
* Check whether specified action should be processed
*
* @param \Magento\Framework\Event\Observer $observer
* @return bool
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
* @codeCoverageIgnore
*/
public function canProcess($observer)
{
return true;
}
}