Config Class Reference

Inheritance diagram for Config:

Public Member Functions
	__construct (\Magento\Framework\App\CacheInterface $cache, \Magento\Eav\Model\Entity\TypeFactory $entityTypeFactory, \Magento\Eav\Model\ResourceModel\Entity\Type\CollectionFactory $entityTypeCollectionFactory, \Magento\Framework\App\Cache\StateInterface $cacheState, \Magento\Framework\Validator\UniversalFactory $universalFactory, SerializerInterface $serializer=null)
	getCache ()
	clear ()
	isCacheEnabled ()
	getEntityType ($code)
	getAttributes ($entityType)
	getAttribute ($entityType, $code)
	getEntityAttributeCodes ($entityType, $object=null)
	getEntityAttributes ($entityType, $object=null)
	importAttributesData ($entityType, array $attributes)

Data Fields
const	ENTITIES_CACHE_ID = 'EAV_ENTITY_TYPES'
const	ATTRIBUTES_CACHE_ID = 'EAV_ENTITY_ATTRIBUTES'
const	ATTRIBUTES_CODES_CACHE_ID = 'EAV_ENTITY_ATTRIBUTES_CODES'

Protected Member Functions
	_load ($id)
	_save ($obj, $id)
	_addEntityTypeReference ($id, $code)
	_getEntityTypeReference ($id)
	_addAttributeReference ($id, $code, $entityTypeCode)
	_getAttributeReference ($id, $entityTypeCode)
	_getEntityKey ($code)
	_getAttributeKey ($entityTypeCode, $attributeCode)
	_initEntityTypes ()
	_initAttributes ($entityType)
	_validateAttributeData ($attributeData=null)

Protected Attributes
	$_entityTypeData
	$_attributeData
	$_attributeCodes
	$_objects
	$_references
	$_isCacheEnabled = null
	$_cache
	$_cacheState
	$_entityTypeFactory
	$entityTypeCollectionFactory
	$_universalFactory

Detailed Description

@api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since

100.0.2

Definition at line 18 of file Config.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\CacheInterface	$cache,
		\Magento\Eav\Model\Entity\TypeFactory	$entityTypeFactory,
		\Magento\Eav\Model\ResourceModel\Entity\Type\CollectionFactory	$entityTypeCollectionFactory,
		\Magento\Framework\App\Cache\StateInterface	$cacheState,
		\Magento\Framework\Validator\UniversalFactory	$universalFactory,
		SerializerInterface	$serializer = null
	)

Parameters

\Magento\Framework\App\CacheInterface	$cache
\Magento\Eav\Model\Entity\TypeFactory	$entityTypeFactory
\Magento\Eav\Model\ResourceModel\Entity\Type\CollectionFactory	$entityTypeCollectionFactory
\Magento\Framework\App\Cache\StateInterface	$cacheState
\Magento\Framework\Validator\UniversalFactory	$universalFactory
SerializerInterface	$serializer	@codeCoverageIgnore

Definition at line 135 of file Config.php.

      {
        $this->_cache = $cache;
        $this->_entityTypeFactory = $entityTypeFactory;
        $this->entityTypeCollectionFactory = $entityTypeCollectionFactory;
        $this->_cacheState = $cacheState;
        $this->_universalFactory = $universalFactory;
        $this->serializer = $serializer ?: ObjectManager::getInstance()->get(SerializerInterface::class);
    }

Member Function Documentation

_addAttributeReference()

_addAttributeReference (   $id,   $code,   $entityTypeCode  )

protected

Specify reference between entity attribute id and attribute code

Parameters

int	$id
string	$code
string	$entityTypeCode

Returns

$this

Definition at line 266 of file Config.php.

    {
        $this->_references['attribute'][$entityTypeCode][$id] = $code;
        return $this;
    }

_addEntityTypeReference()

_addEntityTypeReference (   $id,   $code  )

protected

Specify reference for entity type id

Parameters

int	$id
string	$code

Returns

