Inheritance diagram for ConfigurablePanel:

Public Member Functions
	__construct (LocatorInterface $locator, UrlInterface $urlBuilder, $formName, $dataScopeName, $dataSourceName, $associatedListingPrefix='')

	modifyData (array $data)

	modifyMeta (array $meta)

Data Fields
const	GROUP_CONFIGURABLE = 'configurable'

const	ASSOCIATED_PRODUCT_MODAL = 'configurable_associated_product_modal'

const	ASSOCIATED_PRODUCT_LISTING = 'configurable_associated_product_listing'

const	CONFIGURABLE_MATRIX = 'configurable-matrix'

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
	getPanelChildren ()

	getButtonSet ()

	getGrid ()

	getRows ()

	getColumn ( $name, \Magento\Framework\Phrase $label, $editConfig=[], $textConfig=[])

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)

Detailed Description

Data provider for Configurable panel @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 21 of file ConfigurablePanel.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	LocatorInterface	$locator,
		UrlInterface	$urlBuilder,
			$formName,
			$dataScopeName,
			$dataSourceName,
			$associatedListingPrefix = `''`
	)

Parameters

LocatorInterface	$locator
UrlInterface	$urlBuilder
string	$formName
string	$dataScopeName
string	$dataSourceName
string	$associatedListingPrefix

Definition at line 76 of file ConfigurablePanel.php.

       {
         $this->locator = $locator;
         $this->urlBuilder = $urlBuilder;
         $this->formName = $formName;
         $this->dataScopeName = $dataScopeName;
         $this->dataSourceName = $dataSourceName;
         $this->associatedListingPrefix = $associatedListingPrefix;
     }

Member Function Documentation

◆ getButtonSet()

getButtonSet ( )

protected

Returns Buttons Set configuration

Returns: array

Definition at line 266 of file ConfigurablePanel.php.

     {
         return [
             'arguments' => [
                 'data' => [
                     'config' => [
                         'component' => 'Magento_ConfigurableProduct/js/components/container-configurable-handler',
                         'formElement' => 'container',
                         'componentType' => 'container',
                         'label' => false,
                         'content1' => __(
                             'Configurable products allow customers to choose options '
                             . '(Ex: shirt color). You need to create a simple product for each '
                             . 'configuration (Ex: a product for each color).'
                         ),
                         'content2' => __(
                             'Configurations cannot be created for a standard product with downloadable files. '
                             . 'To create configurations, first remove all downloadable files.'
                         ),
                         'template' => 'ui/form/components/complex',
                         'createConfigurableButton' => 'ns = ${ $.ns }, index = create_configurable_products_button',
                     ],
                 ],
             ],
             'children' => [
                 'add_products_manually_button' => [
                     'arguments' => [
                         'data' => [
                             'config' => [
                                 'formElement' => 'container',
                                 'componentType' => 'container',
                                 'component' => 'Magento_Ui/js/form/components/button',
                                 'displayAsLink' => true,
                                 'actions' => [
                                     [
                                         'targetName' => 'ns=' . $this->formName . ', index='
                                             . static::ASSOCIATED_PRODUCT_MODAL,
                                         'actionName' => 'openModal',
                                     ],
                                     [
                                         'targetName' => 'ns=' . $this->associatedListingPrefix
                                             . static::ASSOCIATED_PRODUCT_LISTING
                                             . ', index=' . static::ASSOCIATED_PRODUCT_LISTING,
                                         'actionName' => 'showGridAssignProduct',
                                     ],
                                 ],
                                 'title' => __('Add Products Manually'),
                                 'sortOrder' => 10,
                                 'imports' => [
                                     'visible' => 'ns = ${ $.ns }, index = '
                                         . ConfigurablePanel::CONFIGURABLE_MATRIX . ':isShowAddProductButton',
                                 ],
                             ],
                         ],
                     ],
                 ],
                 'create_configurable_products_button' => [
                     'arguments' => [
                         'data' => [
                             'config' => [
                                 'formElement' => 'container',
                                 'componentType' => 'container',
                                 'component' => 'Magento_Ui/js/form/components/button',
                                 'actions' => [
                                     [
                                         'targetName' =>
                                             $this->dataScopeName . '.configurableModal',
                                         'actionName' => 'trigger',
                                         'params' => ['active', true],
                                     ],
                                     [
                                         'targetName' =>
                                             $this->dataScopeName . '.configurableModal',
                                         'actionName' => 'openModal',
                                     ],
                                 ],
                                 'title' => __('Create Configurations'),
                                 'sortOrder' => 20,
                             ],
                         ],
                     ],
                 ],
             ],
         ];
     }

