Product Class Reference

Inheritance diagram for Product:

Public Member Functions
	__construct (\Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate, \Magento\Eav\Model\Config $config, \Magento\Framework\App\ResourceConnection $resource, \Magento\Store\Model\StoreManagerInterface $storeManager, \Psr\Log\LoggerInterface $logger, \Magento\Catalog\Model\ResourceModel\Product\CollectionFactory $collectionFactory, \Magento\ImportExport\Model\Export\ConfigInterface $exportConfig, \Magento\Catalog\Model\ResourceModel\ProductFactory $productFactory, \Magento\Eav\Model\ResourceModel\Entity\Attribute\Set\CollectionFactory $attrSetColFactory, \Magento\Catalog\Model\ResourceModel\Category\CollectionFactory $categoryColFactory, \Magento\CatalogInventory\Model\ResourceModel\Stock\ItemFactory $itemFactory, \Magento\Catalog\Model\ResourceModel\Product\Option\CollectionFactory $optionColFactory, \Magento\Catalog\Model\ResourceModel\Product\Attribute\CollectionFactory $attributeColFactory, \Magento\CatalogImportExport\Model\Export\Product\Type\Factory $_typeFactory, \Magento\Catalog\Model\Product\LinkTypeProvider $linkTypeProvider, \Magento\CatalogImportExport\Model\Export\RowCustomizerInterface $rowCustomizer, array $dateAttrCodes=[])
	_getHeaderColumns ()
	export ()
	filterAttributeCollection (\Magento\Eav\Model\ResourceModel\Entity\Attribute\Collection $collection)
	getAttributeCollection ()
	getEntityTypeCode ()
Public Member Functions inherited from AbstractEntity
	__construct (\Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate, \Magento\Eav\Model\Config $config, ResourceConnection $resource, \Magento\Store\Model\StoreManagerInterface $storeManager)
	addRowError ($errorCode, $errorRowNum)
	addMessageTemplate ($errorCode, $message)
	retrieveMessageTemplate ($errorCode)
	export ()
	filterAttributeCollection (\Magento\Eav\Model\ResourceModel\Entity\Attribute\Collection $collection)
	getAttributeCollection ()
	getAttributeOptions (\Magento\Eav\Model\Entity\Attribute\AbstractAttribute $attribute)
	getEntityTypeCode ()
	getEntityTypeId ()
	getErrorMessages ()
	getErrorsCount ()
	getInvalidRowsCount ()
	getProcessedEntitiesCount ()
	getProcessedRowsCount ()
	getWriter ()
	setParameters (array $parameters)
	setWriter (AbstractAdapter $writer)
	__destruct ()

Data Fields
const	VALUE_ALL = 'all'
const	COL_STORE = '_store'
const	COL_ATTR_SET = '_attribute_set'
const	COL_TYPE = '_type'
const	COL_PRODUCT_WEBSITES = '_product_websites'
const	COL_CATEGORY = '_category'
const	COL_ROOT_CATEGORY = '_root_category'
const	COL_SKU = 'sku'
const	COL_VISIBILITY = 'visibility'
const	COL_MEDIA_IMAGE = '_media_image'
const	COL_ADDITIONAL_ATTRIBUTES = 'additional_attributes'

Protected Member Functions
	initAttributeSets ()
	initCategories ()
	initTypeModels ()
	getMediaGallery (array $productIds)
	prepareCatalogInventory (array $productIds)
	prepareLinks (array $productIds)
	updateDataWithCategoryColumns (&$dataRow, &$rowCategories, $productId)
	setHeaderColumns ($customOptionsData, $stockItemRows)
	_getExportMainAttrCodes ()
	_getEntityCollection ($resetCollection=false)
	getItemsPerPage ()
	paginateCollection ($page, $pageSize)
	_prepareEntityCollection (\Magento\Eav\Model\Entity\Collection\AbstractCollection $collection)
	getExportData ()
	loadCollection ()
	hasMultiselectData ($item, $storeId)
	collectMultiselectValues ($item, $attrCode, $storeId)
	isValidAttributeValue ($code, $value)
	addMultirowData ($dataRow, $multiRawData)
	_customFieldsMapping ($rowData)
	_customHeadersMapping ($rowData)
	optionRowToCellString ($option)
	getCustomOptionsData ($productIds)
	initAttributes ()
	getProductEntityLinkField ()
Protected Member Functions inherited from AbstractEntity
	_initStores ()
	_getHeaderColumns ()
	_getEntityCollection ($resetCollection=false)
	_getExportAttrCodes ()
	_initAttrValues ()
	_prepareEntityCollection (\Magento\Eav\Model\Entity\Collection\AbstractCollection $collection)

Protected Attributes
	$_bannedAttributes = ['media_gallery']
	$_attrSetIdToName = []
	$_categories = []
	$_rootCategories = []
	$_indexValueAttributes
	$collectedMultiselectsData = []
	$_permanentAttributes = [self::COL_SKU]
	$_productTypeModels = []
	$_storeIdToCode = []
	$_websiteIdToCode = []
	$_attributeTypes = []
	$_entityCollectionFactory
	$_entityCollection
	$_itemsPerPage = null
	$_headerColumns = []
	$_exportConfig
	$_logger
	$_productFactory
	$_attrSetColFactory
	$_categoryColFactory
	$_resourceModel
	$_itemFactory
	$_optionColFactory
	$_attributeColFactory
	$_typeFactory
	$_linkTypeProvider
	$rowCustomizer
	$_fieldsMap
	$dateAttrCodes
	$_exportMainAttrCodes
	$metadataPool
