Eav Class Reference

Inheritance diagram for Eav:

Public Member Functions
	__construct (LocatorInterface $locator, CatalogEavValidationRules $catalogEavValidationRules, Config $eavConfig, RequestInterface $request, GroupCollectionFactory $groupCollectionFactory, StoreManagerInterface $storeManager, FormElementMapper $formElementMapper, MetaPropertiesMapper $metaPropertiesMapper, ProductAttributeGroupRepositoryInterface $attributeGroupRepository, ProductAttributeRepositoryInterface $attributeRepository, SearchCriteriaBuilder $searchCriteriaBuilder, SortOrderBuilder $sortOrderBuilder, EavAttributeFactory $eavAttributeFactory, Translit $translitFilter, ArrayManager $arrayManager, ScopeOverriddenValue $scopeOverriddenValue, DataPersistorInterface $dataPersistor, $attributesToDisable=[], $attributesToEliminate=[], CompositeConfigProcessor $wysiwygConfigProcessor=null, ScopeConfigInterface $scopeConfig=null, AttributeCollectionFactory $attributeCollectionFactory=null)
	modifyMeta (array $meta)
	addContainerChildren (array $attributeContainer, ProductAttributeInterface $attribute, $groupCode, $sortOrder)
	getContainerChildren (ProductAttributeInterface $attribute, $groupCode, $sortOrder)
	setupAttributeMeta (ProductAttributeInterface $attribute, $groupCode, $sortOrder)
	setupAttributeContainerMeta (ProductAttributeInterface $attribute)
	setupAttributeData (ProductAttributeInterface $attribute)
Public Member Functions inherited from ModifierInterface
	modifyData (array $data)

Data Fields
const	SORT_ORDER_MULTIPLIER = 10
Data Fields inherited from AbstractModifier
const	FORM_NAME = 'product_form'
const	DATA_SOURCE_DEFAULT = 'product'
const	DATA_SCOPE_PRODUCT = 'data.product'
const	DEFAULT_GENERAL_PANEL = 'product-details'
const	GENERAL_PANEL_ORDER = 10
const	CONTAINER_PREFIX = 'container_'
const	META_CONFIG_PATH = '/arguments/data/config'

Protected Member Functions
	formatPrice ($value)
Protected Member Functions inherited from AbstractModifier
	getNextGroupSortOrder (array $meta, $groupCodes, $defaultSortOrder, $iteration=1)
	getNextAttributeSortOrder (array $meta, $attributeCodes, $defaultSortOrder, $iteration=1)
	startsWith ($haystack, $needle)
	getGeneralPanelName (array $meta)
	getFirstPanelCode (array $meta)
	getGroupCodeByField (array $meta, $field)
	formatPrice ($value)
	formatWeight ($value)

Protected Attributes
	$locator
	$eavConfig
	$catalogEavValidationRules
	$request
	$groupCollectionFactory
	$storeManager
	$formElementMapper
	$metaPropertiesMapper
	$attributeGroupRepository
	$searchCriteriaBuilder
	$attributeRepository
	$sortOrderBuilder
	$eavAttributeFactory
	$translitFilter
	$arrayManager
	$attributesToEliminate
	$dataPersistor

Detailed Description

Class Eav

@api

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

Since

101.0.0

Definition at line 48 of file Eav.php.

Constructor & Destructor Documentation

__construct()

__construct	(	LocatorInterface	$locator,
		CatalogEavValidationRules	$catalogEavValidationRules,
		Config	$eavConfig,
		RequestInterface	$request,
		GroupCollectionFactory	$groupCollectionFactory,
		StoreManagerInterface	$storeManager,
		FormElementMapper	$formElementMapper,
		MetaPropertiesMapper	$metaPropertiesMapper,
		ProductAttributeGroupRepositoryInterface	$attributeGroupRepository,
		ProductAttributeRepositoryInterface	$attributeRepository,
		SearchCriteriaBuilder	$searchCriteriaBuilder,
		SortOrderBuilder	$sortOrderBuilder,
		EavAttributeFactory	$eavAttributeFactory,
		Translit	$translitFilter,
		ArrayManager	$arrayManager,
		ScopeOverriddenValue	$scopeOverriddenValue,
		DataPersistorInterface	$dataPersistor,
			$attributesToDisable = [],
			$attributesToEliminate = [],
		CompositeConfigProcessor	$wysiwygConfigProcessor = null,
		ScopeConfigInterface	$scopeConfig = null,
		AttributeCollectionFactory	$attributeCollectionFactory = null
	)

