How to define the metadata to be passed to an UI component on the client (JavaScript) side?

dmitry_fedyuk · February 23, 2016, 9:43am

Related reading: How is initialization / configuration metadata set to an UI component?

Interface

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


/**
 * @return array
 */
public function getMeta();

Implementation

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/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/Catalog/Ui/DataProvider/Product/Form/ProductDataProvider.php#L62-L72


public function getMeta()
{
    $meta = parent::getMeta();


    /** @var ModifierInterface $modifier */
    foreach ($this->pool->getModifiersInstances() as $modifier) {
        $meta = $modifier->modifyMeta($meta);
    }


    return $meta;
}

github.com

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


/**
 * @return array
 */
public function getMeta()
{
    return $this->meta;
}

github.com

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


/**
 * Get field Set meta info
 *
 * @param string $fieldSetName
 * @return array
 */
public function getFieldSetMetaInfo($fieldSetName)
{
    return isset($this->meta[$fieldSetName]) ? $this->meta[$fieldSetName] : [];
}

https://github.com/magento/magento2/blob/e0ed4bad/app/code/Magento/Ui/DataProvider/AbstractDataProvider.php#L128-L135

https://github.com/magento/magento2/blob/e0ed4bad/app/code/Magento/Ui/DataProvider/AbstractDataProvider.php#L137-L147