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, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Catalog\Model\ResourceModel\ConfigFactory $configFactory, \Magento\Catalog\Model\Product\TypeFactory $productTypeFactory, \Magento\Eav\Model\ResourceModel\Entity\Attribute\Group\CollectionFactory $groupCollectionFactory, \Magento\Eav\Model\ResourceModel\Entity\Attribute\Set\CollectionFactory $setCollectionFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Eav\Model\Config $eavConfig, SerializerInterface $serializer=null)
	setStoreId ($storeId)
	getStoreId ()
	loadAttributeSets ()
	getAttributeSetName ($entityTypeId, $id)
	getAttributeSetId ($entityTypeId, $name=null)
	loadAttributeGroups ()
	getAttributeGroupName ($attributeSetId, $id)
	getAttributeGroupId ($attributeSetId, $name)
	loadProductTypes ()
	getProductTypeId ($name)
	getProductTypeName ($id)
	getSourceOptionId ($source, $value)
	getProductAttributes ()
	getAttributesUsedInProductListing ()
	getAttributesUsedForSortBy ()
	getAttributeUsedForSortByArray ()
	getProductListDefaultSortBy ($store=null)
Public Member Functions inherited from Config
	__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	XML_PATH_LIST_DEFAULT_SORT_BY = 'catalog/frontend/default_sort_by'
Data Fields inherited from Config
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
	_construct ()
	_getResource ()
Protected Member Functions inherited from Config
	_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
	$_attributeSetsById
	$_attributeSetsByName
	$_attributeGroupsById
	$_attributeGroupsByName
	$_productTypesById
	$_productAttributes
	$_usedInProductListing
	$_usedForSortBy
	$_storeId = null
	$_scopeConfig
	$_eavConfig
	$_storeManager
	$_setCollectionFactory
	$_groupCollectionFactory
	$_productTypeFactory
	$_configFactory
Protected Attributes inherited from Config
	$_entityTypeData
	$_attributeData
	$_attributeCodes
	$_objects
	$_references
	$_isCacheEnabled = null
	$_cache
	$_cacheState
	$_entityTypeFactory
	$entityTypeCollectionFactory
	$_universalFactory

Detailed Description

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

Definition at line 16 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,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Catalog\Model\ResourceModel\ConfigFactory	$configFactory,
		\Magento\Catalog\Model\Product\TypeFactory	$productTypeFactory,
		\Magento\Eav\Model\ResourceModel\Entity\Attribute\Group\CollectionFactory	$groupCollectionFactory,
		\Magento\Eav\Model\ResourceModel\Entity\Attribute\Set\CollectionFactory	$setCollectionFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Eav\Model\Config	$eavConfig,
		SerializerInterface	$serializer = null
	)

Constructor

Parameters

\Magento\Framework\App\CacheInterface	$cache
\Magento\Eav\Model\Entity\TypeFactory	$entityTypeFactory
\Magento\Eav\Model\ResourceModel\Entity\Type\CollectionFactory	$entityTypeCollectionFactory

Definition at line 139 of file Config.php.

      {
        $this->_scopeConfig = $scopeConfig;
        $this->_configFactory = $configFactory;
        $this->_productTypeFactory = $productTypeFactory;
        $this->_groupCollectionFactory = $groupCollectionFactory;
        $this->_setCollectionFactory = $setCollectionFactory;
        $this->_storeManager = $storeManager;
        $this->_eavConfig = $eavConfig;

        parent::__construct(
            $cache,
            $entityTypeFactory,
            $entityTypeCollectionFactory,
            $cacheState,
            $universalFactory,
            $serializer
        );
    }

Member Function Documentation

_construct()

_construct ( )

protected

Initialize resource model

Returns

void

Definition at line 177 of file Config.php.

    {
        $this->_init(\Magento\Catalog\Model\ResourceModel\Config::class);
    }

_getResource()

_getResource ( )

protected

Retrieve resource model

Returns

\Magento\Catalog\Model\ResourceModel\Config

Definition at line 420 of file Config.php.

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

getAttributeGroupId()

getAttributeGroupId	(		$attributeSetId,
			$name
	)

Parameters

float | int | string	$attributeSetId
string	$name

Returns

bool|string|int|float

Definition at line 318 of file Config.php.

    {
        if (is_numeric($name)) {
            return $name;
        }

        $this->loadAttributeGroups();

        if (!is_numeric($attributeSetId)) {
            $attributeSetId = $this->getAttributeSetId($attributeSetId);
        }
        $name = strtolower($name);
        return isset(
            $this->_attributeGroupsByName[$attributeSetId][$name]
        ) ? $this->_attributeGroupsByName[$attributeSetId][$name] : false;
    }

getAttributeGroupName()

getAttributeGroupName	(		$attributeSetId,
			$id
	)

Parameters

float | int | string	$attributeSetId
float | int | string	$id

Returns

bool|string

