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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
/**
* EAV attribute data validator
*
* @author Magento Core Team <core@magentocommerce.com>
*/
namespace Magento\Eav\Model\Validator\Attribute;
use Magento\Eav\Model\Attribute;
class Data extends \Magento\Framework\Validator\AbstractValidator
{
/**
* @var array
*/
protected $_attributes = [];
/**
* @var array
*/
protected $_attributesWhiteList = [];
/**
* @var array
*/
protected $_attributesBlackList = [];
/**
* @var array
*/
protected $_data = [];
/**
* @var \Magento\Eav\Model\AttributeDataFactory
*/
protected $_attrDataFactory;
/**
* @param \Magento\Eav\Model\AttributeDataFactory $attrDataFactory
*/
public function __construct(\Magento\Eav\Model\AttributeDataFactory $attrDataFactory)
{
$this->_attrDataFactory = $attrDataFactory;
}
/**
* Set list of attributes for validation in isValid method.
*
* @param Attribute[] $attributes
* @return $this
*/
public function setAttributes(array $attributes)
{
$this->_attributes = $attributes;
return $this;
}
/**
* Set codes of attributes that should be filtered in validation process.
*
* All attributes not in this list 't be involved in validation.
*
* @param array $attributesCodes
* @return $this
*/
public function setAttributesWhiteList(array $attributesCodes)
{
$this->_attributesWhiteList = $attributesCodes;
return $this;
}
/**
* Set codes of attributes that should be excluded in validation process.
*
* All attributes in this list won't be involved in validation.
*
* @param array $attributesCodes
* @return $this
*/
public function setAttributesBlackList(array $attributesCodes)
{
$this->_attributesBlackList = $attributesCodes;
return $this;
}
/**
* Set data for validation in isValid method.
*
* @param array $data
* @return $this
*/
public function setData(array $data)
{
$this->_data = $data;
return $this;
}
/**
* Validate EAV model attributes with data models
*
* @param \Magento\Framework\Model\AbstractModel $entity
* @return bool
*/
public function isValid($entity)
{
/** @var $attributes Attribute[] */
$attributes = $this->_getAttributes($entity);
$data = [];
if ($this->_data) {
$data = $this->_data;
} elseif ($entity instanceof \Magento\Framework\DataObject) {
$data = $entity->getData();
}
foreach ($attributes as $attribute) {
$attributeCode = $attribute->getAttributeCode();
if (!$attribute->getDataModel() && !$attribute->getFrontendInput()) {
continue;
}
$dataModel = $this->_attrDataFactory->create($attribute, $entity);
$dataModel->setExtractedData($data);
if (!isset($data[$attributeCode])) {
$data[$attributeCode] = null;
}
$result = $dataModel->validateValue($data[$attributeCode]);
if (true !== $result) {
$this->_addErrorMessages($attributeCode, (array)$result);
}
}
return count($this->_messages) == 0;
}
/**
* Get attributes involved in validation.
*
* This method return specified $_attributes if they defined by setAttributes method, otherwise if $entity
* is EAV-model it returns it's all available attributes, otherwise it return empty array.
*
* @param \Magento\Framework\Model\AbstractModel $entity
* @return array
*/
protected function _getAttributes($entity)
{
/** @var \Magento\Eav\Model\Attribute[] $attributes */
$attributes = [];
if ($this->_attributes) {
$attributes = $this->_attributes;
} elseif ($entity instanceof \Magento\Framework\Model\AbstractModel &&
$entity->getResource() instanceof \Magento\Eav\Model\Entity\AbstractEntity
) { // $entity is EAV-model
/** @var \Magento\Eav\Model\Entity\Type $entityType */
$entityType = $entity->getEntityType();
$attributes = $entityType->getAttributeCollection()->getItems();
}
$attributesByCode = [];
$attributesCodes = [];
foreach ($attributes as $attribute) {
if (!$attribute->getIsVisible()) {
continue;
}
$attributeCode = $attribute->getAttributeCode();
$attributesByCode[$attributeCode] = $attribute;
$attributesCodes[] = $attributeCode;
}
$ignoreAttributes = $this->_attributesBlackList;
if ($this->_attributesWhiteList) {
$ignoreAttributes = array_merge(
$ignoreAttributes,
array_diff($attributesCodes, $this->_attributesWhiteList)
);
}
foreach ($ignoreAttributes as $attributeCode) {
unset($attributesByCode[$attributeCode]);
}
return $attributesByCode;
}
/**
* Add error messages
*
* @param string $code
* @param array $messages
* @return void
*/
protected function _addErrorMessages($code, array $messages)
{
if (!array_key_exists($code, $this->_messages)) {
$this->_messages[$code] = $messages;
} else {
$this->_messages[$code] = array_merge($this->_messages[$code], $messages);
}
}
}