Protected Attributes inherited from AbstractEntity
	$_attributeValues = []
	$_connection
	$_disabledAttrs = []
	$_entityTypeId
	$_errors = []
	$_errorsCount = 0
	$_errorsLimit = 100
	$_filter = []
	$_indexValueAttributes = []
	$_messageTemplates = []
	$_parameters = []
	$_specialAttributes = []
	$_permanentAttributes = []
	$_processedEntitiesCount = 0
	$_processedRowsCount = 0
	$_writer
	$_localeDate
	$_storeManager

Additional Inherited Members
Static Protected Attributes inherited from AbstractEntity
static	$attrCodes = null

Detailed Description

Export entity product model

@api

@SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since

100.0.2

Definition at line 25 of file Product.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$localeDate,
		\Magento\Eav\Model\Config	$config,
		\Magento\Framework\App\ResourceConnection	$resource,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Psr\Log\LoggerInterface	$logger,
		\Magento\Catalog\Model\ResourceModel\Product\CollectionFactory	$collectionFactory,
		\Magento\ImportExport\Model\Export\ConfigInterface	$exportConfig,
		\Magento\Catalog\Model\ResourceModel\ProductFactory	$productFactory,
		\Magento\Eav\Model\ResourceModel\Entity\Attribute\Set\CollectionFactory	$attrSetColFactory,
		\Magento\Catalog\Model\ResourceModel\Category\CollectionFactory	$categoryColFactory,
		\Magento\CatalogInventory\Model\ResourceModel\Stock\ItemFactory	$itemFactory,
		\Magento\Catalog\Model\ResourceModel\Product\Option\CollectionFactory	$optionColFactory,
		\Magento\Catalog\Model\ResourceModel\Product\Attribute\CollectionFactory	$attributeColFactory,
		\Magento\CatalogImportExport\Model\Export\Product\Type\Factory	$_typeFactory,
		\Magento\Catalog\Model\Product\LinkTypeProvider	$linkTypeProvider,
		\Magento\CatalogImportExport\Model\Export\RowCustomizerInterface	$rowCustomizer,
		array	$dateAttrCodes = []
	)

Parameters

\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$localeDate
\Magento\Eav\Model\Config	$config
\Magento\Framework\App\ResourceConnection	$resource
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Psr\Log\LoggerInterface	$logger
\Magento\Catalog\Model\ResourceModel\Product\Collection	$collection
\Magento\ImportExport\Model\Export\ConfigInterface	$exportConfig
\Magento\Catalog\Model\ResourceModel\ProductFactory	$productFactory
\Magento\Eav\Model\ResourceModel\Entity\Attribute\Set\CollectionFactory	$attrSetColFactory
\Magento\Catalog\Model\ResourceModel\Category\CollectionFactory	$categoryColFactory
\Magento\CatalogInventory\Model\ResourceModel\Stock\ItemFactory	$itemFactory
\Magento\Catalog\Model\ResourceModel\Product\Option\CollectionFactory	$optionColFactory
\Magento\Catalog\Model\ResourceModel\Product\Attribute\CollectionFactory	$attributeColFactory
Product\Type\Factory	$_typeFactory
\Magento\Catalog\Model\Product\LinkTypeProvider	$linkTypeProvider
\Magento\CatalogImportExport\Model\Export\RowCustomizerInterface	$rowCustomizer
array	$dateAttrCodes	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 371 of file Product.php.

      {
        $this->_entityCollectionFactory = $collectionFactory;
        $this->_exportConfig = $exportConfig;
        $this->_logger = $logger;
        $this->_productFactory = $productFactory;
        $this->_attrSetColFactory = $attrSetColFactory;
        $this->_categoryColFactory = $categoryColFactory;
        $this->_resourceModel = $resource;
        $this->_itemFactory = $itemFactory;
        $this->_optionColFactory = $optionColFactory;
        $this->_attributeColFactory = $attributeColFactory;
        $this->_typeFactory = $_typeFactory;
        $this->_linkTypeProvider = $linkTypeProvider;
        $this->rowCustomizer = $rowCustomizer;
        $this->dateAttrCodes = array_merge($this->dateAttrCodes, $dateAttrCodes);

        parent::__construct($localeDate, $config, $resource, $storeManager);

        $this->initTypeModels()
            ->initAttributes()
            ->_initStores()
            ->initAttributeSets()
            ->initWebsites()
            ->initCategories();
    }

Member Function Documentation

_customFieldsMapping()

_customFieldsMapping (   $rowData )

protected

Custom fields mapping for changed purposes of fields and field names

Parameters

array

$rowData

Returns

array

Definition at line 1310 of file Product.php.

    {
        foreach ($this->_fieldsMap as $systemFieldName => $fileFieldName) {
            if (isset($rowData[$systemFieldName])) {
                $rowData[$fileFieldName] = $rowData[$systemFieldName];
                unset($rowData[$systemFieldName]);
            }
        }
        return $rowData;
    }