$this @codeCoverageIgnore

Definition at line 241 of file Config.php.

    {
        $this->_references['entity'][$id] = $code;
        return $this;
    }

_getAttributeKey()

_getAttributeKey (   $entityTypeCode,   $attributeCode  )

protected

Get internal cache key for attribute object cache

Parameters

string	$entityTypeCode
string	$attributeCode

Returns

string @codeCoverageIgnore

Definition at line 307 of file Config.php.

    {
        $codeSegments = explode('.', $attributeCode);

        return 'ATTRIBUTE/' . $entityTypeCode . '/' . array_pop($codeSegments);
    }

_getAttributeReference()

_getAttributeReference (   $id,   $entityTypeCode  )

protected

Get attribute code by attribute id

Parameters

int	$id
string	$entityTypeCode

Returns

string|null

Definition at line 279 of file Config.php.

    {
        if (isset($this->_references['attribute'][$entityTypeCode][$id])) {
            return $this->_references['attribute'][$entityTypeCode][$id];
        }
        return null;
    }

_getEntityKey()

_getEntityKey (   $code )

protected

Get internal cache key for entity type code

Parameters

string

$code

Returns

string @codeCoverageIgnore

Definition at line 294 of file Config.php.

    {
        return 'ENTITY/' . $code;
    }

_getEntityTypeReference()

_getEntityTypeReference (   $id )

protected

Get entity type code by id

Parameters

int

$id

Returns

string

Definition at line 253 of file Config.php.

    {
        return isset($this->_references['entity'][$id]) ? $this->_references['entity'][$id] : null;
    }

_initAttributes()

_initAttributes (   $entityType )

protected

Initialize all attributes for entity type

Parameters

string

$entityType

Returns

$this

Definition at line 424 of file Config.php.

    {
        $entityType = $this->getEntityType($entityType);
        $entityTypeCode = $entityType->getEntityTypeCode();

        if (is_array($this->_attributeData) && isset($this->_attributeData[$entityTypeCode])) {
            return $this;
        }

        if ($this->initAttributesFromCache($entityType)) {
            return $this;
        }

        \Magento\Framework\Profiler::start('EAV: ' . __METHOD__, ['group' => 'EAV', 'method' => __METHOD__]);

        $attributes = $this->_universalFactory->create(
            $entityType->getEntityAttributeCollection()
        )->setEntityTypeFilter(
            $entityType
        )->getData();

        $this->_attributeData[$entityTypeCode] = [];
        foreach ($attributes as $attribute) {
            if (empty($attribute['attribute_model'])) {
                $attribute['attribute_model'] = $entityType->getAttributeModel();
            }
            $attributeObject = $this->_createAttribute($entityType, $attribute);
            $this->saveAttribute($attributeObject, $entityTypeCode, $attributeObject->getAttributeCode());
            $this->_attributeData[$entityTypeCode][$attribute['attribute_code']] = $attributeObject->toArray();
        }
        if ($this->isCacheEnabled()) {
            $this->_cache->save(
                $this->serializer->serialize($this->_attributeData[$entityTypeCode]),
                self::ATTRIBUTES_CACHE_ID . $entityTypeCode,
                [
                    \Magento\Eav\Model\Cache\Type::CACHE_TAG,
                    \Magento\Eav\Model\Entity\Attribute::CACHE_TAG
                ]
            );
        }

        \Magento\Framework\Profiler::stop('EAV: ' . __METHOD__);
        return $this;
    }

_initEntityTypes()

_initEntityTypes ( )

protected

Initialize all entity types data

Returns

$this