Definition at line 297 of file Config.php.

    {
        if (!is_numeric($id)) {
            return $id;
        }

        $this->loadAttributeGroups();

        if (!is_numeric($attributeSetId)) {
            $attributeSetId = $this->getAttributeSetId($attributeSetId);
        }
        return isset(
            $this->_attributeGroupsById[$attributeSetId][$id]
        ) ? $this->_attributeGroupsById[$attributeSetId][$id] : false;
    }

getAttributeSetId()

getAttributeSetId	(		$entityTypeId,
			$name = null
	)

Parameters

string | int | float	$entityTypeId
string | null	$name

Returns

false|string|int

Definition at line 254 of file Config.php.

    {
        if (is_numeric($name)) {
            return $name;
        }
        $this->loadAttributeSets();

        if (!is_numeric($entityTypeId)) {
            $entityTypeId = $this->getEntityType($entityTypeId)->getId();
        }
        $name = strtolower($name);
        return isset(
            $this->_attributeSetsByName[$entityTypeId][$name]
        ) ? $this->_attributeSetsByName[$entityTypeId][$name] : false;
    }

getAttributeSetName()

getAttributeSetName	(		$entityTypeId,
			$id
	)

Parameters

string | int | float	$entityTypeId
float | int	$id

Returns

false|string

Definition at line 234 of file Config.php.

    {
        if (!is_numeric($id)) {
            return $id;
        }
        $this->loadAttributeSets();

        if (!is_numeric($entityTypeId)) {
            $entityTypeId = $this->getEntityType($entityTypeId)->getId();
        }
        return isset(
            $this->_attributeSetsById[$entityTypeId][$id]
        ) ? $this->_attributeSetsById[$entityTypeId][$id] : false;
    }

getAttributesUsedForSortBy()

getAttributesUsedForSortBy

(

)

Retrieve Attributes array used for sort by

Returns

array

Definition at line 453 of file Config.php.

    {
        if ($this->_usedForSortBy === null) {
            $this->_usedForSortBy = [];
            $entityType = \Magento\Catalog\Model\Product::ENTITY;
            $attributesData = $this->_getResource()->getAttributesUsedForSortBy();
            $this->_eavConfig->importAttributesData($entityType, $attributesData);
            foreach ($attributesData as $attributeData) {
                $attributeCode = $attributeData['attribute_code'];
                $this->_usedForSortBy[$attributeCode] = $this->_eavConfig->getAttribute($entityType, $attributeCode);
            }
        }
        return $this->_usedForSortBy;
    }

getAttributesUsedInProductListing()

getAttributesUsedInProductListing

(

)

Retrieve Attributes used in product listing

Returns

array

Definition at line 430 of file Config.php.

    {
        if ($this->_usedInProductListing === null) {
            $this->_usedInProductListing = [];
            $entityType = \Magento\Catalog\Model\Product::ENTITY;
            $attributesData = $this->_getResource()->setStoreId($this->getStoreId())->getAttributesUsedInListing();
            $this->_eavConfig->importAttributesData($entityType, $attributesData);
            foreach ($attributesData as $attributeData) {
                $attributeCode = $attributeData['attribute_code'];
                $this->_usedInProductListing[$attributeCode] = $this->_eavConfig->getAttribute(
                    $entityType,
                    $attributeCode
                );
            }
        }
        return $this->_usedInProductListing;
    }

getAttributeUsedForSortByArray()

getAttributeUsedForSortByArray

(

)

Retrieve Attributes Used for Sort by as array key = code, value = name

Returns

array

Definition at line 474 of file Config.php.

    {
        $options = ['position' => __('Position')];
        foreach ($this->getAttributesUsedForSortBy() as $attribute) {
            /* @var $attribute \Magento\Eav\Model\Entity\Attribute\AbstractAttribute */
            $options[$attribute->getAttributeCode()] = $attribute->getStoreLabel();
        }

        return $options;
    }

getProductAttributes()

getProductAttributes

(

)

Load Product attributes

Returns

array

Definition at line 407 of file Config.php.

    {
        if ($this->_productAttributes === null) {
            $this->_productAttributes = array_keys($this->getAttributesUsedInProductListing());
        }
        return $this->_productAttributes;
    }

getProductListDefaultSortBy()

getProductListDefaultSortBy

(

$store = null

)

Retrieve Product List Default Sort By

Parameters

mixed

$store

Returns

string

Definition at line 491 of file Config.php.

    {
        return $this->_scopeConfig->getValue(
            self::XML_PATH_LIST_DEFAULT_SORT_BY,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $store
        );
    }

getProductTypeId()

getProductTypeId

(

$name

)

Parameters

string

$name

Returns

false|string

Definition at line 360 of file Config.php.

    {
        if (is_numeric($name)) {
            return $name;
        }

        $this->loadProductTypes();

        $name = strtolower($name);
        return isset($this->_productTypesByName[$name]) ? $this->_productTypesByName[$name] : false;
    }

getProductTypeName()

getProductTypeName

(

$id

)

Parameters

float | int | string

$id

Returns