◆ getColumn()

getColumn	(		$name,
		\Magento\Framework\Phrase	$label,
			$editConfig = `[]`,
			$textConfig = `[]`
	)

protected

Get configuration of column

Parameters

string	$name
\Magento\Framework\Phrase	$label
array	$editConfig
array	$textConfig

Returns: array

Definition at line 556 of file ConfigurablePanel.php.

       {
         $fieldEdit['arguments']['data']['config'] = [
             'dataType' => Form\Element\DataType\Number::NAME,
             'formElement' => Form\Element\Input::NAME,
             'componentType' => Form\Field::NAME,
             'dataScope' => $name,
             'fit' => true,
             'visibleIfCanEdit' => true,
             'imports' => [
                 'visible' => '${$.provider}:${$.parentScope}.canEdit'
             ],
         ];
         $fieldText['arguments']['data']['config'] = [
             'componentType' => Form\Field::NAME,
             'formElement' => Form\Element\Input::NAME,
             'elementTmpl' => 'Magento_ConfigurableProduct/components/cell-html',
             'dataType' => Form\Element\DataType\Text::NAME,
             'dataScope' => $name,
             'visibleIfCanEdit' => false,
             'imports' => [
                 'visible' => '!${$.provider}:${$.parentScope}.canEdit'
             ],
         ];
         $fieldEdit['arguments']['data']['config'] = array_replace_recursive(
             $fieldEdit['arguments']['data']['config'],
             $editConfig
         );
         $fieldText['arguments']['data']['config'] = array_replace_recursive(
             $fieldText['arguments']['data']['config'],
             $textConfig
         );
         $container['arguments']['data']['config'] = [
             'componentType' => Container::NAME,
             'formElement' => Container::NAME,
             'component' => 'Magento_Ui/js/form/components/group',
             'label' => $label,
             'dataScope' => '',
         ];
         $container['children'] = [
             $name . '_edit' => $fieldEdit,
             $name . '_text' => $fieldText,
         ];
 
         return $container;
     }

◆ getGrid()

getGrid ( )

protected

Returns dynamic rows configuration

Returns: array

Definition at line 357 of file ConfigurablePanel.php.

     {
         return [
             'arguments' => [
                 'data' => [
                     'config' => [
                         'additionalClasses' => 'admin__field-wide',
                         'componentType' => DynamicRows::NAME,
                         'dndConfig' => [
                             'enabled' => false,
                         ],
                         'label' => __('Current Variations'),
                         'renderDefaultRecord' => false,
                         'template' => 'ui/dynamic-rows/templates/grid',
                         'component' => 'Magento_ConfigurableProduct/js/components/dynamic-rows-configurable',
                         'addButton' => false,
                         'isEmpty' => true,
                         'itemTemplate' => 'record',
                         'dataScope' => 'data',
                         'dataProviderFromGrid' => $this->associatedListingPrefix . static::ASSOCIATED_PRODUCT_LISTING,
                         'dataProviderChangeFromGrid' => 'change_product',
                         'dataProviderFromWizard' => 'variations',
                         'map' => [
                             'id' => 'entity_id',
                             'product_link' => 'product_link',
                             'name' => 'name',
                             'sku' => 'sku',
                             'price' => 'price_number',
                             'price_string' => 'price',
                             'price_currency' => 'price_currency',
                             'qty' => 'qty',
                             'weight' => 'weight',
                             'thumbnail_image' => 'thumbnail_src',
                             'status' => 'status',
                             'attributes' => 'attributes',
                         ],
                         'links' => [
                             'insertDataFromGrid' => '${$.provider}:${$.dataProviderFromGrid}',
                             'insertDataFromWizard' => '${$.provider}:${$.dataProviderFromWizard}',
                             'changeDataFromGrid' => '${$.provider}:${$.dataProviderChangeFromGrid}',
                         ],
                         'sortOrder' => 20,
                         'columnsHeader' => false,
                         'columnsHeaderAfterRender' => true,
                         'modalWithGrid' => 'ns=' . $this->formName . ', index='
                             . static::ASSOCIATED_PRODUCT_MODAL,
                         'gridWithProducts' => 'ns=' . $this->associatedListingPrefix
                             . static::ASSOCIATED_PRODUCT_LISTING
                             . ', index=' . static::ASSOCIATED_PRODUCT_LISTING,
                     ],
                 ],
             ],
             'children' => $this->getRows(),
         ];
     }