Definition at line 332 of file Config.php.

    {
        if (is_array($this->_entityTypeData)) {
            return $this;
        }
        \Magento\Framework\Profiler::start('EAV: ' . __METHOD__, ['group' => 'EAV', 'method' => __METHOD__]);

        if ($this->isCacheEnabled() && ($cache = $this->_cache->load(self::ENTITIES_CACHE_ID))) {
            $this->_entityTypeData = $this->serializer->unserialize($cache);
            foreach ($this->_entityTypeData as $typeCode => $data) {
                $typeId = $data['entity_type_id'];
                $this->_addEntityTypeReference($typeId, $typeCode);
            }
            \Magento\Framework\Profiler::stop('EAV: ' . __METHOD__);
            return $this;
        }

        $entityTypesData = $this->entityTypeCollectionFactory->create()->getData();
        foreach ($entityTypesData as $typeData) {
            if (!isset($typeData['attribute_model'])) {
                $typeData['attribute_model'] = \Magento\Eav\Model\Entity\Attribute::class;
            }

            $typeCode = $typeData['entity_type_code'];
            $typeId = $typeData['entity_type_id'];

            $this->_addEntityTypeReference($typeId, $typeCode);
            $this->_entityTypeData[$typeCode] = $typeData;
        }

        if ($this->isCacheEnabled()) {
            $this->_cache->save(
                $this->serializer->serialize($this->_entityTypeData),
                self::ENTITIES_CACHE_ID,
                [
                    \Magento\Eav\Model\Cache\Type::CACHE_TAG,
                    \Magento\Eav\Model\Entity\Attribute::CACHE_TAG
                ]
            );
        }
        \Magento\Framework\Profiler::stop('EAV: ' . __METHOD__);
        return $this;
    }

_load()

_load (   $id )

protected

Get object by identifier

Parameters

mixed

$id

Returns

mixed

Definition at line 191 of file Config.php.

    {
        return isset($this->_objects[$id]) ? $this->_objects[$id] : null;
    }

_save()

_save (   $obj,   $id  )

protected

Associate object with identifier

Parameters

mixed	$obj
mixed	$id

Returns

void @codeCoverageIgnore

Definition at line 215 of file Config.php.

    {
        $this->_objects[$id] = $obj;
    }

_validateAttributeData()

_validateAttributeData (   $attributeData = null )

protected

Validate attribute data from import

Parameters

array

$attributeData

Returns

bool

Definition at line 670 of file Config.php.

    {
        if (!is_array($attributeData)) {
            return false;
        }
        $requiredKeys = ['attribute_id', 'attribute_code', 'entity_type_id', 'attribute_model'];
        foreach ($requiredKeys as $key) {
            if (!array_key_exists($key, $attributeData)) {
                return false;
            }
        }

        return true;
    }

clear()

clear

(

)

Reset object state

Returns

$this

Definition at line 167 of file Config.php.

    {
        $this->_entityTypeData = null;
        $this->_attributeData = null;
        $this->_objects = null;
        $this->attributes = null;
        $this->_references = null;
        $this->_attributeCodes = null;
        $this->attributesPerSet = [];
        $this->_cache->clean(
            [
                \Magento\Eav\Model\Cache\Type::CACHE_TAG,
                \Magento\Eav\Model\Entity\Attribute::CACHE_TAG,
            ]
        );
        return $this;
    }

getAttribute()

getAttribute	(		$entityType,
			$code
	)

Get attribute by code for entity type

Parameters

mixed	$entityType
mixed	$code

Returns

AbstractAttribute

Exceptions

Definition at line 492 of file Config.php.

    {
        if ($code instanceof \Magento\Eav\Model\Entity\Attribute\AttributeInterface) {
            return $code;
        }

        \Magento\Framework\Profiler::start('EAV: ' . __METHOD__, ['group' => 'EAV', 'method' => __METHOD__]);
        $entityTypeCode = $this->getEntityType($entityType)->getEntityTypeCode();

        if (is_numeric($code)) { // if code is numeric, try to map attribute id to code
            $code = $this->_getAttributeReference($code, $entityTypeCode) ?: $code;
        }

        if (isset($this->attributes[$entityTypeCode][$code])) {
            \Magento\Framework\Profiler::stop('EAV: ' . __METHOD__);
            return $this->attributes[$entityTypeCode][$code];
        }

        $attributes = $this->loadAttributes($entityTypeCode);
        $attribute = isset($attributes[$code]) ? $attributes[$code] : null;
        if (!$attribute) {
            $attribute = $this->createAttributeByAttributeCode($entityType, $code);
            $this->_addAttributeReference(
                $attribute->getAttributeId(),
                $attribute->getAttributeCode(),
                $entityTypeCode
            );
            $this->saveAttribute($attribute, $entityTypeCode, $attribute->getAttributeCode());
        }
        \Magento\Framework\Profiler::stop('EAV: ' . __METHOD__);
        return $attribute;
    }