false|string

Definition at line 376 of file Config.php.

    {
        if (!is_numeric($id)) {
            return $id;
        }

        $this->loadProductTypes();

        return $this->_productTypesById[$id] ?? false;
    }

getSourceOptionId()

getSourceOptionId	(		$source,
			$value
	)

Parameters

\Magento\Framework\DataObject	$source
string	$value

Returns

null|mixed

Definition at line 392 of file Config.php.

    {
        foreach ($source->getAllOptions() as $option) {
            if (strcasecmp($option['label'], $value) == 0 || $option['value'] == $value) {
                return $option['value'];
            }
        }
        return null;
    }

getStoreId()

getStoreId

(

)

Return store id, if is not set return current app store

Returns

integer

Definition at line 199 of file Config.php.

    {
        if ($this->_storeId === null) {
            return $this->_storeManager->getStore()->getId();
        }
        return $this->_storeId;
    }

loadAttributeGroups()

loadAttributeGroups

(

)

Returns

$this

Definition at line 273 of file Config.php.

    {
        if ($this->_attributeGroupsById) {
            return $this;
        }

        $attributeSetCollection = $this->_groupCollectionFactory->create()->load();

        $this->_attributeGroupsById = [];
        $this->_attributeGroupsByName = [];
        foreach ($attributeSetCollection as $id => $attributeGroup) {
            $attributeSetId = $attributeGroup->getAttributeSetId();
            $name = $attributeGroup->getAttributeGroupName();
            $this->_attributeGroupsById[$attributeSetId][$id] = $name;
            $this->_attributeGroupsByName[$attributeSetId][strtolower($name)] = $id;
        }
        return $this;
    }

loadAttributeSets()

loadAttributeSets

(

)

Returns

$this

Definition at line 210 of file Config.php.

    {
        if ($this->_attributeSetsById) {
            return $this;
        }

        $attributeSetCollection = $this->_setCollectionFactory->create()->load();

        $this->_attributeSetsById = [];
        $this->_attributeSetsByName = [];
        foreach ($attributeSetCollection as $id => $attributeSet) {
            $entityTypeId = $attributeSet->getEntityTypeId();
            $name = $attributeSet->getAttributeSetName();
            $this->_attributeSetsById[$entityTypeId][$id] = $name;
            $this->_attributeSetsByName[$entityTypeId][strtolower($name)] = $id;
        }
        return $this;
    }

loadProductTypes()

loadProductTypes

(

)

Returns

$this

Definition at line 338 of file Config.php.

    {
        if ($this->_productTypesById) {
            return $this;
        }

        $productTypeCollection = $this->_productTypeFactory->create()->getOptionArray();

        $this->_productTypesById = [];
        $this->_productTypesByName = [];
        foreach ($productTypeCollection as $id => $type) {
            $name = $type;
            $this->_productTypesById[$id] = $name;
            $this->_productTypesByName[strtolower($name)] = $id;
        }
        return $this;
    }

setStoreId()

setStoreId

(

$storeId

)

Set store id

Parameters

integer

$storeId

Returns

\Magento\Catalog\Model\Config

Definition at line 188 of file Config.php.

    {
        $this->_storeId = $storeId;
        return $this;
    }

Field Documentation

$_attributeGroupsById

$_attributeGroupsById

protected

Definition at line 33 of file Config.php.

$_attributeGroupsByName

$_attributeGroupsByName

protected

Definition at line 38 of file Config.php.

$_attributeSetsById

$_attributeSetsById

protected

Definition at line 23 of file Config.php.

$_attributeSetsByName

$_attributeSetsByName

protected

Definition at line 28 of file Config.php.

$_configFactory

$_configFactory

protected

Definition at line 118 of file Config.php.

$_eavConfig

$_eavConfig

protected

Definition at line 83 of file Config.php.

$_groupCollectionFactory

$_groupCollectionFactory

protected

Definition at line 104 of file Config.php.

$_productAttributes

$_productAttributes

protected

Definition at line 50 of file Config.php.

$_productTypeFactory

$_productTypeFactory

protected

Definition at line 111 of file Config.php.

$_productTypesById

$_productTypesById

protected

Definition at line 43 of file Config.php.

$_scopeConfig

$_scopeConfig

protected

Definition at line 76 of file Config.php.

$_setCollectionFactory

$_setCollectionFactory

protected

Definition at line 97 of file Config.php.

$_storeId

$_storeId = null

protected

Definition at line 69 of file Config.php.

$_storeManager

$_storeManager

protected

Definition at line 90 of file Config.php.

$_usedForSortBy

$_usedForSortBy

protected

Definition at line 64 of file Config.php.

$_usedInProductListing

$_usedInProductListing

protected

Definition at line 57 of file Config.php.

XML_PATH_LIST_DEFAULT_SORT_BY

const XML_PATH_LIST_DEFAULT_SORT_BY = 'catalog/frontend/default_sort_by'

Definition at line 18 of file Config.php.

---

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

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