_customHeadersMapping()

_customHeadersMapping (   $rowData )

protected

Custom headers mapping for changed field names

Parameters

array

$rowData

Returns

array

Definition at line 1328 of file Product.php.

    {
        foreach ($rowData as $key => $fieldName) {
            if (isset($this->_fieldsMap[$fieldName])) {
                $rowData[$key] = $this->_fieldsMap[$fieldName];
            }
        }
        return $rowData;
    }

_getEntityCollection()

_getEntityCollection (   $resetCollection = false )

protected

{}

Definition at line 756 of file Product.php.

    {
        if ($resetCollection || empty($this->_entityCollection)) {
            $this->_entityCollection = $this->_entityCollectionFactory->create();
        }
        return $this->_entityCollection;
    }

_getExportMainAttrCodes()

_getExportMainAttrCodes ( )

protected

Get attributes codes which are appropriate for export and not the part of additional_attributes.

Returns

array

Definition at line 748 of file Product.php.

    {
        return $this->_exportMainAttrCodes;
    }

_getHeaderColumns()

_getHeaderColumns

(

)

{}

Definition at line 697 of file Product.php.

    {
        return $this->_customHeadersMapping($this->rowCustomizer->addHeaderColumns($this->_headerColumns));
    }

_prepareEntityCollection()

_prepareEntityCollection ( \Magento\Eav\Model\Entity\Collection\AbstractCollection  $collection )

protected

{}

Since

100.2.0

Definition at line 864 of file Product.php.

    {
        $exportFilter = !empty($this->_parameters[\Magento\ImportExport\Model\Export::FILTER_ELEMENT_GROUP]) ?
            $this->_parameters[\Magento\ImportExport\Model\Export::FILTER_ELEMENT_GROUP] : [];

        if (isset($exportFilter['category_ids'])
            && trim($exportFilter['category_ids'])
            && $collection instanceof \Magento\Catalog\Model\ResourceModel\Product\Collection
        ) {
            $collection->addCategoriesFilter(['in' => explode(',', $exportFilter['category_ids'])]);
        }

        return parent::_prepareEntityCollection($collection);
    }

addMultirowData()

addMultirowData (   $dataRow,   $multiRawData  )

protected

Deprecated:

100.1.0

Parameters

array	$dataRow
array	$multiRawData

Returns

array

Definition at line 1297 of file Product.php.

    {
        $data = $this->appendMultirowData($dataRow, $multiRawData);
        return $data ? [$data] : [];
    }

collectMultiselectValues()

collectMultiselectValues (   $item,   $attrCode,   $storeId  )

protected

Parameters

\Magento\Catalog\Model\Product	$item
string	$attrCode
int	$storeId

Returns

$this

Definition at line 1125 of file Product.php.

    {
        $attrValue = $item->getData($attrCode);
        $optionIds = explode(Import::DEFAULT_GLOBAL_MULTI_VALUE_SEPARATOR, $attrValue);
        $options = array_intersect_key(
            $this->_attributeValues[$attrCode],
            array_flip($optionIds)
        );
        $linkId = $item->getData($this->getProductEntityLinkField());
        if (!(isset($this->collectedMultiselectsData[Store::DEFAULT_STORE_ID][$linkId][$attrCode])
            && $this->collectedMultiselectsData[Store::DEFAULT_STORE_ID][$linkId][$attrCode] == $options)
        ) {
            $this->collectedMultiselectsData[$storeId][$linkId][$attrCode] = $options;
        }

        return $this;
    }

export()

export

(

)

Export process

Returns

string

Definition at line 829 of file Product.php.

    {
        //Execution time may be very long
        set_time_limit(0);

        $writer = $this->getWriter();
        $page = 0;
        while (true) {
            ++$page;
            $entityCollection = $this->_getEntityCollection(true);
            $entityCollection->setOrder('entity_id', 'asc');
            $entityCollection->setStoreId(Store::DEFAULT_STORE_ID);
            $this->_prepareEntityCollection($entityCollection);
            $this->paginateCollection($page, $this->getItemsPerPage());
            if ($entityCollection->count() == 0) {
                break;
            }
            $exportData = $this->getExportData();
            if ($page == 1) {
                $writer->setHeaderCols($this->_getHeaderColumns());
            }
            foreach ($exportData as $dataRow) {
                $writer->writeRow($this->_customFieldsMapping($dataRow));
            }
            if ($entityCollection->getCurPage() >= $entityCollection->getLastPageNumber()) {
                break;
            }
        }
        return $writer->getContents();
    }

filterAttributeCollection()

filterAttributeCollection

(

\Magento\Eav\Model\ResourceModel\Entity\Attribute\Collection

$collection

)

Clean up already loaded attribute collection.

Parameters

\Magento\Eav\Model\ResourceModel\Entity\Attribute\Collection

$collection

Returns

\Magento\Eav\Model\ResourceModel\Entity\Attribute\Collection

