Inheritance diagram for DataProvider:

Public Member Functions
	__construct ( $name, $primaryFieldName, $requestFieldName, EavValidationRules $eavValidationRules, CategoryCollectionFactory $categoryCollectionFactory, StoreManagerInterface $storeManager, \Magento\Framework\Registry $registry, Config $eavConfig, \Magento\Framework\App\RequestInterface $request, CategoryFactory $categoryFactory, array $meta=[], array $data=[], PoolInterface $pool=null)

	getMeta ()

	prepareMeta ($meta)

	getData ()

	getAttributesMeta (Type $entityType)

	getCurrentCategory ()

	getScopeLabel (EavAttribute $attribute)

	getDefaultMetaData ($result)

Public Member Functions inherited from ModifierPoolDataProvider
	__construct ( $name, $primaryFieldName, $requestFieldName, array $meta=[], array $data=[], PoolInterface $pool=null)

	getData ()

Public Member Functions inherited from AbstractDataProvider
	__construct ( $name, $primaryFieldName, $requestFieldName, array $meta=[], array $data=[])

	getCollection ()

	getName ()

	getPrimaryFieldName ()

	getRequestFieldName ()

	getMeta ()

	getFieldSetMetaInfo ($fieldSetName)

	getFieldsMetaInfo ($fieldSetName)

	getFieldMetaInfo ($fieldSetName, $fieldName)

	addFilter (\Magento\Framework\Api\Filter $filter)

	getSearchCriteria ()

	getSearchResult ()

	addField ($field, $alias=null)

	addOrder ($field, $direction)

	setLimit ($offset, $size)

	removeField ($field, $isAlias=false)

	removeAllFields ()

	getData ()

	count ()

	getConfigData ()

	setConfigData ($config)

	getAllIds ()

Public Member Functions inherited from DataProviderInterface
	addFilter (\Magento\Framework\Api\Filter $filter)

Protected Member Functions
	addUseConfigSettings ($categoryData)

	addUseDefaultSettings ($category, $categoryData)

	filterFields ($categoryData)

	getFieldsMap ()

Protected Attributes
	$requestScopeFieldName = 'store'

	$loadedData

	$metaProperties

	$formElement

	$elementsWithUseConfigSetting

	$ignoreFields

	$eavValidationRules

	$registry

	$request

Protected Attributes inherited from AbstractDataProvider
	$name

	$primaryFieldName

	$requestFieldName

	$meta = []

	$data = []

	$collection

Detailed Description

Class DataProvider

@api

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 101.0.0

Definition at line 37 of file DataProvider.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(		$name,
			$primaryFieldName,
			$requestFieldName,
		EavValidationRules	$eavValidationRules,
		CategoryCollectionFactory	$categoryCollectionFactory,
		StoreManagerInterface	$storeManager,
		\Magento\Framework\Registry	$registry,
		Config	$eavConfig,
		\Magento\Framework\App\RequestInterface	$request,
		CategoryFactory	$categoryFactory,
		array	$meta = `[]`,
		array	$data = `[]`,
		PoolInterface	$pool = `null`
	)

DataProvider constructor

Parameters

string	$name
string	$primaryFieldName
string	$requestFieldName
EavValidationRules	$eavValidationRules
CategoryCollectionFactory	$categoryCollectionFactory
StoreManagerInterface	$storeManager
\Magento\Framework\Registry	$registry
Config	$eavConfig
\Magento\Framework\App\RequestInterface	$request
CategoryFactory	$categoryFactory
array	$meta
array	$data
PoolInterface \| null	$pool	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 167 of file DataProvider.php.

       {
         $this->eavValidationRules = $eavValidationRules;
         $this->collection = $categoryCollectionFactory->create();
         $this->collection->addAttributeToSelect('*');
         $this->eavConfig = $eavConfig;
         $this->registry = $registry;
         $this->storeManager = $storeManager;
         $this->request = $request;
         $this->categoryFactory = $categoryFactory;
 
         parent::__construct($name, $primaryFieldName, $requestFieldName, $meta, $data, $pool);
     }

Member Function Documentation

◆ addUseConfigSettings()

addUseConfigSettings ( $categoryData )

protected

Add use config settings

Parameters

array $categoryData

Returns: array

Since: 101.0.0

Definition at line 373 of file DataProvider.php.

     {
         foreach ($this->elementsWithUseConfigSetting as $elementsWithUseConfigSetting) {
             if (!isset($categoryData['use_config'][$elementsWithUseConfigSetting])) {
                 if (!isset($categoryData[$elementsWithUseConfigSetting]) ||
                     ($categoryData[$elementsWithUseConfigSetting] == '')
                 ) {
                     $categoryData['use_config'][$elementsWithUseConfigSetting] = true;
                 } else {
                     $categoryData['use_config'][$elementsWithUseConfigSetting] = false;
                 }
             }
         }
         return $categoryData;
     }

