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

dmitry_fedyuk · February 21, 2016, 9:25am

magento/magento2/blob/e0ed4bad/app/code/Magento/Cms/view/adminhtml/ui_component/cms_block_form.xml#L28-L45


<dataSource name="block_form_data_source">
    <argument name="dataProvider" xsi:type="configurableObject">
        <argument name="class" xsi:type="string">Magento\Cms\Model\Block\DataProvider</argument>
        <argument name="name" xsi:type="string">block_form_data_source</argument>
        <argument name="primaryFieldName" xsi:type="string">block_id</argument>
        <argument name="requestFieldName" xsi:type="string">block_id</argument>
        <argument name="data" xsi:type="array">
            <item name="config" xsi:type="array">
                <item name="submit_url" xsi:type="url" path="cms/block/save"/>
            </item>
        </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/Cms/Model/Block/DataProvider.php#L14-L14


class DataProvider extends \Magento\Ui\DataProvider\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/Cms/Model/Block/DataProvider.php#L61-L80


public function getData()
{
    if (isset($this->loadedData)) {
        return $this->loadedData;
    }
    $items = $this->collection->getItems();
    /** @var \Magento\Cms\Model\Block $block */
    foreach ($items as $block) {
        $this->loadedData[$block->getId()] = $block->getData();
    }


    $data = $this->dataPersistor->get('cms_block');
    if (!empty($data)) {
        $block = $this->collection->getNewEmptyItem();
        $block->setData($data);
        $this->loadedData[$block->getId()] = $block->getData();
    }


    return $this->loadedData;
}

dmitry_fedyuk · February 21, 2016, 9:57am