getAttributes()

getAttributes

(

$entityType

)

Get attributes by entity type

Deprecated:

101.0.0

See also

\Magento\Eav\Model\Config::getEntityAttributes

Parameters

string

$entityType

Returns

AbstractAttribute[]

Since

101.0.0

Definition at line 479 of file Config.php.

    {
        return $this->getEntityAttributes($entityType);
    }

getCache()

getCache

(

)

Get cache interface

Returns

\Magento\Framework\App\CacheInterface @codeCoverageIgnore

Definition at line 157 of file Config.php.

    {
        return $this->_cache;
    }

getEntityAttributeCodes()

getEntityAttributeCodes	(		$entityType,
			$object = null
	)

Get codes of all entity type attributes

Deprecated:

101.0.0

See also

\Magento\Eav\Model\Config::getEntityAttributes

Parameters

mixed	$entityType
\Magento\Framework\DataObject	$object

Returns

string[]

Definition at line 550 of file Config.php.

    {
        return array_keys($this->getEntityAttributes($entityType, $object));
    }

getEntityAttributes()

getEntityAttributes	(		$entityType,
			$object = null
	)

Get all entity type attributes

Parameters

int | string | Type	$entityType
\Magento\Framework\DataObject | null	$object

Returns

AbstractAttribute[]

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

Since

101.0.0

Definition at line 566 of file Config.php.

    {
        $entityType = $this->getEntityType($entityType);
        $attributeSetId = 0;
        $storeId = 0;
        if ($object instanceof \Magento\Framework\DataObject) {
            $attributeSetId = $object->getAttributeSetId() ?: $attributeSetId;
            $storeId = $object->getStoreId() ?: $storeId;
        }
        $cacheKey = self::ATTRIBUTES_CACHE_ID . '-' . $entityType->getId() . '-' . $storeId . '-' . $attributeSetId;

        if (isset($this->attributesPerSet[$cacheKey])) {
            return $this->attributesPerSet[$cacheKey];
        }

        $attributesData = $this->isCacheEnabled() && ($attributes = $this->_cache->load($cacheKey))
            ? $this->serializer->unserialize($attributes)
            : null;

        $attributes = [];
        if ($attributesData === null) {
            if ($attributeSetId) {
                $attributesData = $this->_universalFactory->create(
                    $entityType->getEntityAttributeCollection()
                )->setEntityTypeFilter(
                    $entityType
                )->setAttributeSetFilter(
                    $attributeSetId
                )->addStoreLabel(
                    $storeId
                )->getData();
            } else {
                $this->_initAttributes($entityType);
                $attributesData = $this->_attributeData[$entityType->getEntityTypeCode()];
            }

            if ($this->isCacheEnabled()) {
                $this->_cache->save(
                    $this->serializer->serialize($attributesData),
                    $cacheKey,
                    [
                        \Magento\Eav\Model\Cache\Type::CACHE_TAG,
                        \Magento\Eav\Model\Entity\Attribute::CACHE_TAG
                    ]
                );
            }
        }

        foreach ($attributesData as $attributeData) {
            $attributes[$attributeData['attribute_code']] = $this->_createAttribute($entityType, $attributeData);
        }

        $this->attributesPerSet[$cacheKey] = $attributes;

        return $attributes;
    }

getEntityType()

getEntityType

(

$code

)

Get entity type object by entity type code/identifier

