Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/module-customer-import-export/Model/Import/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\CustomerImportExport\Model\Import;
use Magento\Framework\Validator\EmailAddress;
use Magento\Framework\Validator\ValidateException;
use Magento\Framework\Validator\ValidatorChain;
use Magento\ImportExport\Model\Import;
use Magento\CustomerImportExport\Model\ResourceModel\Import\Customer\Storage;
use Magento\ImportExport\Model\Import\ErrorProcessing\ProcessingErrorAggregatorInterface;
/**
* Import entity abstract customer model
*
* phpcs:disable Magento2.Classes.AbstractApi
* @api
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @since 100.0.2
*/
abstract class AbstractCustomer extends \Magento\ImportExport\Model\Import\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.
*/
public const COLUMN_WEBSITE = '_website';
public const COLUMN_EMAIL = '_email';
public const COLUMN_DEFAULT_BILLING = 'default_billing';
public const COLUMN_DEFAULT_SHIPPING = 'default_shipping';
/**#@-*/
/**#@+
* Error codes
*/
public const ERROR_WEBSITE_IS_EMPTY = 'websiteIsEmpty';
public const ERROR_EMAIL_IS_EMPTY = 'emailIsEmpty';
public const ERROR_INVALID_WEBSITE = 'invalidWebsite';
public const ERROR_INVALID_EMAIL = 'invalidEmail';
public const ERROR_VALUE_IS_REQUIRED = 'valueIsRequired';
public const ERROR_CUSTOMER_NOT_FOUND = 'customerNotFound';
/**#@-*/
/**
* @var string[]
*/
protected $_ignoredAttributes = ['website_id', 'store_id',
self::COLUMN_DEFAULT_BILLING, self::COLUMN_DEFAULT_SHIPPING];
/**
* Customer collection wrapper
*
* @var Storage
*/
protected $_customerStorage;
/**
* @var \Magento\CustomerImportExport\Model\ResourceModel\Import\Customer\StorageFactory
*/
protected $_storageFactory;
/**
* If we should check column names
*
* @var bool
*/
protected $needColumnCheck = true;
/**
* @var string
*/
protected $masterAttributeCode = '_email';
/**
* @param \Magento\Framework\Stdlib\StringUtils $string
* @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
* @param \Magento\ImportExport\Model\ImportFactory $importFactory
* @param \Magento\ImportExport\Model\ResourceModel\Helper $resourceHelper
* @param \Magento\Framework\App\ResourceConnection $resource
* @param ProcessingErrorAggregatorInterface $errorAggregator
* @param \Magento\Store\Model\StoreManagerInterface $storeManager
* @param \Magento\ImportExport\Model\Export\Factory $collectionFactory
* @param \Magento\Eav\Model\Config $eavConfig
* @param \Magento\CustomerImportExport\Model\ResourceModel\Import\Customer\StorageFactory $storageFactory
* @param array $data
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
*/
public function __construct(
\Magento\Framework\Stdlib\StringUtils $string,
\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
\Magento\ImportExport\Model\ImportFactory $importFactory,
\Magento\ImportExport\Model\ResourceModel\Helper $resourceHelper,
\Magento\Framework\App\ResourceConnection $resource,
ProcessingErrorAggregatorInterface $errorAggregator,
\Magento\Store\Model\StoreManagerInterface $storeManager,
\Magento\ImportExport\Model\Export\Factory $collectionFactory,
\Magento\Eav\Model\Config $eavConfig,
\Magento\CustomerImportExport\Model\ResourceModel\Import\Customer\StorageFactory $storageFactory,
array $data = []
) {
$this->_storageFactory = $storageFactory;
parent::__construct(
$string,
$scopeConfig,
$importFactory,
$resourceHelper,
$resource,
$errorAggregator,
$storeManager,
$collectionFactory,
$eavConfig,
$data
);
$this->addMessageTemplate(self::ERROR_WEBSITE_IS_EMPTY, __('Please specify a website.'));
$this->addMessageTemplate(
self::ERROR_EMAIL_IS_EMPTY,
__("An email wasn't specified. Enter the email and try again.")
);
$this->addMessageTemplate(self::ERROR_INVALID_WEBSITE, __('We found an invalid value in a website column.'));
$this->addMessageTemplate(self::ERROR_INVALID_EMAIL, __('Please enter a valid email.'));
$this->addMessageTemplate(self::ERROR_VALUE_IS_REQUIRED, __('Please make sure attribute "%s" is not empty.'));
$this->addMessageTemplate(
self::ERROR_CUSTOMER_NOT_FOUND,
__('We can\'t find a customer who matches this email and website code.')
);
$this->_initCustomers($data)->_initWebsites(true);
}
/**
* Initialize existent customers data
*
* @param array $data
* @return $this
*/
protected function _initCustomers(array $data)
{
if (!isset($data['page_size'])) {
$data['page_size'] = $this->_pageSize;
}
$this->_customerStorage = isset(
$data['customer_storage']
) ? $data['customer_storage'] : $this->_storageFactory->create(
['data' => $data]
);
return $this;
}
/**
* Get customer id if customer is present in database
*
* @param string $email
* @param string $websiteCode
* @return bool|int
*/
protected function _getCustomerId($email, $websiteCode)
{
$email = strtolower(trim($email));
if (isset($this->_websiteCodeToId[$websiteCode])) {
$websiteId = $this->_websiteCodeToId[$websiteCode];
return $this->_customerStorage->getCustomerId($email, $websiteId);
}
return false;
}
/**
* Validate data row
*
* @param array $rowData
* @param int $rowNumber
* @return bool
*/
public function validateRow(array $rowData, $rowNumber)
{
if (isset($this->_validatedRows[$rowNumber])) {
// check that row is already validated
return !$this->getErrorAggregator()->isRowInvalid($rowNumber);
}
$this->_validatedRows[$rowNumber] = true;
$this->_processedEntitiesCount++;
if ($this->getBehavior($rowData) == \Magento\ImportExport\Model\Import::BEHAVIOR_ADD_UPDATE) {
$this->_validateRowForUpdate($rowData, $rowNumber);
} elseif ($this->getBehavior($rowData) == \Magento\ImportExport\Model\Import::BEHAVIOR_DELETE) {
$this->_validateRowForDelete($rowData, $rowNumber);
}
return !$this->getErrorAggregator()->isRowInvalid($rowNumber);
}
/**
* Validate data row for add/update behaviour
*
* @param array $rowData
* @param int $rowNumber
* @return null
*/
abstract protected function _validateRowForUpdate(array $rowData, $rowNumber);
/**
* Validate data row for delete behaviour
*
* @param array $rowData
* @param int $rowNumber
* @return null
*/
abstract protected function _validateRowForDelete(array $rowData, $rowNumber);
/**
* General check of unique key
*
* @param array $rowData
* @param int $rowNumber
* @return bool
* @throws ValidateException
*/
protected function _checkUniqueKey(array $rowData, $rowNumber)
{
if (empty($rowData[static::COLUMN_WEBSITE])) {
$this->addRowError(static::ERROR_WEBSITE_IS_EMPTY, $rowNumber, static::COLUMN_WEBSITE);
} elseif (empty($rowData[static::COLUMN_EMAIL])) {
$this->addRowError(static::ERROR_EMAIL_IS_EMPTY, $rowNumber, static::COLUMN_EMAIL);
} else {
$email = strtolower($rowData[static::COLUMN_EMAIL]);
$website = $rowData[static::COLUMN_WEBSITE];
if (!ValidatorChain::is($email, EmailAddress::class)) {
$this->addRowError(static::ERROR_INVALID_EMAIL, $rowNumber, static::COLUMN_EMAIL);
} elseif (!isset($this->_websiteCodeToId[$website])) {
$this->addRowError(static::ERROR_INVALID_WEBSITE, $rowNumber, static::COLUMN_WEBSITE);
}
}
return !$this->getErrorAggregator()->isRowInvalid($rowNumber);
}
/**
* Get customer storage
*
* @return Storage
*/
public function getCustomerStorage()
{
return $this->_customerStorage;
}
/**
* Returns id of option by value for select and multiselect attributes
*
* @param array $attributeParameters Parameters of an attribute
* @param int|string $value A value of an attribute
* @return int An option id of attribute
* @since 100.2.0
*/
protected function getSelectAttrIdByValue(array $attributeParameters, $value)
{
$value = is_string($value) ? strtolower($value) : '';
return $attributeParameters['options'][$value] ?? 0;
}
/**
* Returns multiple value separator
*
* @return string
* @since 100.2.0
*/
protected function getMultipleValueSeparator()
{
return isset($this->_parameters[Import::FIELD_FIELD_MULTIPLE_VALUE_SEPARATOR])
? $this->_parameters[Import::FIELD_FIELD_MULTIPLE_VALUE_SEPARATOR]
: Import::DEFAULT_GLOBAL_MULTI_VALUE_SEPARATOR;
}
}