Definition at line 1431 of file Product.php.

    {
        $validTypes = array_keys($this->_productTypeModels);
        $validTypes = array_combine($validTypes, $validTypes);

        foreach (parent::filterAttributeCollection($collection) as $attribute) {
            if (in_array($attribute->getAttributeCode(), $this->_bannedAttributes)) {
                $collection->removeItemByKey($attribute->getId());
                continue;
            }
            $attrApplyTo = $attribute->getApplyTo();
            $attrApplyTo = array_combine($attrApplyTo, $attrApplyTo);
            $attrApplyTo = $attrApplyTo ? array_intersect_key($attrApplyTo, $validTypes) : $validTypes;

            if ($attrApplyTo) {
                foreach ($attrApplyTo as $productType) {
                    // override attributes by its product type model
                    if ($this->_productTypeModels[$productType]->overrideAttribute($attribute)) {
                        break;
                    }
                }
            } else {
                // remove attributes of not-supported product types
                $collection->removeItemByKey($attribute->getId());
            }
        }
        return $collection;
    }

getAttributeCollection()

getAttributeCollection

(

)

Entity attributes collection getter.

Returns

\Magento\Catalog\Model\ResourceModel\Product\Attribute\Collection

Definition at line 1465 of file Product.php.

    {
        return $this->_attributeColFactory->create();
    }

getCustomOptionsData()

getCustomOptionsData (   $productIds )

protected

Collect custom options data for products that will be exported.

Option name and type will be collected for all store views, all other data (which can't be changed on store view level will be collected for DEFAULT_STORE_ID only. Store view specified data will be saved to the additional store view row.

Parameters

int[]

$productIds

Returns

array @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 1365 of file Product.php.

    {
        $customOptionsData = [];

        foreach (array_keys($this->_storeIdToCode) as $storeId) {
            $options = $this->_optionColFactory->create();
            /* @var Collection $options*/
            $options->reset()
                ->addOrder('sort_order', Collection::SORT_ORDER_ASC)
                ->addTitleToResult($storeId)
                ->addPriceToResult($storeId)
                ->addProductToFilter($productIds)
                ->addValuesToResult($storeId);

            foreach ($options as $option) {
                $row = [];
                $productId = $option['product_id'];
                $row['name'] = $option['title'];
                $row['type'] = $option['type'];
                if (Store::DEFAULT_STORE_ID === $storeId) {
                    $row['required'] = $option['is_require'];
                    $row['price'] = $option['price'];
                    $row['price_type'] = ($option['price_type'] === 'percent') ? 'percent' : 'fixed';
                    $row['sku'] = $option['sku'];
                    if ($option['max_characters']) {
                        $row['max_characters'] = $option['max_characters'];
                    }

                    foreach (['file_extension', 'image_size_x', 'image_size_y'] as $fileOptionKey) {
                        if (!isset($option[$fileOptionKey])) {
                            continue;
                        }

                        $row[$fileOptionKey] = $option[$fileOptionKey];
                    }
                }
                $values = $option->getValues();

                if ($values) {
                    foreach ($values as $value) {
                        $row['option_title'] = $value['title'];
                        if (Store::DEFAULT_STORE_ID === $storeId) {
                            $row['option_title'] = $value['title'];
                            $row['price'] = $value['price'];
                            $row['price_type'] = ($value['price_type'] === 'percent') ? 'percent' : 'fixed';
                            $row['sku'] = $value['sku'];
                        }
                        $customOptionsData[$productId][$storeId][] = $this->optionRowToCellString($row);
                    }
                } else {
                    $customOptionsData[$productId][$storeId][] = $this->optionRowToCellString($row);
                }
                $option = null;
            }
            $options = null;
        }

        return $customOptionsData;
    }

getEntityTypeCode()

getEntityTypeCode

(

)

EAV entity type code getter.

Returns

string

Definition at line 1475 of file Product.php.

    {
        return 'catalog_product';
    }

getExportData()

getExportData ( )

protected

Get export data for collection

Returns

array @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity) @SuppressWarnings(PHPMD.ExcessiveMethodLength) @SuppressWarnings(PHPMD.UnusedLocalVariable)

Definition at line 888 of file Product.php.

    {
        $exportData = [];
        try {
            $rawData = $this->collectRawData();
            $multirawData = $this->collectMultirawData();

            $productIds = array_keys($rawData);
            $stockItemRows = $this->prepareCatalogInventory($productIds);

            $this->rowCustomizer->prepareData(
                $this->_prepareEntityCollection($this->_entityCollectionFactory->create()),
                $productIds
            );

            $this->setHeaderColumns($multirawData['customOptionsData'], $stockItemRows);

            foreach ($rawData as $productId => $productData) {
                foreach ($productData as $storeId => $dataRow) {
                    if ($storeId == Store::DEFAULT_STORE_ID && isset($stockItemRows[$productId])) {
                        $dataRow = array_merge($dataRow, $stockItemRows[$productId]);
                    }
                    $this->appendMultirowData($dataRow, $multirawData);
                    if ($dataRow) {
                        $exportData[] = $dataRow;
                    }
                }
            }
        } catch (\Exception $e) {
            $this->_logger->critical($e);
        }
        return $exportData;
    }

getItemsPerPage()

getItemsPerPage ( )

protected

Get items per page

Returns

int

