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-catalog/Model/ResourceModel/Eav/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Catalog\Model\ResourceModel\Eav;
use Magento\Catalog\Model\Attribute\Backend\DefaultBackend;
use Magento\Catalog\Model\Attribute\LockValidatorInterface;
use Magento\Eav\Model\Entity;
use Magento\Framework\Api\AttributeValueFactory;
use Magento\Framework\Stdlib\DateTime\DateTimeFormatterInterface;
/**
* Catalog attribute model
*
* @api
* @method \Magento\Catalog\Model\ResourceModel\Eav\Attribute getFrontendInputRenderer()
* @method string setFrontendInputRenderer(string $value)
* @method int setIsGlobal(int $value)
* @method int getSearchWeight()
* @method int setSearchWeight(int $value)
* @method bool getIsUsedForPriceRules()
* @method int setIsUsedForPriceRules(int $value)
*
* @author Magento Core Team <[email protected]>
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.ExcessivePublicCount)
* @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
* @since 100.0.2
*/
class Attribute extends \Magento\Eav\Model\Entity\Attribute implements
\Magento\Catalog\Api\Data\ProductAttributeInterface,
\Magento\Eav\Model\Entity\Attribute\ScopedAttributeInterface
{
const MODULE_NAME = 'Magento_Catalog';
const ENTITY = 'catalog_eav_attribute';
const KEY_IS_GLOBAL = 'is_global';
private const ALLOWED_INPUT_TYPES = [
'boolean' => true,
'date' => true,
'datetime' => true,
'multiselect' => true,
'price' => true,
'select' => true,
'text' => true,
'textarea' => true,
'weight' => true,
];
/**
* @var LockValidatorInterface
*/
protected $attrLockValidator;
/**
* Event object name
*
* @var string
*/
protected $_eventObject = 'attribute';
/**
* Array with labels
*
* @var array
*/
protected static $_labels = null;
/**
* Event prefix
*
* @var string
*/
protected $_eventPrefix = 'catalog_entity_attribute';
/**
* @var \Magento\Catalog\Model\Indexer\Product\Flat\Processor
*/
protected $_productFlatIndexerProcessor;
/**
* @var \Magento\Catalog\Helper\Product\Flat\Indexer
*/
protected $_productFlatIndexerHelper;
/**
* @var \Magento\Catalog\Model\Indexer\Product\Eav\Processor
*/
protected $_indexerEavProcessor;
/**
* @var \Magento\Eav\Api\Data\AttributeExtensionFactory
*/
private $eavAttributeFactory;
/**
* @param \Magento\Framework\Model\Context $context
* @param \Magento\Framework\Registry $registry
* @param \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory
* @param AttributeValueFactory $customAttributeFactory
* @param \Magento\Eav\Model\Config $eavConfig
* @param \Magento\Eav\Model\Entity\TypeFactory $eavTypeFactory
* @param \Magento\Store\Model\StoreManagerInterface $storeManager
* @param \Magento\Eav\Model\ResourceModel\Helper $resourceHelper
* @param \Magento\Framework\Validator\UniversalFactory $universalFactory
* @param \Magento\Eav\Api\Data\AttributeOptionInterfaceFactory $optionDataFactory
* @param \Magento\Framework\Reflection\DataObjectProcessor $dataObjectProcessor
* @param \Magento\Framework\Api\DataObjectHelper $dataObjectHelper
* @param \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate
* @param \Magento\Catalog\Model\Product\ReservedAttributeList $reservedAttributeList
* @param \Magento\Framework\Locale\ResolverInterface $localeResolver
* @param DateTimeFormatterInterface $dateTimeFormatter
* @param \Magento\Catalog\Model\Indexer\Product\Flat\Processor $productFlatIndexerProcessor
* @param \Magento\Catalog\Model\Indexer\Product\Eav\Processor $indexerEavProcessor
* @param \Magento\Catalog\Helper\Product\Flat\Indexer $productFlatIndexerHelper
* @param LockValidatorInterface $lockValidator
* @param \Magento\Framework\Model\ResourceModel\AbstractResource|null $resource
* @param \Magento\Framework\Data\Collection\AbstractDb|null $resourceCollection
* @param array $data
* @param \Magento\Eav\Api\Data\AttributeExtensionFactory|null $eavAttributeFactory
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
*/
public function __construct(
\Magento\Framework\Model\Context $context,
\Magento\Framework\Registry $registry,
\Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory,
AttributeValueFactory $customAttributeFactory,
\Magento\Eav\Model\Config $eavConfig,
\Magento\Eav\Model\Entity\TypeFactory $eavTypeFactory,
\Magento\Store\Model\StoreManagerInterface $storeManager,
\Magento\Eav\Model\ResourceModel\Helper $resourceHelper,
\Magento\Framework\Validator\UniversalFactory $universalFactory,
\Magento\Eav\Api\Data\AttributeOptionInterfaceFactory $optionDataFactory,
\Magento\Framework\Reflection\DataObjectProcessor $dataObjectProcessor,
\Magento\Framework\Api\DataObjectHelper $dataObjectHelper,
\Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate,
\Magento\Catalog\Model\Product\ReservedAttributeList $reservedAttributeList,
\Magento\Framework\Locale\ResolverInterface $localeResolver,
DateTimeFormatterInterface $dateTimeFormatter,
\Magento\Catalog\Model\Indexer\Product\Flat\Processor $productFlatIndexerProcessor,
\Magento\Catalog\Model\Indexer\Product\Eav\Processor $indexerEavProcessor,
\Magento\Catalog\Helper\Product\Flat\Indexer $productFlatIndexerHelper,
LockValidatorInterface $lockValidator,
\Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
\Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
array $data = [],
\Magento\Eav\Api\Data\AttributeExtensionFactory $eavAttributeFactory = null
) {
$this->_indexerEavProcessor = $indexerEavProcessor;
$this->_productFlatIndexerProcessor = $productFlatIndexerProcessor;
$this->_productFlatIndexerHelper = $productFlatIndexerHelper;
$this->attrLockValidator = $lockValidator;
$this->eavAttributeFactory = $eavAttributeFactory ?: \Magento\Framework\App\ObjectManager::getInstance()
->get(\Magento\Eav\Api\Data\AttributeExtensionFactory::class);
parent::__construct(
$context,
$registry,
$extensionFactory,
$customAttributeFactory,
$eavConfig,
$eavTypeFactory,
$storeManager,
$resourceHelper,
$universalFactory,
$optionDataFactory,
$dataObjectProcessor,
$dataObjectHelper,
$localeDate,
$reservedAttributeList,
$localeResolver,
$dateTimeFormatter,
$resource,
$resourceCollection,
$data
);
}
/**
* Init model
*
* @return void
*/
protected function _construct()
{
$this->_init(\Magento\Catalog\Model\ResourceModel\Attribute::class);
}
/**
* Processing object before save data
*
* @return \Magento\Framework\Model\AbstractModel
* @throws \Magento\Framework\Exception\LocalizedException
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
public function beforeSave()
{
$this->setData('modulePrefix', self::MODULE_NAME);
if (isset($this->_origData[self::KEY_IS_GLOBAL])) {
if (!isset($this->_data[self::KEY_IS_GLOBAL])) {
$this->_data[self::KEY_IS_GLOBAL] = self::SCOPE_GLOBAL;
}
if ($this->_data[self::KEY_IS_GLOBAL] != $this->_origData[self::KEY_IS_GLOBAL]) {
try {
$this->attrLockValidator->validate($this);
} catch (\Magento\Framework\Exception\LocalizedException $exception) {
throw new \Magento\Framework\Exception\LocalizedException(
__('Do not change the scope. %1', $exception->getMessage())
);
}
}
}
if ($this->getFrontendInput() == 'price') {
if (!$this->getBackendModel()) {
$this->setBackendModel(\Magento\Catalog\Model\Product\Attribute\Backend\Price::class);
}
}
if ($this->getFrontendInput() == 'textarea') {
if ($this->getIsWysiwygEnabled()) {
$this->setIsHtmlAllowedOnFront(1);
}
}
if (!$this->getIsSearchable()) {
$this->setIsVisibleInAdvancedSearch(false);
}
return parent::beforeSave();
}
/**
* Processing object after save data
*
* @return \Magento\Framework\Model\AbstractModel
*/
public function afterSave()
{
/**
* Fix saving attribute in admin
*/
$this->_eavConfig->clear();
if ($this->_isOriginalEnabledInFlat() != $this->_isEnabledInFlat()) {
$this->_productFlatIndexerProcessor->markIndexerAsInvalid();
}
if ($this->_isOriginalIndexable() !== $this->isIndexable()
|| ($this->isIndexable() && $this->dataHasChangedFor(self::KEY_IS_GLOBAL))
) {
$this->_indexerEavProcessor->markIndexerAsInvalid();
}
$this->_source = null;
return parent::afterSave();
}
/**
* Is attribute enabled for flat indexing
*
* @return bool
* @since 103.0.0
*/
public function isEnabledInFlat()
{
return $this->_isEnabledInFlat();
}
/**
* Is attribute enabled for flat indexing
*
* @return bool
*/
protected function _isEnabledInFlat()
{
return $this->_getData('backend_type') == 'static'
|| $this->_productFlatIndexerHelper->isAddFilterableAttributes()
&& $this->_getData('is_filterable') > 0
|| $this->_getData('used_in_product_listing') == 1
|| $this->_getData('used_for_sort_by') == 1;
}
/**
* Is original attribute enabled for flat indexing
*
* @return bool
*/
protected function _isOriginalEnabledInFlat()
{
return $this->getOrigData('backend_type') == 'static'
|| $this->_productFlatIndexerHelper->isAddFilterableAttributes()
&& $this->getOrigData('is_filterable') > 0
|| $this->getOrigData('used_in_product_listing') == 1
|| $this->getOrigData('used_for_sort_by') == 1;
}
/**
* Register indexing event before delete catalog eav attribute
*
* @return $this
* @throws \Magento\Framework\Exception\LocalizedException
*/
public function beforeDelete()
{
$this->attrLockValidator->validate($this);
return parent::beforeDelete();
}
/**
* Init indexing process after catalog eav attribute delete commit
*
* @return $this
*/
public function afterDeleteCommit()
{
parent::afterDeleteCommit();
if ($this->_isOriginalEnabledInFlat()) {
$this->_productFlatIndexerProcessor->markIndexerAsInvalid();
}
if ($this->_isOriginalIndexable()) {
$this->_indexerEavProcessor->markIndexerAsInvalid();
}
return $this;
}
/**
* Return is attribute global
*
* @return integer
*/
public function getIsGlobal()
{
return $this->_getData(self::KEY_IS_GLOBAL);
}
/**
* Retrieve attribute is global scope flag
*
* @return bool
*/
public function isScopeGlobal()
{
return $this->getIsGlobal() == self::SCOPE_GLOBAL;
}
/**
* Retrieve attribute is website scope website
*
* @return bool
*/
public function isScopeWebsite()
{
return $this->getIsGlobal() == self::SCOPE_WEBSITE;
}
/**
* Retrieve attribute is store scope flag
*
* @return bool
*/
public function isScopeStore()
{
return !$this->isScopeGlobal() && !$this->isScopeWebsite();
}
/**
* Retrieve store id
*
* @return int
*/
public function getStoreId()
{
$dataObject = $this->getDataObject();
if ($dataObject) {
return $dataObject->getStoreId();
}
return $this->_getData('store_id');
}
/**
* Retrieve apply to products array
*
* Return empty array if applied to all products
*
* @return string[]
*/
public function getApplyTo()
{
$applyTo = $this->_getData(self::APPLY_TO) ?: [];
if (!is_array($applyTo)) {
$applyTo = explode(',', $applyTo);
}
return $applyTo;
}
/**
* Retrieve source model
*
* @return \Magento\Eav\Model\Entity\Attribute\Source\AbstractSource|string|null
*/
public function getSourceModel()
{
$model = $this->_getData('source_model');
if (empty($model)) {
if ($this->getBackendType() == 'int' && $this->getFrontendInput() == 'select') {
return $this->_getDefaultSourceModel();
}
}
return $model;
}
/**
* Whether allowed for rule condition
*
* @return bool
*/
public function isAllowedForRuleCondition()
{
return $this->getIsVisible() && isset(self::ALLOWED_INPUT_TYPES[$this->getFrontendInput()]);
}
/**
* Get default attribute source model
*
* @return string
*/
public function _getDefaultSourceModel()
{
return \Magento\Eav\Model\Entity\Attribute\Source\Table::class;
}
/**
* Check is an attribute used in EAV index
*
* @return bool
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
public function isIndexable()
{
// exclude price attribute
if ($this->getAttributeCode() == 'price') {
return false;
}
if ($this->getAttributeCode() == 'visibility') {
return true;
}
if (!$this->getIsFilterableInSearch() && !$this->getIsVisibleInAdvancedSearch() && !$this->getIsFilterable()) {
return false;
}
$backendType = $this->getBackendType();
$frontendInput = $this->getFrontendInput();
if ($backendType == 'int' && $frontendInput == 'select') {
return true;
} elseif ($backendType == 'varchar' && $frontendInput == 'multiselect') {
return true;
} elseif ($backendType == 'decimal') {
return true;
}
return false;
}
/**
* Is original attribute config indexable
*
* @return bool
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
protected function _isOriginalIndexable()
{
// exclude price attribute
if ($this->getOrigData('attribute_code') == 'price') {
return false;
}
if (!$this->getOrigData('is_filterable_in_search')
&& !$this->getOrigData('is_visible_in_advanced_search')
&& !$this->getOrigData('is_filterable')) {
return false;
}
$backendType = $this->getOrigData('backend_type');
$frontendInput = $this->getOrigData('frontend_input');
if ($backendType == 'int' && ($frontendInput == 'select' || $frontendInput == 'boolean')) {
return true;
} elseif ($backendType == 'varchar' && $frontendInput == 'multiselect') {
return true;
} elseif ($backendType == 'decimal') {
return true;
}
return false;
}
/**
* Retrieve index type for indexable attribute
*
* @return string|false
*/
public function getIndexType()
{
if (!$this->isIndexable()) {
return false;
}
if ($this->getBackendType() == 'decimal') {
return 'decimal';
}
return 'source';
}
/**
* @inheritdoc
* @codeCoverageIgnoreStart
*/
public function getIsWysiwygEnabled()
{
return $this->_getData(self::IS_WYSIWYG_ENABLED);
}
/**
* @inheritdoc
*/
public function getIsHtmlAllowedOnFront()
{
return $this->_getData(self::IS_HTML_ALLOWED_ON_FRONT);
}
/**
* @inheritdoc
*/
public function getUsedForSortBy()
{
return $this->_getData(self::USED_FOR_SORT_BY);
}
/**
* @inheritdoc
*/
public function getIsFilterable()
{
return $this->_getData(self::IS_FILTERABLE);
}
/**
* @inheritdoc
*/
public function getIsFilterableInSearch()
{
return $this->_getData(self::IS_FILTERABLE_IN_SEARCH);
}
/**
* @inheritdoc
*/
public function getIsUsedInGrid()
{
return (bool)$this->_getData(self::IS_USED_IN_GRID);
}
/**
* @inheritdoc
*/
public function getIsVisibleInGrid()
{
return (bool)$this->_getData(self::IS_VISIBLE_IN_GRID);
}
/**
* @inheritdoc
*/
public function getIsFilterableInGrid()
{
return (bool)$this->_getData(self::IS_FILTERABLE_IN_GRID);
}
/**
* @inheritdoc
*/
public function getPosition()
{
return $this->_getData(self::POSITION);
}
/**
* @inheritdoc
*/
public function getIsSearchable()
{
return $this->_getData(self::IS_SEARCHABLE);
}
/**
* @inheritdoc
*/
public function getIsVisibleInAdvancedSearch()
{
return $this->_getData(self::IS_VISIBLE_IN_ADVANCED_SEARCH);
}
/**
* @inheritdoc
*/
public function getIsComparable()
{
return $this->_getData(self::IS_COMPARABLE);
}
/**
* @inheritdoc
*/
public function getIsUsedForPromoRules()
{
return $this->_getData(self::IS_USED_FOR_PROMO_RULES);
}
/**
* @inheritdoc
*/
public function getIsVisibleOnFront()
{
return $this->_getData(self::IS_VISIBLE_ON_FRONT);
}
/**
* @inheritdoc
*/
public function getUsedInProductListing()
{
return $this->_getData(self::USED_IN_PRODUCT_LISTING);
}
/**
* @inheritdoc
*/
public function getIsVisible()
{
return $this->_getData(self::IS_VISIBLE);
}
//@codeCoverageIgnoreEnd
/**
* @inheritdoc
*/
public function getScope()
{
if ($this->isScopeGlobal()) {
return self::SCOPE_GLOBAL_TEXT;
} elseif ($this->isScopeWebsite()) {
return self::SCOPE_WEBSITE_TEXT;
} else {
return self::SCOPE_STORE_TEXT;
}
}
/**
* Set whether WYSIWYG is enabled flag
*
* @param bool $isWysiwygEnabled
* @return $this
*/
public function setIsWysiwygEnabled($isWysiwygEnabled)
{
return $this->setData(self::IS_WYSIWYG_ENABLED, $isWysiwygEnabled);
}
/**
* Set whether the HTML tags are allowed on the frontend
*
* @param bool $isHtmlAllowedOnFront
* @return $this
*/
public function setIsHtmlAllowedOnFront($isHtmlAllowedOnFront)
{
return $this->setData(self::IS_HTML_ALLOWED_ON_FRONT, $isHtmlAllowedOnFront);
}
/**
* Set whether it is used for sorting in product listing
*
* @param bool $usedForSortBy
* @return $this
*/
public function setUsedForSortBy($usedForSortBy)
{
return $this->setData(self::USED_FOR_SORT_BY, $usedForSortBy);
}
/**
* Set whether it used in layered navigation
*
* @param bool $isFilterable
* @return $this
*/
public function setIsFilterable($isFilterable)
{
return $this->setData(self::IS_FILTERABLE, $isFilterable);
}
/**
* Set whether it is used in search results layered navigation
*
* @param bool $isFilterableInSearch
* @return $this
*/
public function setIsFilterableInSearch($isFilterableInSearch)
{
return $this->setData(self::IS_FILTERABLE_IN_SEARCH, $isFilterableInSearch);
}
/**
* Set position
*
* @param int $position
* @return $this
*/
public function setPosition($position)
{
return $this->setData(self::POSITION, $position);
}
/**
* Set apply to value for the element
*
* @param string[]|string $applyTo
* @return $this
*/
public function setApplyTo($applyTo)
{
if (is_array($applyTo)) {
$applyTo = implode(',', $applyTo);
}
return $this->setData(self::APPLY_TO, $applyTo);
}
/**
* Whether the attribute can be used in Quick Search
*
* @param string $isSearchable
* @return $this
*/
public function setIsSearchable($isSearchable)
{
return $this->setData(self::IS_SEARCHABLE, $isSearchable);
}
/**
* Set whether the attribute can be used in Advanced Search
*
* @param string $isVisibleInAdvancedSearch
* @return $this
*/
public function setIsVisibleInAdvancedSearch($isVisibleInAdvancedSearch)
{
return $this->setData(self::IS_VISIBLE_IN_ADVANCED_SEARCH, $isVisibleInAdvancedSearch);
}
/**
* Set whether the attribute can be compared on the frontend
*
* @param string $isComparable
* @return $this
*/
public function setIsComparable($isComparable)
{
return $this->setData(self::IS_COMPARABLE, $isComparable);
}
/**
* Set whether the attribute can be used for promo rules
*
* @param string $isUsedForPromoRules
* @return $this
*/
public function setIsUsedForPromoRules($isUsedForPromoRules)
{
return $this->setData(self::IS_USED_FOR_PROMO_RULES, $isUsedForPromoRules);
}
/**
* Set whether the attribute is visible on the frontend
*
* @param string $isVisibleOnFront
* @return $this
*/
public function setIsVisibleOnFront($isVisibleOnFront)
{
return $this->setData(self::IS_VISIBLE_ON_FRONT, $isVisibleOnFront);
}
/**
* Set whether the attribute can be used in product listing
*
* @param string $usedInProductListing
* @return $this
*/
public function setUsedInProductListing($usedInProductListing)
{
return $this->setData(self::USED_IN_PRODUCT_LISTING, $usedInProductListing);
}
/**
* Set whether attribute is visible on frontend.
*
* @param bool $isVisible
* @return $this
*/
public function setIsVisible($isVisible)
{
return $this->setData(self::IS_VISIBLE, $isVisible);
}
/**
* Set attribute scope
*
* @param string $scope
* @return $this
*/
public function setScope($scope)
{
if ($scope == self::SCOPE_GLOBAL_TEXT) {
return $this->setData(self::KEY_IS_GLOBAL, self::SCOPE_GLOBAL);
} elseif ($scope == self::SCOPE_WEBSITE_TEXT) {
return $this->setData(self::KEY_IS_GLOBAL, self::SCOPE_WEBSITE);
} elseif ($scope == self::SCOPE_STORE_TEXT) {
return $this->setData(self::KEY_IS_GLOBAL, self::SCOPE_STORE);
} else {
//Ignore unrecognized scope
return $this;
}
}
/**
* @inheritdoc
*/
public function afterDelete()
{
$this->_eavConfig->clear();
return parent::afterDelete();
}
/**
* @inheritdoc
* @since 100.0.9
*/
public function __sleep()
{
$this->unsetData('entity_type');
return array_diff(
parent::__sleep(),
['_indexerEavProcessor', '_productFlatIndexerProcessor', '_productFlatIndexerHelper', 'attrLockValidator']
);
}
/**
* @inheritdoc
* @since 100.0.9
*/
public function __wakeup()
{
parent::__wakeup();
$objectManager = \Magento\Framework\App\ObjectManager::getInstance();
$this->_indexerEavProcessor = $objectManager->get(\Magento\Catalog\Model\Indexer\Product\Flat\Processor::class);
$this->_productFlatIndexerProcessor = $objectManager->get(
\Magento\Catalog\Model\Indexer\Product\Eav\Processor::class
);
$this->_productFlatIndexerHelper = $objectManager->get(\Magento\Catalog\Helper\Product\Flat\Indexer::class);
$this->attrLockValidator = $objectManager->get(LockValidatorInterface::class);
}
/**
* @inheritdoc
* @since 102.0.0
*/
public function setIsUsedInGrid($isUsedInGrid)
{
$this->setData(self::IS_USED_IN_GRID, $isUsedInGrid);
return $this;
}
/**
* @inheritdoc
* @since 102.0.0
*/
public function setIsVisibleInGrid($isVisibleInGrid)
{
$this->setData(self::IS_VISIBLE_IN_GRID, $isVisibleInGrid);
return $this;
}
/**
* @inheritdoc
* @since 102.0.0
*/
public function setIsFilterableInGrid($isFilterableInGrid)
{
$this->setData(self::IS_FILTERABLE_IN_GRID, $isFilterableInGrid);
return $this;
}
/**
* @inheritDoc
*/
protected function _getDefaultBackendModel()
{
$backend = parent::_getDefaultBackendModel();
if ($backend === Entity::DEFAULT_BACKEND_MODEL) {
$backend = DefaultBackend::class;
}
return $backend;
}
}