◆ addUseDefaultSettings()

addUseDefaultSettings	(	$category,
		$categoryData
	)

protected

Add use default settings

Parameters

\Magento\Catalog\Model\Category	$category
array	$categoryData

Returns: array

Deprecated:: 102.0.0

Since: 101.0.0

Definition at line 398 of file DataProvider.php.

     {
         if ($category->getExistsStoreValueFlag('url_key') ||
             $category->getStoreId() === Store::DEFAULT_STORE_ID
         ) {
             $categoryData['use_default']['url_key'] = false;
         } else {
             $categoryData['use_default']['url_key'] = true;
         }
 
         return $categoryData;
     }

◆ filterFields()

filterFields ( $categoryData )

protected

Filter fields

Parameters

array $categoryData

Returns: array

Since: 101.0.0

Definition at line 472 of file DataProvider.php.

     {
         return array_diff_key($categoryData, array_flip($this->ignoreFields));
     }

◆ getAttributesMeta()

getAttributesMeta ( Type $entityType )

Get attributes meta

Parameters

Type $entityType

Returns: array

Exceptions

Definition at line 325 of file DataProvider.php.

     {
         $meta = [];
         $attributes = $entityType->getAttributeCollection();
         /* @var EavAttribute $attribute */
         foreach ($attributes as $attribute) {
             $code = $attribute->getAttributeCode();
             // use getDataUsingMethod, since some getters are defined and apply additional processing of returning value
             foreach ($this->metaProperties as $metaName => $origName) {
                 $value = $attribute->getDataUsingMethod($origName);
                 $meta[$code][$metaName] = $value;
                 if ('frontend_input' === $origName) {
                     $meta[$code]['formElement'] = isset($this->formElement[$value])
                         ? $this->formElement[$value]
                         : $value;
                 }
                 if ($attribute->usesSource()) {
                     $meta[$code]['options'] = $attribute->getSource()->getAllOptions();
                 }
             }
 
             $rules = $this->eavValidationRules->build($attribute, $meta[$code]);
             if (!empty($rules)) {
                 $meta[$code]['validation'] = $rules;
             }
 
             $meta[$code]['scopeLabel'] = $this->getScopeLabel($attribute);
             $meta[$code]['componentType'] = Field::NAME;
         }
 
         $result = [];
         foreach ($meta as $key => $item) {
             $result[$key] = $item;
             $result[$key]['sortOrder'] = 0;
         }
 
         $result = $this->getDefaultMetaData($result);
 
         return $result;
     }

◆ getCurrentCategory()

getCurrentCategory ( )

Get current category

Returns: Category

Exceptions

NoSuchEntityException

Since: 101.0.0

Definition at line 418 of file DataProvider.php.

     {
         $category = $this->registry->registry('category');
         if ($category) {
             return $category;
         }
         $requestId = $this->request->getParam($this->requestFieldName);
         $requestScope = $this->request->getParam($this->requestScopeFieldName, Store::DEFAULT_STORE_ID);
         if ($requestId) {
             $category = $this->categoryFactory->create();
             $category->setStoreId($requestScope);
             $category->load($requestId);
             if (!$category->getId()) {
                 throw NoSuchEntityException::singleField('id', $requestId);
             }
         }
         return $category;
     }

◆ getData()

getData ( )

Get data

Returns: array

Since: 101.0.0

Implements DataProviderInterface.

Definition at line 297 of file DataProvider.php.

     {
         if (isset($this->loadedData)) {
             return $this->loadedData;
         }
         $category = $this->getCurrentCategory();
         if ($category) {
             $categoryData = $category->getData();
             $categoryData = $this->addUseConfigSettings($categoryData);
             $categoryData = $this->filterFields($categoryData);
             $categoryData = $this->convertValues($category, $categoryData);
 
             $this->loadedData[$category->getId()] = $categoryData;
         }
 
         return $this->loadedData;
     }

◆ getDefaultMetaData()

getDefaultMetaData ( $result )

Category's fields default values

Parameters

array $result

Returns: array

Since: 101.0.0

Definition at line 525 of file DataProvider.php.

     {
         $result['parent']['default'] = (int)$this->request->getParam('parent');
         $result['use_config.available_sort_by']['default'] = true;
         $result['use_config.default_sort_by']['default'] = true;
         $result['use_config.filter_price_range']['default'] = true;
 
         return $result;
     }

◆ getFieldsMap()

getFieldsMap ( )

protected

Returns: array

Since: 101.0.0

