Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Eav\Model\Entity\Attribute\Config $attributeConfig, \Magento\Eav\Model\Config $eavConfig)
	getFrontendClasses ($entityTypeCode)
	getAttributeLockedFields ($entityTypeCode)
	getInputTypesValidatorData ()
	getAttributeMetadata ($entityTypeCode, $attributeCode)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	XML_PATH_VALIDATOR_DATA_INPUT_TYPES = 'general/validator_data/input_types'

Protected Member Functions
	_getDefaultFrontendClasses ()
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Protected Attributes
	$_attributesLockedFields = []
	$_entityTypeFrontendClasses = []
	$_attributeConfig
	$_eavConfig
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Detailed Description

Eav data helper

Definition at line 12 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Eav\Model\Entity\Attribute\Config	$attributeConfig,
		\Magento\Eav\Model\Config	$eavConfig
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Eav\Model\Entity\Attribute\Config	$attributeConfig
\Magento\Eav\Model\Config	$eavConfig	@codeCoverageIgnore

Definition at line 47 of file Data.php.

      {
        $this->_attributeConfig = $attributeConfig;
        $this->_eavConfig = $eavConfig;
        parent::__construct($context);
    }

Member Function Documentation

_getDefaultFrontendClasses()

_getDefaultFrontendClasses ( )

protected

Return default frontend classes value label array

Returns

array

Definition at line 62 of file Data.php.

    {
        return [
            ['value' => '', 'label' => __('None')],
            ['value' => 'validate-number', 'label' => __('Decimal Number')],
            ['value' => 'validate-digits', 'label' => __('Integer Number')],
            ['value' => 'validate-email', 'label' => __('Email')],
            ['value' => 'validate-url', 'label' => __('URL')],
            ['value' => 'validate-alpha', 'label' => __('Letters')],
            ['value' => 'validate-alphanum', 'label' => __('Letters (a-z, A-Z) or Numbers (0-9)')]
        ];
    }

getAttributeLockedFields()

getAttributeLockedFields

(

$entityTypeCode

)

Retrieve attributes locked fields to edit

Parameters

string

$entityTypeCode

Returns

array

Definition at line 98 of file Data.php.

    {
        if (!$entityTypeCode) {
            return [];
        }
        if (isset($this->_attributesLockedFields[$entityTypeCode])) {
            return $this->_attributesLockedFields[$entityTypeCode];
        }
        $attributesLockedFields = $this->_attributeConfig->getEntityAttributesLockedFields($entityTypeCode);
        if (count($attributesLockedFields)) {
            $this->_attributesLockedFields[$entityTypeCode] = $attributesLockedFields;
            return $this->_attributesLockedFields[$entityTypeCode];
        }
        return [];
    }

getAttributeMetadata()

getAttributeMetadata	(		$entityTypeCode,
			$attributeCode
	)

Retrieve attribute metadata.

Parameters

string	$entityTypeCode
string	$attributeCode

Returns

array

[
     'entity_type_id' => $entityTypeId,
     'attribute_id' => $attributeId,
     'attribute_table' => $attributeTable
     'backend_type' => $backendType
]

Definition at line 139 of file Data.php.

    {
        $attribute = $this->_eavConfig->getAttribute($entityTypeCode, $attributeCode);
        return [
            'entity_type_id' => $attribute->getEntityTypeId(),
            'attribute_id' => $attribute->getAttributeId(),
            'attribute_table' => $attribute->getBackend()->getTable(),
            'backend_type' => $attribute->getBackendType()
        ];
    }

getFrontendClasses()

getFrontendClasses

(

$entityTypeCode

)

Return merged default and entity type frontend classes value label array

Parameters

string

$entityTypeCode

Returns

array

Definition at line 81 of file Data.php.

    {
        $_defaultClasses = $this->_getDefaultFrontendClasses();

        if (isset($this->_entityTypeFrontendClasses[$entityTypeCode])) {
            return array_merge($_defaultClasses, $this->_entityTypeFrontendClasses[$entityTypeCode]);
        }

        return $_defaultClasses;
    }

getInputTypesValidatorData()

getInputTypesValidatorData

(

)

Get input types validator data

Returns

array

Definition at line 119 of file Data.php.

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

Field Documentation

$_attributeConfig

$_attributeConfig

protected

Definition at line 34 of file Data.php.

$_attributesLockedFields

$_attributesLockedFields = []

protected

Definition at line 24 of file Data.php.

$_eavConfig

$_eavConfig

protected

Definition at line 39 of file Data.php.

$_entityTypeFrontendClasses

$_entityTypeFrontendClasses = []

protected

Definition at line 29 of file Data.php.

XML_PATH_VALIDATOR_DATA_INPUT_TYPES

const XML_PATH_VALIDATOR_DATA_INPUT_TYPES = 'general/validator_data/input_types'

Definition at line 19 of file Data.php.

---

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

• vendor/magento/module-eav/Helper/Data.php