Eav constructor.

Parameters

LocatorInterface	$locator
CatalogEavValidationRules	$catalogEavValidationRules
Config	$eavConfig
RequestInterface	$request
GroupCollectionFactory	$groupCollectionFactory
StoreManagerInterface	$storeManager
FormElementMapper	$formElementMapper
MetaPropertiesMapper	$metaPropertiesMapper
ProductAttributeGroupRepositoryInterface	$attributeGroupRepository
ProductAttributeRepositoryInterface	$attributeRepository
SearchCriteriaBuilder	$searchCriteriaBuilder
SortOrderBuilder	$sortOrderBuilder
EavAttributeFactory	$eavAttributeFactory
Translit	$translitFilter
ArrayManager	$arrayManager
ScopeOverriddenValue	$scopeOverriddenValue
DataPersistorInterface	$dataPersistor
array	$attributesToDisable
array	$attributesToEliminate
CompositeConfigProcessor | null	$wysiwygConfigProcessor
ScopeConfigInterface | null	$scopeConfig
AttributeCollectionFactory	$attributeCollectionFactory	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 241 of file Eav.php.

      {
        $this->locator = $locator;
        $this->catalogEavValidationRules = $catalogEavValidationRules;
        $this->eavConfig = $eavConfig;
        $this->request = $request;
        $this->groupCollectionFactory = $groupCollectionFactory;
        $this->storeManager = $storeManager;
        $this->formElementMapper = $formElementMapper;
        $this->metaPropertiesMapper = $metaPropertiesMapper;
        $this->attributeGroupRepository = $attributeGroupRepository;
        $this->searchCriteriaBuilder = $searchCriteriaBuilder;
        $this->attributeRepository = $attributeRepository;
        $this->sortOrderBuilder = $sortOrderBuilder;
        $this->eavAttributeFactory = $eavAttributeFactory;
        $this->translitFilter = $translitFilter;
        $this->arrayManager = $arrayManager;
        $this->scopeOverriddenValue = $scopeOverriddenValue;
        $this->dataPersistor = $dataPersistor;
        $this->attributesToDisable = $attributesToDisable;
        $this->attributesToEliminate = $attributesToEliminate;
        $this->wysiwygConfigProcessor = $wysiwygConfigProcessor ?: \Magento\Framework\App\ObjectManager::getInstance()
            ->get(CompositeConfigProcessor::class);
        $this->scopeConfig = $scopeConfig ?: \Magento\Framework\App\ObjectManager::getInstance()
        ->get(ScopeConfigInterface::class);
        $this->attributeCollectionFactory = $attributeCollectionFactory
            ?: \Magento\Framework\App\ObjectManager::getInstance()->get(AttributeCollectionFactory::class);
    }

Member Function Documentation

addContainerChildren()

addContainerChildren	(	array	$attributeContainer,
		ProductAttributeInterface	$attribute,
			$groupCode,
			$sortOrder
	)

Add container children

Parameters

array	$attributeContainer
ProductAttributeInterface	$attribute
string	$groupCode
int	$sortOrder

Returns

array @api

Since

101.0.0

Definition at line 363 of file Eav.php.

      {
        foreach ($this->getContainerChildren($attribute, $groupCode, $sortOrder) as $childCode => $child) {
            $attributeContainer['children'][$childCode] = $child;
        }

        $attributeContainer = $this->arrayManager->merge(
            ltrim(static::META_CONFIG_PATH, ArrayManager::DEFAULT_PATH_DELIMITER),
            $attributeContainer,
            [
                'sortOrder' => $sortOrder * self::SORT_ORDER_MULTIPLIER
            ]
        );

        return $attributeContainer;
    }

formatPrice()

formatPrice (   $value )

protected

Format price according to the locale of the currency

Parameters

mixed

$value

Returns

string

Since

101.0.0

Definition at line 1039 of file Eav.php.

    {
        if (!is_numeric($value)) {
            return null;
        }

        $store = $this->storeManager->getStore();
        $currency = $this->getLocaleCurrency()->getCurrency($store->getBaseCurrencyCode());
        $value = $currency->toCurrency($value, ['display' => \Magento\Framework\Currency::NO_SYMBOL]);

        return $value;
    }