◆ getPanelChildren()

getPanelChildren ( )

protected

Prepares panel children configuration

Returns: array

Definition at line 253 of file ConfigurablePanel.php.

     {
         return [
             'configurable_products_button_set' => $this->getButtonSet(),
             'configurable-matrix' => $this->getGrid(),
         ];
     }

◆ getRows()

getRows ( )

protected

Returns Dynamic rows records configuration

Returns: array @SuppressWarnings(PHPMD.ExcessiveMethodLength)

Definition at line 419 of file ConfigurablePanel.php.

     {
         return [
             'record' => [
                 'arguments' => [
                     'data' => [
                         'config' => [
                             'componentType' => Container::NAME,
                             'isTemplate' => true,
                             'is_collection' => true,
                             'component' => 'Magento_Ui/js/dynamic-rows/record',
                             'dataScope' => '',
                         ],
                     ],
                 ],
                 'children' => [
                     'thumbnail_image_container' => $this->getColumn(
                         'thumbnail_image',
                         __('Image'),
                         [
                             'fit' => true,
                             'formElement' => 'fileUploader',
                             'componentType' => 'fileUploader',
                             'component' => 'Magento_ConfigurableProduct/js/components/file-uploader',
                             'elementTmpl' => 'Magento_ConfigurableProduct/components/file-uploader',
                             'fileInputName' => 'image',
                             'isMultipleFiles' => false,
                             'links' => [
                                 'thumbnailUrl' => '${$.provider}:${$.parentScope}.thumbnail_image',
                                 'thumbnail' => '${$.provider}:${$.parentScope}.thumbnail',
                                 'smallImage' => '${$.provider}:${$.parentScope}.small_image',
                             ],
                             'uploaderConfig' => [
                                 'url' => $this->urlBuilder->addSessionParam()->getUrl(
                                     'catalog/product_gallery/upload'
                                 ),
                             ],
                             'dataScope' => 'image',
                         ],
                         [
                             'elementTmpl' => 'ui/dynamic-rows/cells/thumbnail',
                             'fit' => true,
                             'sortOrder' => 0
                         ]
                     ),
                     'name_container' => $this->getColumn(
                         'name',
                         __('Name'),
                         [],
                         ['dataScope' => 'product_link']
                     ),
                     'sku_container' => $this->getColumn(
                         'sku',
                         __('SKU'),
                         [
                             'validation' =>
                                 [
                                     'required-entry' => true,
                                     'max_text_length' => Sku::SKU_MAX_LENGTH,
                                 ],
                         ],
                         [
                             'elementTmpl' => 'Magento_ConfigurableProduct/components/cell-sku',
                         ]
                     ),
                     'price_container' => $this->getColumn(
                         'price',
                         __('Price'),
                         [
                             'imports' => ['addbefore' => '${$.provider}:${$.parentScope}.price_currency'],
                             'validation' => ['validate-zero-or-greater' => true]
                         ],
                         ['dataScope' => 'price_string']
                     ),
                     'quantity_container' => $this->getColumn(
                         'quantity',
                         __('Quantity'),
                         ['dataScope' => 'qty'],
                         ['dataScope' => 'qty']
                     ),
                     'price_weight' => $this->getColumn('weight', __('Weight')),
                     'status' => [
                         'arguments' => [
                             'data' => [
                                 'config' => [
                                     'componentType' => 'text',
                                     'component' => 'Magento_Ui/js/form/element/abstract',
                                     'template' => 'Magento_ConfigurableProduct/components/cell-status',
                                     'label' => __('Status'),
                                     'dataScope' => 'status',
                                 ],
                             ],
                         ],
                     ],
                     'attributes' => [
                         'arguments' => [
                             'data' => [
                                 'config' => [
                                     'componentType' => Form\Field::NAME,
                                     'formElement' => Form\Element\Input::NAME,
                                     'component' => 'Magento_Ui/js/form/element/text',
                                     'elementTmpl' => 'ui/dynamic-rows/cells/text',
                                     'dataType' => Form\Element\DataType\Text::NAME,
                                     'label' => __('Attributes'),
                                 ],
                             ],
                         ],
                     ],
                     'actionsList' => [
                         'arguments' => [
                             'data' => [
                                 'config' => [
                                     'additionalClasses' => 'data-grid-actions-cell',
                                     'componentType' => 'text',
                                     'component' => 'Magento_Ui/js/form/element/abstract',
                                     'template' => 'Magento_ConfigurableProduct/components/actions-list',
                                     'label' => __('Actions'),
                                     'fit' => true,
                                     'dataScope' => 'status',
                                 ],
                             ],
                         ],
                     ],
                 ],
             ],
         ];
     }