Definition at line 769 of file Product.php.

    {
        if ($this->_itemsPerPage === null) {
            $memoryLimitConfigValue = trim(ini_get('memory_limit'));
            $lastMemoryLimitLetter = strtolower($memoryLimitConfigValue[strlen($memoryLimitConfigValue) - 1]);
            $memoryLimit = (int) $memoryLimitConfigValue;
            switch ($lastMemoryLimitLetter) {
                case 'g':
                    $memoryLimit *= 1024;
                    // fall-through intentional
                case 'm':
                    $memoryLimit *= 1024;
                    // fall-through intentional
                case 'k':
                    $memoryLimit *= 1024;
                    break;
                default:
                    // minimum memory required by Magento
                    $memoryLimit = 250000000;
            }

            // Tested one product to have up to such size
            $memoryPerProduct = 500000;
            // Decrease memory limit to have supply
            $memoryUsagePercent = 0.8;
            // Minimum Products limit
            $minProductsLimit = 500;
            // Maximal Products limit
            $maxProductsLimit = 5000;

            $this->_itemsPerPage = intval(
                ($memoryLimit * $memoryUsagePercent - memory_get_usage(true)) / $memoryPerProduct
            );
            if ($this->_itemsPerPage < $minProductsLimit) {
                $this->_itemsPerPage = $minProductsLimit;
            }
            if ($this->_itemsPerPage > $maxProductsLimit) {
                $this->_itemsPerPage = $maxProductsLimit;
            }
        }
        return $this->_itemsPerPage;
    }

getMediaGallery()

getMediaGallery ( array  $productIds )

protected

Prepare products media gallery

Parameters

int[]

$productIds

Returns

array

Definition at line 518 of file Product.php.

    {
        if (empty($productIds)) {
            return [];
        }
        $select = $this->_connection->select()->from(
            ['mgvte' => $this->_resourceModel->getTableName('catalog_product_entity_media_gallery_value_to_entity')],
            [
                "mgvte.{$this->getProductEntityLinkField()}",
                'mgvte.value_id'
            ]
        )->joinLeft(
            ['mg' => $this->_resourceModel->getTableName('catalog_product_entity_media_gallery')],
            '(mg.value_id = mgvte.value_id)',
            [
                'mg.attribute_id',
                'filename' => 'mg.value',
            ]
        )->joinLeft(
            ['mgv' => $this->_resourceModel->getTableName('catalog_product_entity_media_gallery_value')],
            '(mg.value_id = mgv.value_id)',
            [
                'mgv.label',
                'mgv.position',
                'mgv.disabled',
                'mgv.store_id',
            ]
        )->where(
            "mgvte.{$this->getProductEntityLinkField()} IN (?)",
            $productIds
        );

        $rowMediaGallery = [];
        $stmt = $this->_connection->query($select);
        while ($mediaRow = $stmt->fetch()) {
            $rowMediaGallery[$mediaRow[$this->getProductEntityLinkField()]][] = [
                '_media_attribute_id' => $mediaRow['attribute_id'],
                '_media_image' => $mediaRow['filename'],
                '_media_label' => $mediaRow['label'],
                '_media_position' => $mediaRow['position'],
                '_media_is_disabled' => $mediaRow['disabled'],
                '_media_store_id' => $mediaRow['store_id'],
            ];
        }

        return $rowMediaGallery;
    }

getProductEntityLinkField()

getProductEntityLinkField ( )

protected

Get product entity link field

Returns

string

Since

100.1.0

Definition at line 1518 of file Product.php.

    {
        if (!$this->productEntityLinkField) {
            $this->productEntityLinkField = $this->getMetadataPool()
                ->getMetadata(\Magento\Catalog\Api\Data\ProductInterface::class)
                ->getLinkField();
        }
        return $this->productEntityLinkField;
    }

hasMultiselectData()

hasMultiselectData (   $item,   $storeId  )

protected

Parameters

\Magento\Catalog\Model\Product	$item
int	$storeId

Returns

bool

Deprecated:

100.2.3

Definition at line 1113 of file Product.php.

    {
        $linkId = $item->getData($this->getProductEntityLinkField());
        return !empty($this->collectedMultiselectsData[$storeId][$linkId]);
    }

initAttributes()

initAttributes ( )

protected

Initialize attribute option values and types.

Returns

$this

Definition at line 1485 of file Product.php.

    {
        foreach ($this->getAttributeCollection() as $attribute) {
            $this->_attributeValues[$attribute->getAttributeCode()] = $this->getAttributeOptions($attribute);
            $this->_attributeTypes[$attribute->getAttributeCode()] =
                \Magento\ImportExport\Model\Import::getAttributeType($attribute);
            if ($attribute->getIsUserDefined()) {
                $this->userDefinedAttributes[] = $attribute->getAttributeCode();
            }
        }
        return $this;
    }

initAttributeSets()

initAttributeSets ( )

protected

Initialize attribute sets code-to-id pairs.

Returns

$this

Definition at line 420 of file Product.php.

    {
        $productTypeId = $this->_productFactory->create()->getTypeId();
        foreach ($this->_attrSetColFactory->create()->setEntityTypeFilter($productTypeId) as $attributeSet) {
            $this->_attrSetIdToName[$attributeSet->getId()] = $attributeSet->getAttributeSetName();
        }
        return $this;
    }

initCategories()

initCategories ( )

protected

Initialize categories ID to text-path hash.

