AbstractEntity.php

Go to the documentation of this file.

<?php
namespace Magento\ImportExport\Model\Export;

use Magento\Eav\Model\Entity\Attribute\AbstractAttribute;
use Magento\ImportExport\Model\Export\Adapter\AbstractAdapter;
use Magento\ImportExport\Model\Export;

abstract class AbstractEntity
{
    const ATTRIBUTE_COLLECTION_NAME = \Magento\Framework\Data\Collection::class;

    const XML_PATH_PAGE_SIZE = '';

    protected $_storeManager;

    protected $_errors = [];

    protected $_errorsCount = 0;

    protected $_errorsLimit = 100;

    protected $_invalidRows = [];

    protected $_messageTemplates = [];

    protected $_parameters = [];

    protected $_processedEntitiesCount = 0;

    protected $_processedRowsCount = 0;

    protected $_writer;

    protected $_storeIdToCode = [];

    protected $_websiteIdToCode = [];

    protected $_disabledAttributes = [];

    protected $_fileName = null;

    protected $_attributeCollection;

    protected $_pageSize;

    protected $_byPagesIterator;

    protected $_scopeConfig;

    protected $_attributeCodes = null;

    protected $_permanentAttributes = [];

    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,
        array $data = []
    ) {
        $this->_scopeConfig = $scopeConfig;
        $this->_storeManager = $storeManager;
        $this->_attributeCollection = isset(
            $data['attribute_collection']
        ) ? $data['attribute_collection'] : $collectionFactory->create(
            static::ATTRIBUTE_COLLECTION_NAME
        );
        $this->_pageSize = isset(
            $data['page_size']
        ) ? $data['page_size'] : (static::XML_PATH_PAGE_SIZE ? (int)$this->_scopeConfig->getValue(
            static::XML_PATH_PAGE_SIZE,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        ) : 0);
        $this->_byPagesIterator = isset(
            $data['collection_by_pages_iterator']
        ) ? $data['collection_by_pages_iterator'] : $resourceColFactory->create();
    }

    protected function _initStores()
    {
        foreach ($this->_storeManager->getStores(true) as $store) {
            $this->_storeIdToCode[$store->getId()] = $store->getCode();
        }
        ksort($this->_storeIdToCode);
        // to ensure that 'admin' store (ID is zero) goes first

        return $this;
    }

    protected function _initWebsites($withDefault = false)
    {
        foreach ($this->_storeManager->getWebsites($withDefault) as $website) {
            $this->_websiteIdToCode[$website->getId()] = $website->getCode();
        }
        return $this;
    }

    public function addRowError($errorCode, $errorRowNum)
    {
        $errorCode = (string)$errorCode;
        $this->_errors[$errorCode][] = $errorRowNum + 1;
        // one added for human readability
        $this->_invalidRows[$errorRowNum] = true;
        $this->_errorsCount++;

        return $this;
    }

    public function addMessageTemplate($errorCode, $message)
    {
        $this->_messageTemplates[$errorCode] = $message;

        return $this;
    }

    public function retrieveMessageTemplate($errorCode)
    {
        if (isset($this->_messageTemplates[$errorCode])) {
            return $this->_messageTemplates[$errorCode];
        }
        return null;
    }

    abstract public function export();

    abstract public function exportItem($item);

    protected function _exportCollectionByPages(\Magento\Framework\Data\Collection\AbstractDb $collection)
    {
        $this->_byPagesIterator->iterate($collection, $this->_pageSize, [[$this, 'exportItem']]);
    }

    protected function _getExportAttributeCodes()
    {
        if (null === $this->_attributeCodes) {
            if (!empty($this->_parameters[Export::FILTER_ELEMENT_SKIP])
                && is_array($this->_parameters[Export::FILTER_ELEMENT_SKIP])
            ) {
                $skippedAttributes = array_flip(
                    $this->_parameters[Export::FILTER_ELEMENT_SKIP]
                );
            } else {
                $skippedAttributes = [];
            }
            $attributeCodes = [];

            foreach ($this->filterAttributeCollection($this->getAttributeCollection()) as $attribute) {
                if (!isset($skippedAttributes[$attribute->getAttributeId()])
                    || in_array($attribute->getAttributeCode(), $this->_permanentAttributes)
                ) {
                    $attributeCodes[] = $attribute->getAttributeCode();
                }
            }
            $this->_attributeCodes = $attributeCodes;
        }
        return $this->_attributeCodes;
    }

    abstract public function getEntityTypeCode();

    abstract protected function _getHeaderColumns();

    abstract protected function _getEntityCollection();

    public function getAttributeCollection()
    {
        return $this->_attributeCollection;
    }

    public function filterAttributeCollection(\Magento\Framework\Data\Collection $collection)
    {
        foreach ($collection as $attribute) {
            if (in_array($attribute->getAttributeCode(), $this->_disabledAttributes)) {
                $collection->removeItemByKey($attribute->getId());
            }
        }

        return $collection;
    }

    public function getErrorMessages()
    {
        $messages = [];
        foreach ($this->_errors as $errorCode => $errorRows) {
            $message = isset(
                $this->_messageTemplates[$errorCode]
            ) ? __(
                $this->_messageTemplates[$errorCode]
            ) : __(
                'Please correct the value for "%1" column.',
                $errorCode
            );
            $message = (string)$message;
            $messages[$message] = $errorRows;
        }

        return $messages;
    }

    public function getErrorsCount()
    {
        return $this->_errorsCount;
    }

    public function getInvalidRowsCount()
    {
        return count($this->_invalidRows);
    }

    public function getProcessedEntitiesCount()
    {
        return $this->_processedEntitiesCount;
    }

    public function getProcessedRowsCount()
    {
        return $this->_processedRowsCount;
    }

    public function getWriter()
    {
        if (!$this->_writer) {
            throw new \Magento\Framework\Exception\LocalizedException(__('Please specify the writer.'));
        }

        return $this->_writer;
    }

    public function setParameters(array $parameters)
    {
        $this->_parameters = $parameters;

        return $this;
    }

    public function setWriter(AbstractAdapter $writer)
    {
        $this->_writer = $writer;

        return $this;
    }

    public function setFileName($fileName)
    {
        $this->_fileName = $fileName;
    }

    public function getFileName()
    {
        return $this->_fileName;
    }

    public function getDisabledAttributes()
    {
        return $this->_disabledAttributes;
    }
}