◆ modifyData()

modifyData ( array $data )

{

Parameters

array $data

Returns: array

Since: 100.1.0

}

Implements ModifierInterface.

Definition at line 95 of file ConfigurablePanel.php.

     {
         return $data;
     }

◆ modifyMeta()

modifyMeta ( array $meta )

{

Parameters

array $meta

Returns: array

Since: 100.1.0

} @SuppressWarnings(PHPMD.ExcessiveMethodLength)

Implements ModifierInterface.

Definition at line 104 of file ConfigurablePanel.php.

     {
         $meta = array_merge_recursive(
             $meta,
             [
                 static::GROUP_CONFIGURABLE => [
                     'arguments' => [
                         'data' => [
                             'config' => [
                                 'label' => __('Configurations'),
                                 'collapsible' => true,
                                 'opened' => true,
                                 'componentType' => Form\Fieldset::NAME,
                                 'sortOrder' => $this->getNextGroupSortOrder(
                                     $meta,
                                     self::$groupContent,
                                     self::$sortOrder
                                 ),
                             ],
                         ],
                     ],
                     'children' => $this->getPanelChildren(),
                 ],
                 static::ASSOCIATED_PRODUCT_MODAL => [
                     'arguments' => [
                         'data' => [
                             'config' => [
                                 'componentType' => Modal::NAME,
                                 'dataScope' => '',
                                 'provider' => $this->dataSourceName,
                                 'options' => [
                                     'title' => __('Select Associated Product'),
                                     'buttons' => [
                                         [
                                             'text' => __('Done'),
                                             'class' => 'action-primary',
                                             'actions' => [
                                                 [
                                                     'targetName' => 'ns= ' . $this->associatedListingPrefix
                                                         . static::ASSOCIATED_PRODUCT_LISTING
                                                         . ', index=' . static::ASSOCIATED_PRODUCT_LISTING,
                                                     'actionName' => 'save'
                                                 ],
                                                 'closeModal'
                                             ],
                                         ],
                                     ],
                                 ],
                             ],
                         ],
                     ],
                     'children' => [
                         'information-block1' => [
                             'arguments' => [
                                 'data' => [
                                     'config' => [
                                         'componentType' => Container::NAME,
                                         'component' => 'Magento_Ui/js/form/components/html',
                                         'additionalClasses' => 'message message-notice',
                                         'content' => __(
                                             'Choose a new product to delete and replace'
                                             . ' the current product configuration.'
                                         ),
                                         'imports' => [
                                             'visible' => '!ns = ${ $.ns }, index = '
                                                 . ConfigurablePanel::CONFIGURABLE_MATRIX . ':isEmpty',
                                         ],
                                     ],
                                 ],
                             ],
                         ],
                         'information-block2' => [
                             'arguments' => [
                                 'data' => [
                                     'config' => [
                                         'componentType' => Container::NAME,
                                         'component' => 'Magento_Ui/js/form/components/html',
                                         'additionalClasses' => 'message message-notice',
                                         'content' => __(
                                             'For better results, add attributes and attribute values to your products.'
                                         ),
                                         'imports' => [
                                             'visible' => 'ns = ${ $.ns }, index = '
                                                 . ConfigurablePanel::CONFIGURABLE_MATRIX . ':isEmpty',
                                         ],
                                     ],
                                 ],
                             ],
                         ],
                         static::ASSOCIATED_PRODUCT_LISTING => [
                             'arguments' => [
                                 'data' => [
                                     'config' => [
                                         'autoRender' => false,
                                         'componentType' => 'insertListing',
                                         'component' => 'Magento_ConfigurableProduct/js'
                                             .'/components/associated-product-insert-listing',
                                         'dataScope' => $this->associatedListingPrefix
                                             . static::ASSOCIATED_PRODUCT_LISTING,
                                         'externalProvider' => $this->associatedListingPrefix
                                             . static::ASSOCIATED_PRODUCT_LISTING . '.data_source',
                                         'selectionsProvider' => $this->associatedListingPrefix
                                             . static::ASSOCIATED_PRODUCT_LISTING . '.'
                                             . $this->associatedListingPrefix
                                             . static::ASSOCIATED_PRODUCT_LISTING . '.product_columns.ids',
                                         'ns' => $this->associatedListingPrefix . static::ASSOCIATED_PRODUCT_LISTING,
                                         'render_url' => $this->urlBuilder->getUrl('mui/index/render'),
                                         'realTimeLink' => true,
                                         'behaviourType' => 'simple',
                                         'externalFilterMode' => false,
                                         'currentProductId' => $this->locator->getProduct()->getId(),
                                         'dataLinks' => [
                                             'imports' => false,
                                             'exports' => true
                                         ],
                                         'changeProductProvider' => 'change_product',
                                         'productsProvider' => $this->associatedListingPrefix
                                             . 'configurable_associated_product_listing.data_source',
                                         'productsColumns' => $this->associatedListingPrefix
                                             . 'configurable_associated_product_listing'
                                             . '.' . $this->associatedListingPrefix
                                             . 'configurable_associated_product_listing.product_columns',
                                         'productsMassAction' => $this->associatedListingPrefix
                                             . 'configurable_associated_product_listing'
                                             . '.' . $this->associatedListingPrefix
                                             . 'configurable_associated_product_listing.product_columns.ids',
                                         'modalWithGrid' => 'ns=' . $this->formName . ', index='
                                             . static::ASSOCIATED_PRODUCT_MODAL,
                                         'productsFilters' => $this->associatedListingPrefix
                                             . 'configurable_associated_product_listing'
                                             . '.' . $this->associatedListingPrefix
                                             . 'configurable_associated_product_listing.listing_top.listing_filters',
                                     ],
                                 ],
                             ],
                         ],
                     ],
                 ],
             ]
         );
 
         return $meta;
     }