Returns

$this

Definition at line 434 of file Product.php.

    {
        $collection = $this->_categoryColFactory->create()->addNameToResult();
        /* @var $collection \Magento\Catalog\Model\ResourceModel\Category\Collection */
        foreach ($collection as $category) {
            $structure = preg_split('#/+#', $category->getPath());
            $pathSize = count($structure);
            if ($pathSize > 1) {
                $path = [];
                for ($i = 1; $i < $pathSize; $i++) {
                    $name = $collection->getItemById($structure[$i])->getName();
                    $path[] = $this->quoteCategoryDelimiter($name);
                }
                $this->_rootCategories[$category->getId()] = array_shift($path);
                if ($pathSize > 2) {
                    $this->_categories[$category->getId()] = implode(CategoryProcessor::DELIMITER_CATEGORY, $path);
                }
            }
        }
        return $this;
    }

initTypeModels()

initTypeModels ( )

protected

Initialize product type models.

Exceptions

Definition at line 462 of file Product.php.

    {
        $productTypes = $this->_exportConfig->getEntityTypes($this->getEntityTypeCode());
        foreach ($productTypes as $productTypeName => $productTypeConfig) {
            if (!($model = $this->_typeFactory->create($productTypeConfig['model']))) {
                throw new \Magento\Framework\Exception\LocalizedException(
                    __('Entity type model \'%1\' is not found', $productTypeConfig['model'])
                );
            }
            if (!$model instanceof \Magento\CatalogImportExport\Model\Export\Product\Type\AbstractType) {
                throw new \Magento\Framework\Exception\LocalizedException(
                    __(
                        'Entity type model must be an instance of'
                        . ' \Magento\CatalogImportExport\Model\Export\Product\Type\AbstractType'
                    )
                );
            }
            if ($model->isSuitable()) {
                $this->_productTypeModels[$productTypeName] = $model;
                $this->_disabledAttrs = array_merge($this->_disabledAttrs, $model->getDisabledAttrs());
                $this->_indexValueAttributes = array_merge(
                    $this->_indexValueAttributes,
                    $model->getIndexValueAttributes()
                );
            }
        }
        if (!$this->_productTypeModels) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('There are no product types available for export.')
            );
        }
        $this->_disabledAttrs = array_unique($this->_disabledAttrs);

        return $this;
    }

isValidAttributeValue()

isValidAttributeValue (   $code,   $value  )

protected

Parameters

string	$code
mixed	$value

Returns

bool

Definition at line 1148 of file Product.php.

    {
        $isValid = true;
        if (!is_numeric($value) && empty($value)) {
            $isValid = false;
        }

        if (!isset($this->_attributeValues[$code])) {
            $isValid = false;
        }

        return $isValid;
    }

loadCollection()

loadCollection ( )

protected

Load products' data from the collection and filter it (if needed).

Returns

array Keys are product IDs, values arrays with keys as store IDs and values as store-specific versions of Product entity.

Since

100.2.1

Definition at line 930 of file Product.php.

                                       : array
    {
        $data = [];

        $collection = $this->_getEntityCollection();
        foreach (array_keys($this->_storeIdToCode) as $storeId) {
            $collection->setStoreId($storeId);
            foreach ($collection as $itemId => $item) {
                $data[$itemId][$storeId] = $item;
            }
        }
        $collection->clear();

        return $data;
    }

optionRowToCellString()

optionRowToCellString (   $option )

protected

Parameters

array

$option

Returns

string

Definition at line 1342 of file Product.php.

    {
        $result = [];

        foreach ($option as $key => $value) {
            $result[] = $key . ImportProduct::PAIR_NAME_VALUE_SEPARATOR . $value;
        }

        return implode(Import::DEFAULT_GLOBAL_MULTI_VALUE_SEPARATOR, $result);
    }

paginateCollection()

paginateCollection (   $page,   $pageSize  )

protected

Set page and page size to collection

Parameters

int	$page
int	$pageSize

Returns

void

Definition at line 819 of file Product.php.

    {
        $this->_getEntityCollection()->setPage($page, $pageSize);
    }

prepareCatalogInventory()

prepareCatalogInventory ( array  $productIds )

protected

Prepare catalog inventory

Parameters

int[]

$productIds

Returns

array

Definition at line 572 of file Product.php.

    {
        if (empty($productIds)) {
            return [];
        }
        $select = $this->_connection->select()->from(
            $this->_itemFactory->create()->getMainTable()
        )->where(
            'product_id IN (?)',
            $productIds
        );

        $stmt = $this->_connection->query($select);
        $stockItemRows = [];
        while ($stockItemRow = $stmt->fetch()) {
            $productId = $stockItemRow['product_id'];
            unset(
                $stockItemRow['item_id'],
                $stockItemRow['product_id'],
                $stockItemRow['low_stock_date'],
                $stockItemRow['stock_id'],
                $stockItemRow['stock_status_changed_auto']
            );
            $stockItemRows[$productId] = $stockItemRow;
        }
        return $stockItemRows;
    }

prepareLinks()

prepareLinks ( array  $productIds )

protected

Prepare product links

Parameters

int[]

$productIds

Returns

array