Definition at line 539 of file DataProvider.php.

     {
         return [
             'general' => [
                     'parent',
                     'path',
                     'is_active',
                     'include_in_menu',
                     'name',
                 ],
             'content' => [
                     'image',
                     'description',
                     'landing_page',
                 ],
             'display_settings' => [
                     'display_mode',
                     'is_anchor',
                     'available_sort_by',
                     'use_config.available_sort_by',
                     'default_sort_by',
                     'use_config.default_sort_by',
                     'filter_price_range',
                     'use_config.filter_price_range',
                 ],
             'search_engine_optimization' => [
                     'url_key',
                     'url_key_create_redirect',
                     'url_key_group',
                     'meta_title',
                     'meta_keywords',
                     'meta_description',
                 ],
             'assign_products' => [
                 ],
             'design' => [
                     'custom_use_parent_settings',
                     'custom_apply_to_products',
                     'custom_design',
                     'page_layout',
                     'custom_layout_update',
                 ],
             'schedule_design_update' => [
                     'custom_design_from',
                     'custom_design_to',
                 ],
             'category_view_optimization' => [
                 ],
             'category_permissions' => [
                 ],
         ];
     }

◆ getMeta()

getMeta ( )

Returns: array

Since: 102.0.0

Implements DataProviderInterface.

Definition at line 198 of file DataProvider.php.

     {
         $meta = parent::getMeta();
         $meta = $this->prepareMeta($meta);
 
         $category = $this->getCurrentCategory();
 
         if ($category) {
             $meta = $this->addUseDefaultValueCheckbox($category, $meta);
         }
         // Default and custom settings
         return $meta;
     }

◆ getScopeLabel()

getScopeLabel ( EavAttribute $attribute )

Retrieve label of attribute scope

GLOBAL | WEBSITE | STORE

Parameters

EavAttribute $attribute

Returns: string

Since: 101.0.0

Definition at line 446 of file DataProvider.php.

     {
         $html = '';
         if (!$attribute || $this->storeManager->isSingleStoreMode()
             || $attribute->getFrontendInput() === AttributeInterface::FRONTEND_INPUT
         ) {
             return $html;
         }
         if ($attribute->isScopeGlobal()) {
             $html .= __('[GLOBAL]');
         } elseif ($attribute->isScopeWebsite()) {
             $html .= __('[WEBSITE]');
         } elseif ($attribute->isScopeStore()) {
             $html .= __('[STORE VIEW]');
         }
 
         return $html;
     }

◆ prepareMeta()

prepareMeta ( $meta )

Prepare meta data

Parameters

array $meta

Returns: array

Since: 101.0.0

Definition at line 261 of file DataProvider.php.

     {
         $meta = array_replace_recursive($meta, $this->prepareFieldsMeta(
             $this->getFieldsMap(),
             $this->getAttributesMeta($this->eavConfig->getEntityType('catalog_category'))
         ));
 
         return $meta;
     }

Field Documentation

◆ $eavValidationRules

$eavValidationRules

protected

Definition at line 105 of file DataProvider.php.

◆ $elementsWithUseConfigSetting

$elementsWithUseConfigSetting

protected

Initial value:

= [
        'available_sort_by',
        'default_sort_by',
        'filter_price_range',
    ]

Definition at line 84 of file DataProvider.php.

◆ $formElement

$formElement

protected

Initial value:

= [
        'text' => 'input',
        'boolean' => 'checkbox',
    ]

Definition at line 73 of file DataProvider.php.

◆ $ignoreFields

$ignoreFields

protected

Initial value:

= [
        'products_position',
        'position'
    ]

Definition at line 96 of file DataProvider.php.

◆ $loadedData

$loadedData

protected

Definition at line 49 of file DataProvider.php.

◆ $metaProperties

$metaProperties

protected

Initial value:

= [
        'dataType' => 'frontend_input',
        'visible' => 'is_visible',
        'required' => 'is_required',
        'label' => 'frontend_label',
        'sortOrder' => 'sort_order',
        'notice' => 'note',
        'default' => 'default_value',
        'size' => 'multiline_count',
    ]

Definition at line 56 of file DataProvider.php.

◆ $registry

$registry

protected

Definition at line 111 of file DataProvider.php.

◆ $request

$request

protected

Definition at line 117 of file DataProvider.php.

◆ $requestScopeFieldName

$requestScopeFieldName = 'store'

protected

Definition at line 43 of file DataProvider.php.

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

vendor/magento/module-catalog/Model/Category/DataProvider.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addUseConfigSettings()

◆ addUseDefaultSettings()

◆ filterFields()

◆ getAttributesMeta()

◆ getCurrentCategory()

◆ getData()

◆ getDefaultMetaData()

◆ getFieldsMap()

◆ getMeta()

◆ getScopeLabel()

◆ prepareMeta()

Field Documentation

◆ $eavValidationRules

◆ $elementsWithUseConfigSetting

◆ $formElement

◆ $ignoreFields

◆ $loadedData

◆ $metaProperties

◆ $registry

◆ $request

◆ $requestScopeFieldName