getContainerChildren()

getContainerChildren	(	ProductAttributeInterface	$attribute,
			$groupCode,
			$sortOrder
	)

Retrieve container child fields

Parameters

ProductAttributeInterface	$attribute
string	$groupCode
int	$sortOrder

Returns

array @api

Since

101.0.0

Definition at line 394 of file Eav.php.

    {
        if (!($child = $this->setupAttributeMeta($attribute, $groupCode, $sortOrder))) {
            return [];
        }

        return [$attribute->getAttributeCode() => $child];
    }

modifyMeta()

modifyMeta

(

array

$meta

)

Parameters

array

$meta

Returns

array

Since

100.1.0

Since

101.0.0

Implements ModifierInterface.

Definition at line 296 of file Eav.php.

    {
        $sortOrder = 0;

        foreach ($this->getGroups() as $groupCode => $group) {
            $attributes = !empty($this->getAttributes()[$groupCode]) ? $this->getAttributes()[$groupCode] : [];

            if ($attributes) {
                $meta[$groupCode]['children'] = $this->getAttributesMeta($attributes, $groupCode);
                $meta[$groupCode]['arguments']['data']['config']['componentType'] = Fieldset::NAME;
                $meta[$groupCode]['arguments']['data']['config']['label'] = __($group->getAttributeGroupName());
                $meta[$groupCode]['arguments']['data']['config']['collapsible'] = true;
                $meta[$groupCode]['arguments']['data']['config']['dataScope'] = self::DATA_SCOPE_PRODUCT;
                $meta[$groupCode]['arguments']['data']['config']['sortOrder'] =
                    $sortOrder * self::SORT_ORDER_MULTIPLIER;
            }

            $sortOrder++;
        }

        return $meta;
    }

setupAttributeContainerMeta()

setupAttributeContainerMeta

(

ProductAttributeInterface

$attribute

)

Setup attribute container meta

Parameters

ProductAttributeInterface

$attribute

Returns

array @api

Since

101.0.0

Definition at line 778 of file Eav.php.

    {
        $containerMeta = $this->arrayManager->set(
            'arguments/data/config',
            [],
            [
                'formElement' => 'container',
                'componentType' => 'container',
                'breakLine' => false,
                'label' => $attribute->getDefaultFrontendLabel(),
                'required' => $attribute->getIsRequired(),
            ]
        );

        if ($attribute->getIsWysiwygEnabled()) {
            $containerMeta = $this->arrayManager->merge(
                'arguments/data/config',
                $containerMeta,
                [
                    'component' => 'Magento_Ui/js/form/components/group'
                ]
            );
        }

        return $containerMeta;
    }

setupAttributeData()

setupAttributeData

(

ProductAttributeInterface

$attribute

)

Setup attribute data

Parameters

ProductAttributeInterface

$attribute

Returns

mixed|null @api

Since

101.0.0

Definition at line 813 of file Eav.php.

    {
        $product = $this->locator->getProduct();
        $productId = $product->getId();
        $prevSetId = $this->getPreviousSetId();
        $notUsed = !$prevSetId
            || ($prevSetId && !in_array($attribute->getAttributeCode(), $this->getPreviousSetAttributes()));

        if ($productId && $notUsed) {
            return $this->getValue($attribute);
        }

        return null;
    }

setupAttributeMeta()

setupAttributeMeta	(	ProductAttributeInterface	$attribute,
			$groupCode,
			$sortOrder
	)

Initial meta setup

Parameters

ProductAttributeInterface	$attribute
string	$groupCode
int	$sortOrder

Returns

array

Exceptions