Definition at line 606 of file Product.php.

    {
        if (empty($productIds)) {
            return [];
        }
        $select = $this->_connection->select()->from(
            ['cpl' => $this->_resourceModel->getTableName('catalog_product_link')],
            [
                'cpl.product_id',
                'cpe.sku',
                'cpl.link_type_id',
                'position' => 'cplai.value',
                'default_qty' => 'cplad.value'
            ]
        )->joinLeft(
            ['cpe' => $this->_resourceModel->getTableName('catalog_product_entity')],
            '(cpe.entity_id = cpl.linked_product_id)',
            []
        )->joinLeft(
            ['cpla' => $this->_resourceModel->getTableName('catalog_product_link_attribute')],
            $this->_connection->quoteInto(
                '(cpla.link_type_id = cpl.link_type_id AND cpla.product_link_attribute_code = ?)',
                'position'
            ),
            []
        )->joinLeft(
            ['cplaq' => $this->_resourceModel->getTableName('catalog_product_link_attribute')],
            $this->_connection->quoteInto(
                '(cplaq.link_type_id = cpl.link_type_id AND cplaq.product_link_attribute_code = ?)',
                'qty'
            ),
            []
        )->joinLeft(
            ['cplai' => $this->_resourceModel->getTableName('catalog_product_link_attribute_int')],
            '(cplai.link_id = cpl.link_id AND cplai.product_link_attribute_id = cpla.product_link_attribute_id)',
            []
        )->joinLeft(
            ['cplad' => $this->_resourceModel->getTableName('catalog_product_link_attribute_decimal')],
            '(cplad.link_id = cpl.link_id AND cplad.product_link_attribute_id = cplaq.product_link_attribute_id)',
            []
        )->where(
            'cpl.link_type_id IN (?)',
            array_values($this->_linkTypeProvider->getLinkTypes())
        )->where(
            'cpl.product_id IN (?)',
            $productIds
        );

        $stmt = $this->_connection->query($select);
        $linksRows = [];
        while ($linksRow = $stmt->fetch()) {
            $linksRows[$linksRow['product_id']][$linksRow['link_type_id']][] = [
                'sku' => $linksRow['sku'],
                'position' => $linksRow['position'],
                'default_qty' => $linksRow['default_qty'],
            ];
        }

        return $linksRows;
    }

setHeaderColumns()

setHeaderColumns (   $customOptionsData,   $stockItemRows  )

protected

Set headers columns

Parameters

array	$customOptionsData
array	$stockItemRows

Returns

void

Deprecated:

100.2.0 Logic will be moved to _getHeaderColumns in future release

@SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 712 of file Product.php.

    {
        if (!$this->_headerColumns) {
            $this->_headerColumns = array_merge(
                [
                    self::COL_SKU,
                    self::COL_STORE,
                    self::COL_ATTR_SET,
                    self::COL_TYPE,
                    self::COL_CATEGORY,
                    self::COL_PRODUCT_WEBSITES,
                ],
                $this->_getExportMainAttrCodes(),
                [self::COL_ADDITIONAL_ATTRIBUTES],
                reset($stockItemRows) ? array_keys(end($stockItemRows)) : [],
                [
                    'related_skus',
                    'related_position',
                    'crosssell_skus',
                    'crosssell_position',
                    'upsell_skus',
                    'upsell_position',
                    'additional_images',
                    'additional_image_labels',
                    'hide_from_product_page',
                    'custom_options'
                ]
            );
        }
    }

updateDataWithCategoryColumns()

updateDataWithCategoryColumns ( &  $dataRow, &  $rowCategories,   $productId  )

protected

Update data row with information about categories. Return true, if data row was updated

Parameters

array	&$dataRow
array	&$rowCategories
int	$productId

Returns

bool

Definition at line 675 of file Product.php.

    {
        if (!isset($rowCategories[$productId])) {
            return false;
        }
        $categories = [];
        foreach ($rowCategories[$productId] as $categoryId) {
            $categoryPath = $this->_rootCategories[$categoryId];
            if (isset($this->_categories[$categoryId])) {
                $categoryPath .= '/' . $this->_categories[$categoryId];
            }
            $categories[] = $categoryPath;
        }
        $dataRow[self::COL_CATEGORY] = implode(Import::DEFAULT_GLOBAL_MULTI_VALUE_SEPARATOR, $categories);
        unset($rowCategories[$productId]);

        return true;
    }

Field Documentation

$_attributeColFactory

$_attributeColFactory

protected

Definition at line 214 of file Product.php.

$_attributeTypes

$_attributeTypes = []

protected

Definition at line 133 of file Product.php.

$_attrSetColFactory

$_attrSetColFactory

protected

Definition at line 189 of file Product.php.

$_attrSetIdToName

$_attrSetIdToName = []

protected

Definition at line 70 of file Product.php.

$_bannedAttributes

$_bannedAttributes = ['media_gallery']

protected

Definition at line 32 of file Product.php.

$_categories

$_categories = []

protected

Definition at line 77 of file Product.php.

$_categoryColFactory

$_categoryColFactory

protected

Definition at line 194 of file Product.php.

$_entityCollection

$_entityCollection

protected

Definition at line 154 of file Product.php.

$_entityCollectionFactory

$_entityCollectionFactory

protected

Definition at line 147 of file Product.php.

