Your IP : 216.73.217.95
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\ImportExport\Model\Export\Entity;
use Magento\Eav\Model\Entity\Attribute\AbstractAttribute;
use Magento\Eav\Model\Entity\Collection\AbstractCollection;
use Magento\ImportExport\Model\Export;
use Magento\ImportExport\Model\Import;
use Magento\Store\Model\Store;
/**
* Export EAV entity abstract model
*
* phpcs:ignore Magento2.Classes.AbstractApi
* @api
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @since 100.0.2
*/
abstract class AbstractEav extends \Magento\ImportExport\Model\Export\AbstractEntity
{
/**
* Attribute code to its values. Only attributes with options and only default store values used
*
* @var array
*/
protected $_attributeValues = [];
/**
* Attribute code to its types. Only attributes with options
*
* @var array
* @since 100.2.0
*/
protected $attributeTypes = [];
/**
* @var int
*/
protected $_entityTypeId;
/**
* Attributes with index (not label) value
*
* @var string[]
*/
protected $_indexValueAttributes = [];
/**
* @var \Magento\Framework\Stdlib\DateTime\TimezoneInterface
*/
protected $_localeDate;
/**
* @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 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,
array $data = []
) {
$this->_localeDate = $localeDate;
parent::__construct($scopeConfig, $storeManager, $collectionFactory, $resourceColFactory, $data);
if (isset($data['entity_type_id'])) {
$this->_entityTypeId = $data['entity_type_id'];
} else {
$this->_entityTypeId = $eavConfig->getEntityType($this->getEntityTypeCode())->getEntityTypeId();
}
}
/**
* Initialize attribute option values
*
* @return $this
*/
protected function _initAttributeValues()
{
/** @var $attribute AbstractAttribute */
foreach ($this->getAttributeCollection() as $attribute) {
$this->_attributeValues[$attribute->getAttributeCode()] = $this->getAttributeOptions($attribute);
}
return $this;
}
/**
* Initializes attribute types
*
* @return $this
* @since 100.2.0
*/
protected function _initAttributeTypes()
{
/** @var $attribute AbstractAttribute */
foreach ($this->getAttributeCollection() as $attribute) {
$this->attributeTypes[$attribute->getAttributeCode()] = $attribute->getFrontendInput();
}
return $this;
}
/**
* Apply filter to collection and add not skipped attributes to select
*
* @param AbstractCollection $collection
* @return AbstractCollection
*/
protected function _prepareEntityCollection(AbstractCollection $collection)
{
$this->filterEntityCollection($collection);
$this->_addAttributesToCollection($collection);
return $collection;
}
/**
* Apply filter to collection
*
* @param AbstractCollection $collection
* @return AbstractCollection
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
public function filterEntityCollection(AbstractCollection $collection)
{
if (!isset(
$this->_parameters[Export::FILTER_ELEMENT_GROUP]
) || !is_array(
$this->_parameters[Export::FILTER_ELEMENT_GROUP]
)
) {
$exportFilter = [];
} else {
$exportFilter = $this->_parameters[Export::FILTER_ELEMENT_GROUP];
}
/** @var $attribute AbstractAttribute */
foreach ($this->filterAttributeCollection($this->getAttributeCollection()) as $attribute) {
$attributeCode = $attribute->getAttributeCode();
// filter applying
if (isset($exportFilter[$attributeCode])) {
$attributeFilterType = Export::getAttributeFilterType($attribute);
if (Export::FILTER_TYPE_SELECT == $attributeFilterType) {
if (is_scalar($exportFilter[$attributeCode]) && trim($exportFilter[$attributeCode])) {
$collection->addAttributeToFilter(
$attributeCode,
['eq' => $exportFilter[$attributeCode]]
);
} elseif (is_array($exportFilter[$attributeCode])) {
$collection->addAttributeToFilter(
$attributeCode,
['in' => $exportFilter[$attributeCode]]
);
}
} elseif (Export::FILTER_TYPE_MULTISELECT == $attributeFilterType) {
if (is_array($exportFilter[$attributeCode])) {
array_filter($exportFilter[$attributeCode]);
foreach ($exportFilter[$attributeCode] as $val) {
$collection->addAttributeToFilter(
$attributeCode,
['finset' => $val]
);
}
}
} elseif (Export::FILTER_TYPE_INPUT == $attributeFilterType) {
if (is_scalar($exportFilter[$attributeCode]) && trim($exportFilter[$attributeCode])) {
$collection->addAttributeToFilter(
$attributeCode,
['like' => "%{$exportFilter[$attributeCode]}%"]
);
}
} elseif (Export::FILTER_TYPE_DATE == $attributeFilterType) {
if (is_array($exportFilter[$attributeCode]) && count($exportFilter[$attributeCode]) == 2) {
$from = array_shift($exportFilter[$attributeCode]);
$to = array_shift($exportFilter[$attributeCode]);
if (is_scalar($from) && !empty($from)) {
$date = $this->_localeDate->date($from);
$collection->addAttributeToFilter($attributeCode, ['from' => $date, 'date' => true]);
}
if (is_scalar($to) && !empty($to)) {
$date = $this->_localeDate->date($to);
$collection->addAttributeToFilter($attributeCode, ['to' => $date, 'date' => true]);
}
}
} elseif (Export::FILTER_TYPE_NUMBER == $attributeFilterType) {
if (is_array($exportFilter[$attributeCode]) && count($exportFilter[$attributeCode]) == 2) {
$from = array_shift($exportFilter[$attributeCode]);
$to = array_shift($exportFilter[$attributeCode]);
if (is_numeric($from)) {
$collection->addAttributeToFilter($attributeCode, ['from' => $from]);
}
if (is_numeric($to)) {
$collection->addAttributeToFilter($attributeCode, ['to' => $to]);
}
}
}
}
}
return $collection;
}
/**
* Add not skipped attributes to select
*
* @param AbstractCollection $collection
* @return AbstractCollection
*/
protected function _addAttributesToCollection(AbstractCollection $collection)
{
$attributeCodes = $this->_getExportAttributeCodes();
$collection->addAttributeToSelect($attributeCodes);
return $collection;
}
/**
* Returns attributes all values in label-value or value-value pairs form. Labels are lower-cased
*
* @param AbstractAttribute $attribute
* @return array
*/
public function getAttributeOptions(AbstractAttribute $attribute)
{
$options = [];
if ($attribute->usesSource()) {
// should attribute has index (option value) instead of a label?
$index = in_array($attribute->getAttributeCode(), $this->_indexValueAttributes) ? 'value' : 'label';
// only default (admin) store values used
$attribute->setStoreId(Store::DEFAULT_STORE_ID);
try {
foreach ($attribute->getSource()->getAllOptions(false) as $option) {
$optionValues = is_array($option['value']) ? $option['value'] : [$option];
foreach ($optionValues as $innerOption) {
if (isset($innerOption['value']) && strlen($innerOption['value'])) {
// skip ' -- Please Select -- ' option
$options[$innerOption['value']] = $innerOption[$index];
}
}
}
// phpcs:ignore Magento2.CodeAnalysis.EmptyBlock.DetectedCatch
} catch (\Exception $e) {
// ignore exceptions connected with source models
}
}
return $options;
}
/**
* Entity type ID getter
*
* @return int
*/
public function getEntityTypeId()
{
return $this->_entityTypeId;
}
/**
* Fill row with attributes values
*
* @param \Magento\Framework\Model\AbstractModel $item export entity
* @param array $row data row
* @return array
*/
protected function _addAttributeValuesToRow(\Magento\Framework\Model\AbstractModel $item, array $row = [])
{
$validAttributeCodes = $this->_getExportAttributeCodes();
// go through all valid attribute codes
foreach ($validAttributeCodes as $attributeCode) {
$attributeValue = $item->getData($attributeCode);
if ($this->isMultiselect($attributeCode)) {
$values = [];
$attributeValue = explode(Import::DEFAULT_GLOBAL_MULTI_VALUE_SEPARATOR, $attributeValue);
foreach ($attributeValue as $value) {
$values[] = $this->getAttributeValueById($attributeCode, $value);
}
$row[$attributeCode] = implode(Import::DEFAULT_GLOBAL_MULTI_VALUE_SEPARATOR, $values);
} else {
$row[$attributeCode] = $this->getAttributeValueById($attributeCode, $attributeValue);
}
}
return $row;
}
/**
* Checks that attribute is multiselect type by attribute code
*
* @param string $attributeCode An attribute code
* @return bool Returns true if attribute is multiselect type
*/
private function isMultiselect($attributeCode)
{
return isset($this->attributeTypes[$attributeCode])
&& $this->attributeTypes[$attributeCode] === 'multiselect';
}
/**
* Returns attribute value by id
*
* @param string $attributeCode An attribute code
* @param int|string $valueId
* @return mixed
*/
private function getAttributeValueById($attributeCode, $valueId)
{
if (isset($this->_attributeValues[$attributeCode])
&& isset($this->_attributeValues[$attributeCode][$valueId])
) {
return $this->_attributeValues[$attributeCode][$valueId];
}
return $valueId;
}
}