Definition at line 630 of file Eav.php.

    {
        $configPath = ltrim(static::META_CONFIG_PATH, ArrayManager::DEFAULT_PATH_DELIMITER);
        $attributeCode = $attribute->getAttributeCode();
        $meta = $this->arrayManager->set($configPath, [], [
            'dataType' => $attribute->getFrontendInput(),
            'formElement' => $this->getFormElementsMapValue($attribute->getFrontendInput()),
            'visible' => $attribute->getIsVisible(),
            'required' => $attribute->getIsRequired(),
            'notice' => $attribute->getNote() === null ? null : __($attribute->getNote()),
            'default' => (!$this->isProductExists()) ? $this->getAttributeDefaultValue($attribute) : null,
            'label' => __($attribute->getDefaultFrontendLabel()),
            'code' => $attributeCode,
            'source' => $groupCode,
            'scopeLabel' => $this->getScopeLabel($attribute),
            'globalScope' => $this->isScopeGlobal($attribute),
            'sortOrder' => $sortOrder * self::SORT_ORDER_MULTIPLIER,
        ]);

        // TODO: Refactor to $attribute->getOptions() when MAGETWO-48289 is done
        $attributeModel = $this->getAttributeModel($attribute);
        if ($attributeModel->usesSource()) {
            $options = $attributeModel->getSource()->getAllOptions();
            $meta = $this->arrayManager->merge($configPath, $meta, [
                'options' => $this->convertOptionsValueToString($options),
            ]);
        }

        if ($this->canDisplayUseDefault($attribute)) {
            $meta = $this->arrayManager->merge($configPath, $meta, [
                'service' => [
                    'template' => 'ui/form/element/helper/service',
                ]
            ]);
        }

        if (!$this->arrayManager->exists($configPath . '/componentType', $meta)) {
            $meta = $this->arrayManager->merge($configPath, $meta, [
                'componentType' => Field::NAME,
            ]);
        }

        $product = $this->locator->getProduct();
        if (in_array($attributeCode, $this->attributesToDisable)
            || $product->isLockedAttribute($attributeCode)) {
            $meta = $this->arrayManager->merge($configPath, $meta, [
                'disabled' => true,
            ]);
        }

        // TODO: getAttributeModel() should not be used when MAGETWO-48284 is complete
        $childData = $this->arrayManager->get($configPath, $meta, []);
        if (($rules = $this->catalogEavValidationRules->build($this->getAttributeModel($attribute), $childData))) {
            $meta = $this->arrayManager->merge($configPath, $meta, [
                'validation' => $rules,
            ]);
        }

        $meta = $this->addUseDefaultValueCheckbox($attribute, $meta);

        switch ($attribute->getFrontendInput()) {
            case 'boolean':
                $meta = $this->customizeCheckbox($attribute, $meta);
                break;
            case 'textarea':
                $meta = $this->customizeWysiwyg($attribute, $meta);
                break;
            case 'price':
                $meta = $this->customizePriceAttribute($attribute, $meta);
                break;
            case 'gallery':
                // Gallery attribute is being handled by "Images And Videos" section
                $meta = [];
                break;
        }

        return $meta;
    }

Field Documentation

$arrayManager

$arrayManager

protected

Definition at line 140 of file Eav.php.

$attributeGroupRepository

$attributeGroupRepository

protected

Definition at line 104 of file Eav.php.

$attributeRepository

$attributeRepository

protected

Definition at line 116 of file Eav.php.

$attributesToEliminate

$attributesToEliminate

protected

Definition at line 156 of file Eav.php.

$catalogEavValidationRules

$catalogEavValidationRules

protected

Definition at line 68 of file Eav.php.

$dataPersistor

$dataPersistor

protected

Definition at line 162 of file Eav.php.

$eavAttributeFactory

$eavAttributeFactory

protected

Definition at line 128 of file Eav.php.

$eavConfig

$eavConfig

protected

Definition at line 62 of file Eav.php.

$formElementMapper

$formElementMapper

protected

Definition at line 92 of file Eav.php.

$groupCollectionFactory

$groupCollectionFactory

protected

Definition at line 80 of file Eav.php.

$locator

$locator

protected

Definition at line 56 of file Eav.php.

$metaPropertiesMapper

$metaPropertiesMapper

protected

Definition at line 98 of file Eav.php.

$request

$request

protected

Definition at line 74 of file Eav.php.

$searchCriteriaBuilder

$searchCriteriaBuilder

protected

Definition at line 110 of file Eav.php.

$sortOrderBuilder

$sortOrderBuilder

protected

Definition at line 122 of file Eav.php.

$storeManager

$storeManager

protected

Definition at line 86 of file Eav.php.

$translitFilter

$translitFilter

protected

Definition at line 134 of file Eav.php.

SORT_ORDER_MULTIPLIER

const SORT_ORDER_MULTIPLIER = 10

Definition at line 50 of file Eav.php.

---

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

• vendor/magento/module-catalog/Ui/DataProvider/Product/Form/Modifier/Eav.php