$_exportConfig

$_exportConfig

protected

Definition at line 174 of file Product.php.

$_exportMainAttrCodes

$_exportMainAttrCodes

protected

Definition at line 288 of file Product.php.

$_fieldsMap

$_fieldsMap

protected

Initial value:

= [
        'image' => 'base_image',
        'image_label' => "base_image_label",
        'thumbnail' => 'thumbnail_image',
        'thumbnail_label' => 'thumbnail_image_label',
        self::COL_MEDIA_IMAGE => 'additional_images',
        '_media_image_label' => 'additional_image_labels',
        self::COL_STORE => 'store_view_code',
        self::COL_ATTR_SET => 'attribute_set_code',
        self::COL_TYPE => 'product_type',
        self::COL_CATEGORY => 'categories',
        self::COL_PRODUCT_WEBSITES => 'product_websites',
        'status' => 'product_online',
        'news_from_date' => 'new_from_date',
        'news_to_date' => 'new_to_date',
        'options_container' => 'display_product_options_in',
        'minimal_price' => 'map_price',
        'msrp' => 'msrp_price',
        'msrp_enabled' => 'map_enabled',
        'special_from_date' => 'special_price_from_date',
        'special_to_date' => 'special_price_to_date',
        'min_qty' => 'out_of_stock_qty',
        'backorders' => 'allow_backorders',
        'min_sale_qty' => 'min_cart_qty',
        'max_sale_qty' => 'max_cart_qty',
        'notify_stock_qty' => 'notify_on_stock_below',
        'meta_keyword' => 'meta_keywords',
        'tax_class_id' => 'tax_class_name',
    ]

Definition at line 238 of file Product.php.

$_headerColumns

$_headerColumns = []

protected

Definition at line 169 of file Product.php.

$_indexValueAttributes

$_indexValueAttributes

protected

Initial value:

= [
        'status',
    ]

Definition at line 91 of file Product.php.

$_itemFactory

$_itemFactory

protected

Definition at line 204 of file Product.php.

$_itemsPerPage

$_itemsPerPage = null

protected

Definition at line 161 of file Product.php.

$_linkTypeProvider

$_linkTypeProvider

protected

Definition at line 226 of file Product.php.

$_logger

$_logger

protected

Definition at line 179 of file Product.php.

$_optionColFactory

$_optionColFactory

protected

Definition at line 209 of file Product.php.

$_permanentAttributes

$_permanentAttributes = [self::COL_SKU]

protected

Definition at line 105 of file Product.php.

$_productFactory

$_productFactory

protected

Definition at line 184 of file Product.php.

$_productTypeModels

$_productTypeModels = []

protected

Definition at line 112 of file Product.php.

$_resourceModel

$_resourceModel

protected

Definition at line 199 of file Product.php.

$_rootCategories

$_rootCategories = []

protected

Definition at line 84 of file Product.php.

$_storeIdToCode

$_storeIdToCode = []

protected

Definition at line 119 of file Product.php.

$_typeFactory

$_typeFactory

protected

Definition at line 219 of file Product.php.

$_websiteIdToCode

$_websiteIdToCode = []

protected

Definition at line 126 of file Product.php.

$collectedMultiselectsData

$collectedMultiselectsData = []

protected

Definition at line 98 of file Product.php.

$dateAttrCodes

$dateAttrCodes

protected

Initial value:

= [
        'special_from_date',
        'special_to_date',
        'news_from_date',
        'news_to_date',
        'custom_design_from',
        'custom_design_to'
    ]

Definition at line 274 of file Product.php.

$metadataPool

$metadataPool

protected

Definition at line 342 of file Product.php.

$rowCustomizer

$rowCustomizer

protected

Definition at line 231 of file Product.php.

COL_ADDITIONAL_ATTRIBUTES

const COL_ADDITIONAL_ATTRIBUTES = 'additional_attributes'

Definition at line 63 of file Product.php.

COL_ATTR_SET

const COL_ATTR_SET = '_attribute_set'

Definition at line 47 of file Product.php.

COL_CATEGORY

const COL_CATEGORY = '_category'

Definition at line 53 of file Product.php.

COL_MEDIA_IMAGE

const COL_MEDIA_IMAGE = '_media_image'

Definition at line 61 of file Product.php.

COL_PRODUCT_WEBSITES

const COL_PRODUCT_WEBSITES = '_product_websites'

Definition at line 51 of file Product.php.

COL_ROOT_CATEGORY

const COL_ROOT_CATEGORY = '_root_category'

Definition at line 55 of file Product.php.

COL_SKU

const COL_SKU = 'sku'

Definition at line 57 of file Product.php.

COL_STORE

const COL_STORE = '_store'

Permanent column names.

Names that begins with underscore is not an attribute. This name convention is for to avoid interference with same attribute name.

Definition at line 45 of file Product.php.

COL_TYPE

const COL_TYPE = '_type'

Definition at line 49 of file Product.php.

COL_VISIBILITY

const COL_VISIBILITY = 'visibility'

Definition at line 59 of file Product.php.

VALUE_ALL

const VALUE_ALL = 'all'

Value that means all entities (e.g. websites, groups etc.)

Definition at line 37 of file Product.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-catalog-import-export/Model/Export/Product.php