Field Documentation

◆ ASSOCIATED_PRODUCT_LISTING

const ASSOCIATED_PRODUCT_LISTING = 'configurable_associated_product_listing'

Definition at line 25 of file ConfigurablePanel.php.

◆ ASSOCIATED_PRODUCT_MODAL

const ASSOCIATED_PRODUCT_MODAL = 'configurable_associated_product_modal'

Definition at line 24 of file ConfigurablePanel.php.

◆ CONFIGURABLE_MATRIX

const CONFIGURABLE_MATRIX = 'configurable-matrix'

Definition at line 26 of file ConfigurablePanel.php.

◆ GROUP_CONFIGURABLE

const GROUP_CONFIGURABLE = 'configurable'

Definition at line 23 of file ConfigurablePanel.php.

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

vendor/magento/module-configurable-product/Ui/DataProvider/Product/Form/Modifier/ConfigurablePanel.php

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getButtonSet()

◆ getColumn()

◆ getGrid()

◆ getPanelChildren()

◆ getRows()

◆ modifyData()

◆ modifyMeta()

Field Documentation

◆ ASSOCIATED_PRODUCT_LISTING

◆ ASSOCIATED_PRODUCT_MODAL

◆ CONFIGURABLE_MATRIX

◆ GROUP_CONFIGURABLE