Parameters

int | string | Type

$code

Returns

Type

Exceptions

Definition at line 383 of file Config.php.

    {
        if ($code instanceof Type) {
            return $code;
        }
        $this->_initEntityTypes();
        \Magento\Framework\Profiler::start('EAV: ' . __METHOD__, ['group' => 'EAV', 'method' => __METHOD__]);

        if (is_numeric($code)) {
            $entityCode = $this->_getEntityTypeReference($code);
            if ($entityCode !== null) {
                $code = $entityCode;
            }
        }

        $entityKey = $this->_getEntityKey($code);
        $entityType = $this->_load($entityKey);
        if ($entityType) {
            \Magento\Framework\Profiler::stop('EAV: ' . __METHOD__);
            return $entityType;
        }

        $entityType = $this->_entityTypeFactory->create(
            ['data' => isset($this->_entityTypeData[$code]) ? $this->_entityTypeData[$code] : []]
        );
        if (!$entityType->getId()) {
            throw new \Magento\Framework\Exception\LocalizedException(__('Invalid entity_type specified: %1', $code));
        }
        $this->_addEntityTypeReference($entityType->getId(), $entityType->getEntityTypeCode());
        $this->_save($entityType, $entityKey);

        \Magento\Framework\Profiler::stop('EAV: ' . __METHOD__);
        return $entityType;
    }

importAttributesData()

importAttributesData	(		$entityType,
		array	$attributes
	)

Import attributes data from external source

Parameters

string | Type	$entityType
array	$attributes

Returns

$this

Definition at line 692 of file Config.php.

    {
        $entityType = $this->getEntityType($entityType);
        foreach ($attributes as $attributeData) {
            if (!$this->_validateAttributeData($attributeData)) {
                continue;
            }
            $this->_createAttribute($entityType, $attributeData);
        }

        return $this;
    }

isCacheEnabled()

isCacheEnabled

(

)

Check EAV cache availability

Returns

bool

Definition at line 319 of file Config.php.

    {
        if ($this->_isCacheEnabled === null) {
            $this->_isCacheEnabled = $this->_cacheState->isEnabled(\Magento\Eav\Model\Cache\Type::TYPE_IDENTIFIER);
        }
        return $this->_isCacheEnabled;
    }

Field Documentation

$_attributeCodes

$_attributeCodes

protected

Definition at line 43 of file Config.php.

$_attributeData

$_attributeData

protected

Definition at line 36 of file Config.php.

$_cache

$_cache

protected

Definition at line 87 of file Config.php.

$_cacheState

$_cacheState

protected

Definition at line 92 of file Config.php.

$_entityTypeData

$_entityTypeData

protected

#- #-

Definition at line 29 of file Config.php.

$_entityTypeFactory

$_entityTypeFactory

protected

Definition at line 97 of file Config.php.

$_isCacheEnabled

$_isCacheEnabled = null

protected

Definition at line 82 of file Config.php.

$_objects

$_objects

protected

Definition at line 52 of file Config.php.

$_references

$_references

protected

Definition at line 75 of file Config.php.

$_universalFactory

$_universalFactory

protected

Definition at line 107 of file Config.php.

$entityTypeCollectionFactory

$entityTypeCollectionFactory

protected

Definition at line 102 of file Config.php.

ATTRIBUTES_CACHE_ID

const ATTRIBUTES_CACHE_ID = 'EAV_ENTITY_ATTRIBUTES'

Definition at line 24 of file Config.php.

ATTRIBUTES_CODES_CACHE_ID

const ATTRIBUTES_CODES_CACHE_ID = 'EAV_ENTITY_ATTRIBUTES_CODES'

Definition at line 25 of file Config.php.

ENTITIES_CACHE_ID

const ENTITIES_CACHE_ID = 'EAV_ENTITY_TYPES'

#+ EAV cache ids

Definition at line 23 of file Config.php.

---

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

• vendor/magento/module-eav/Model/Config.php