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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\CustomerImportExport\Model\Export;
/**
* Export entity customer model
*
* @api
*
* @method \Magento\Customer\Model\ResourceModel\Attribute\Collection getAttributeCollection() getAttributeCollection()
* @since 100.0.2
*/
class Customer extends \Magento\ImportExport\Model\Export\Entity\AbstractEav
{
/**
* Permanent column names.
*
* Names that begins with underscore is not an attribute. This name convention is for
* to avoid interference with same attribute name.
*/
const COLUMN_EMAIL = 'email';
const COLUMN_WEBSITE = '_website';
const COLUMN_STORE = '_store';
/**
* Attribute collection name
*/
const ATTRIBUTE_COLLECTION_NAME = \Magento\Customer\Model\ResourceModel\Attribute\Collection::class;
/**
* XML path to page size parameter
*/
const XML_PATH_PAGE_SIZE = 'export/customer_page_size/customer';
/**
* @var array
*/
protected $_attributeOverrides = [
'created_at' => ['backend_type' => 'datetime'],
'reward_update_notification' => ['source_model' => \Magento\Eav\Model\Entity\Attribute\Source\Boolean::class],
'reward_warning_notification' => ['source_model' => \Magento\Eav\Model\Entity\Attribute\Source\Boolean::class],
];
/**
* Array of attributes codes which are disabled for export
*
* @var string[]
*/
protected $_disabledAttributes = ['default_billing', 'default_shipping'];
/**
* Attributes with index (not label) value.
*
* @var string[]
*/
protected $_indexValueAttributes = ['group_id', 'website_id', 'store_id'];
/**
* Permanent entity columns.
*
* @var string[]
*/
protected $_permanentAttributes = [self::COLUMN_EMAIL, self::COLUMN_WEBSITE, self::COLUMN_STORE];
/**
* Customers whose data is exported
*
* @var \Magento\Customer\Model\ResourceModel\Customer\Collection
*/
protected $_customerCollection;
/**
* @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
* @param \Magento\Store\Model\StoreManagerInterface $storeManager
* @param \Magento\ImportExport\Model\Export\Factory $collectionFactory
* @param \Magento\ImportExport\Model\ResourceModel\CollectionByPagesIteratorFactory $resourceColFactory
* @param \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate
* @param \Magento\Eav\Model\Config $eavConfig
* @param \Magento\Customer\Model\ResourceModel\Customer\CollectionFactory $customerColFactory
* @param array $data
*/
public function __construct(
\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
\Magento\Store\Model\StoreManagerInterface $storeManager,
\Magento\ImportExport\Model\Export\Factory $collectionFactory,
\Magento\ImportExport\Model\ResourceModel\CollectionByPagesIteratorFactory $resourceColFactory,
\Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate,
\Magento\Eav\Model\Config $eavConfig,
\Magento\Customer\Model\ResourceModel\Customer\CollectionFactory $customerColFactory,
array $data = []
) {
parent::__construct(
$scopeConfig,
$storeManager,
$collectionFactory,
$resourceColFactory,
$localeDate,
$eavConfig,
$data
);
$this->_customerCollection = isset(
$data['customer_collection']
) ? $data['customer_collection'] : $customerColFactory->create();
$this->_initAttributeValues()->_initAttributeTypes()->_initStores()->_initWebsites(true);
}
/**
* Export process.
*
* @return string
*/
public function export()
{
$this->_prepareEntityCollection($this->_getEntityCollection());
$writer = $this->getWriter();
// create export file
$writer->setHeaderCols($this->_getHeaderColumns());
$this->_exportCollectionByPages($this->_getEntityCollection());
return $writer->getContents();
}
/**
* Get customers collection
*
* @return \Magento\Customer\Model\ResourceModel\Customer\Collection
*/
protected function _getEntityCollection()
{
return $this->_customerCollection;
}
/**
* {@inheritdoc}
*/
protected function _getHeaderColumns()
{
$validAttributeCodes = $this->_getExportAttributeCodes();
return array_merge($this->_permanentAttributes, $validAttributeCodes, ['password']);
}
/**
* Export given customer data
*
* @param \Magento\Customer\Model\Customer $item
* @return void
*/
public function exportItem($item)
{
$row = $this->_addAttributeValuesToRow($item);
$row[self::COLUMN_WEBSITE] = $this->_websiteIdToCode[$item->getWebsiteId()];
$row[self::COLUMN_STORE] = $this->_storeIdToCode[$item->getStoreId()];
$this->getWriter()->writeRow($row);
}
/**
* Clean up already loaded attribute collection.
*
* @param \Magento\Framework\Data\Collection $collection
* @return \Magento\Framework\Data\Collection
*/
public function filterAttributeCollection(\Magento\Framework\Data\Collection $collection)
{
/** @var $attribute \Magento\Customer\Model\Attribute */
foreach (parent::filterAttributeCollection($collection) as $attribute) {
if (!empty($this->_attributeOverrides[$attribute->getAttributeCode()])) {
$data = $this->_attributeOverrides[$attribute->getAttributeCode()];
if (isset($data['options_method']) && method_exists($this, $data['options_method'])) {
$data['filter_options'] = $this->{$data['options_method']}();
}
$attribute->addData($data);
}
}
return $collection;
}
/**
* EAV entity type code getter.
*
* @return string
*/
public function getEntityTypeCode()
{
return $this->getAttributeCollection()->getEntityTypeCode();
}
/**
* Retrieve list of overridden attributes
*
* @return array
*/
public function getOverriddenAttributes()
{
return $this->_attributeOverrides;
}
}