How does a backend product form define the data to be passed to its UI component on the client (JavaScript) side?

dmitrii_fediuk · February 21, 2016, 6:12pm

Related reading: An example of backend product page UI component’s data.

magento/magento2/blob/e0ed4bad/app/code/Magento/Catalog/view/adminhtml/ui_component/product_form.xml#L26-L38


<dataSource name="product_form_data_source">
    <argument name="dataProvider" xsi:type="configurableObject">
        <argument name="class" xsi:type="string">Magento\Catalog\Ui\DataProvider\Product\Form\ProductDataProvider</argument>
        <argument name="name" xsi:type="string">product_form_data_source</argument>
        <argument name="primaryFieldName" xsi:type="string">entity_id</argument>
        <argument name="requestFieldName" xsi:type="string">id</argument>
    </argument>
    <argument name="data" xsi:type="array">
        <item name="js_config" xsi:type="array">
            <item name="component" xsi:type="string">Magento_Ui/js/form/provider</item>
        </item>
    </argument>
</dataSource>

github.com

magento/magento2/blob/e0ed4bad/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/ProductDataProvider.php#L13-L16


/**
* DataProvider for product edit form
*/
class ProductDataProvider extends AbstractDataProvider

github.com

magento/magento2/blob/e0ed4bad/app/code/Magento/Ui/DataProvider/AbstractDataProvider.php#L11-L11


abstract class AbstractDataProvider implements DataProviderInterface

github.com

magento/magento2/blob/e0ed4bad/lib/internal/Magento/Framework/View/Element/UiComponent/DataProvider/DataProviderInterface.php#L77-L82


/**
 * Get data
 *
 * @return mixed
 */
public function getData();

github.com

magento/magento2/blob/e0ed4bad/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/ProductDataProvider.php#L49-L57


public function getData()
{
    /** @var ModifierInterface $modifier */
    foreach ($this->pool->getModifiersInstances() as $modifier) {
        $this->data = $modifier->modifyData($this->data);
    }


    return $this->data;
}

github.com

magento/magento2/blob/e0ed4bad/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/ProductDataProvider.php#L11-L11


use Magento\Ui\DataProvider\Modifier\Pool;

github.com

magento/magento2/blob/e0ed4bad/app/code/Magento/Catalog/etc/adminhtml/di.xml#L88-L88


<preference for="Magento\Ui\DataProvider\Modifier\Pool" type="Magento\Catalog\Ui\DataProvider\Product\Form\ModifierPool"/>

https://github.com/magento/magento2/blob/e0ed4bad/app/code/Magento/Catalog/etc/adminhtml/di.xml#L89-L91

https://github.com/magento/magento2/blob/e0ed4bad/app/code/Magento/Catalog/etc/adminhtml/di.xml#L92-L111

github.com

magento/magento2/blob/e0ed4bad/app/code/Magento/Catalog/etc/adminhtml/di.xml#L112-L131


<item name="categories" xsi:type="array">
    <item name="class" xsi:type="string">Magento\Catalog\Ui\DataProvider\Product\Form\Modifier\Categories</item>
    <item name="sortOrder" xsi:type="number">60</item>
</item>
<item name="schedule-design-update" xsi:type="array">
    <item name="class" xsi:type="string">Magento\Catalog\Ui\DataProvider\Product\Form\Modifier\CustomOptions</item>
    <item name="sortOrder" xsi:type="number">70</item>
</item>
<item name="custom-options" xsi:type="array">
    <item name="class" xsi:type="string">Magento\Catalog\Ui\DataProvider\Product\Form\Modifier\ScheduleDesignUpdate</item>
    <item name="sortOrder" xsi:type="number">80</item>
</item>
<item name="advanced-pricing" xsi:type="array">
    <item name="class" xsi:type="string">Magento\Catalog\Ui\DataProvider\Product\Form\Modifier\AdvancedPricing</item>
    <item name="sortOrder" xsi:type="number">90</item>
</item>
<item name="image-management" xsi:type="array">
    <item name="class" xsi:type="string">Magento\Catalog\Ui\DataProvider\Product\Form\Modifier\Images</item>
    <item name="sortOrder" xsi:type="number">100</item>
</item>

https://github.com/magento/magento2/blob/e0ed4bad/app/code/Magento/Catalog/etc/adminhtml/di.xml#L132-L139

github.com

magento/magento2/blob/e0ed4bad/app/code/Magento/Review/etc/adminhtml/di.xml#L24-L27


<item name="review" xsi:type="array">
    <item name="class" xsi:type="string">Magento\Review\Ui\DataProvider\Product\Form\Modifier\Review</item>
    <item name="sortOrder" xsi:type="number">20</item>
</item>

github.com

magento/magento2/blob/e0ed4bad/app/code/Magento/Downloadable/etc/adminhtml/di.xml#L22-L25


<item name="downloadable" xsi:type="array">
    <item name="class" xsi:type="string">Magento\Downloadable\Ui\DataProvider\Product\Form\Modifier\Composite</item>
    <item name="sortOrder" xsi:type="number">20</item>
</item>

github.com

magento/magento2/blob/e0ed4bad/app/code/Magento/CatalogInventory/etc/adminhtml/di.xml#L35-L38


<item name="advancedInventory" xsi:type="array">
    <item name="class" xsi:type="string">Magento\CatalogInventory\Ui\DataProvider\Product\Form\Modifier\AdvancedInventory</item>
    <item name="sortOrder" xsi:type="number">20</item>
</item>

github.com

magento/magento2/blob/e0ed4bad/app/code/Magento/GiftMessage/etc/adminhtml/di.xml#L12-L15


<item name="gift-message" xsi:type="array">
    <item name="class" xsi:type="string">Magento\GiftMessage\Ui\DataProvider\Product\Modifier\GiftMessage</item>
    <item name="sortOrder" xsi:type="number">20</item>
</item>

github.com

magento/magento2/blob/e0ed4bad/app/code/Magento/Msrp/etc/adminhtml/di.xml#L15-L18


<item name="mrsp" xsi:type="array">
    <item name="class" xsi:type="string">Magento\Msrp\Ui\DataProvider\Product\Form\Modifier\Msrp</item>
    <item name="sortOrder" xsi:type="number">20</item>
</item>

github.com

magento/magento2/blob/e0ed4bad/app/code/Magento/Weee/etc/adminhtml/di.xml#L12-L15


<item name="weee" xsi:type="array">
    <item name="class" xsi:type="string">Magento\Weee\Ui\DataProvider\Product\Form\Modifier\Weee</item>
    <item name="sortOrder" xsi:type="number">30</item>
</item>

https://github.com/magento/magento2/blob/e0ed4bad/app/code/Magento/CatalogUrlRewrite/etc/adminhtml/di.xml#L31-L34

https://github.com/magento/magento2/blob/e0ed4bad/app/code/Magento/GoogleOptimizer/etc/adminhtml/di.xml#L12-L15

https://github.com/magento/magento2/blob/e0ed4bad/app/code/Magento/GroupedProduct/etc/adminhtml/di.xml#L26-L29

https://github.com/magento/magento2/blob/e0ed4bad/app/code/Magento/GroupedProduct/etc/adminhtml/di.xml#L30-L33

https://github.com/magento/magento2/blob/e0ed4bad/app/code/Magento/Bundle/etc/adminhtml/di.xml#L25-L28

https://github.com/magento/magento2/blob/e0ed4bad/app/code/Magento/Bundle/etc/adminhtml/di.xml#L29-L32

https://github.com/magento/magento2/blob/e0ed4bad/app/code/Magento/Ui/DataProvider/Modifier/ModifierInterface.php#L13-L17