/
Config.php
190 lines (167 loc) · 5.53 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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Customer\Model\Address;
use Magento\Framework\Config\Data as ConfigData;
use Magento\Framework\DataObject;
use Magento\Store\Model\ScopeInterface;
/**
* Customer address config
*
* @author Magento Core Team <core@magentocommerce.com>
*/
class Config extends ConfigData
{
const DEFAULT_ADDRESS_RENDERER = 'Magento\Customer\Block\Address\Renderer\DefaultRenderer';
const XML_PATH_ADDRESS_TEMPLATE = 'customer/address_templates/';
const DEFAULT_ADDRESS_FORMAT = 'oneline';
/**
* Customer Address Templates per store
*
* @var array
*/
protected $_types = [];
/**
* Current store instance
*
* @var \Magento\Store\Model\Store
*/
protected $_store = null;
/**
* Default types per store
* Using for invalid code
*
* @var array
*/
protected $_defaultTypes = [];
/**
* @var \Magento\Store\Model\StoreManagerInterface
*/
protected $_storeManager;
/**
* @var \Magento\Customer\Helper\Address
*/
protected $_addressHelper;
/**
* @var \Magento\Framework\App\Config\ScopeConfigInterface
*/
protected $_scopeConfig;
/**
* @param \Magento\Customer\Model\Address\Config\Reader $reader
* @param \Magento\Framework\Config\CacheInterface $cache
* @param \Magento\Store\Model\StoreManagerInterface $storeManager
* @param \Magento\Customer\Helper\Address $addressHelper
* @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
* @param string $cacheId
*/
public function __construct(
\Magento\Customer\Model\Address\Config\Reader $reader,
\Magento\Framework\Config\CacheInterface $cache,
\Magento\Store\Model\StoreManagerInterface $storeManager,
\Magento\Customer\Helper\Address $addressHelper,
\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
$cacheId = 'address_format'
) {
parent::__construct($reader, $cache, $cacheId);
$this->_storeManager = $storeManager;
$this->_addressHelper = $addressHelper;
$this->_scopeConfig = $scopeConfig;
}
/**
* Set store
*
* @param null|string|bool|int|\Magento\Store\Model\Store $store
* @return $this
*/
public function setStore($store)
{
$this->_store = $this->_storeManager->getStore($store);
return $this;
}
/**
* Retrieve store
*
* @return \Magento\Store\Model\Store
*/
public function getStore()
{
if ($this->_store === null) {
$this->_store = $this->_storeManager->getStore();
}
return $this->_store;
}
/**
* Retrieve address formats
*
* @return array
*/
public function getFormats()
{
$store = $this->getStore();
$storeId = $store->getId();
if (!isset($this->_types[$storeId])) {
$this->_types[$storeId] = [];
foreach ($this->get() as $typeCode => $typeConfig) {
$path = sprintf('%s%s', self::XML_PATH_ADDRESS_TEMPLATE, $typeCode);
$type = new DataObject();
if (isset($typeConfig['escapeHtml'])) {
$escapeHtml = $typeConfig['escapeHtml'] == 'true' || $typeConfig['escapeHtml'] == '1';
} else {
$escapeHtml = false;
}
$type->setCode($typeCode)
->setTitle((string)$typeConfig['title'])
->setDefaultFormat($this->_scopeConfig->getValue($path, ScopeInterface::SCOPE_STORE, $store))
->setEscapeHtml($escapeHtml);
$renderer = isset($typeConfig['renderer']) ? (string)$typeConfig['renderer'] : null;
if (!$renderer) {
$renderer = self::DEFAULT_ADDRESS_RENDERER;
}
$type->setRenderer($this->_addressHelper->getRenderer($renderer)->setType($type));
$this->_types[$storeId][] = $type;
}
}
return $this->_types[$storeId];
}
/**
* Retrieve default address format
*
* @return DataObject
*/
protected function _getDefaultFormat()
{
$store = $this->getStore();
$storeId = $store->getId();
if (!isset($this->_defaultTypes[$storeId])) {
$this->_defaultTypes[$storeId] = new DataObject();
$this->_defaultTypes[$storeId]->setCode(
'default'
)->setDefaultFormat(
'{{depend prefix}}{{var prefix}} {{/depend}}{{var firstname}} {{depend middlename}}' .
'{{var middlename}} {{/depend}}{{var lastname}}{{depend suffix}} {{var suffix}}{{/depend}}, ' .
'{{var street}}, {{var city}}, {{var region}} {{var postcode}}, {{var country}}'
);
$renderer = $this->_addressHelper->getRenderer(self::DEFAULT_ADDRESS_RENDERER)
->setType($this->_defaultTypes[$storeId]);
$this->_defaultTypes[$storeId]->setRenderer($renderer);
}
return $this->_defaultTypes[$storeId];
}
/**
* Retrieve address format by code
*
* @param string $typeCode
* @return DataObject
*/
public function getFormatByCode($typeCode)
{
foreach ($this->getFormats() as $type) {
if ($type->getCode() == $typeCode) {
return $type;
}
}
return $this->_getDefaultFormat();
}
}