The default backend form element renderer

dmitry_fedyuk · November 21, 2015, 3:20pm

The default backend config form element renderer is \Magento\Backend\Block\Widget\Form\Renderer\Fieldset\Element and the default template is Magento/Backend/view/adminhtml/templates/widget/form/renderer/fieldset/element.phtml.

If a field is inside a fieldset then the default renderer is different: The default backend fieldset element renderer.

How is it called:

github.com

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Data/Form/Element/AbstractElement.php#L465


 * Get the html.
 *
 * @return mixed
 */
public function getHtml()
{
    if ($this->getRequired()) {
        $this->addClass('required-entry _required');
    }
    if ($this->_renderer) {
        $html = $this->_renderer->render($this);
    } else {
        $html = $this->getDefaultHtml();
    }
    return $html;
}


/**
 * Get the html.
 *
 * @return mixed

How is it initialized:

github.com

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Data/Form/Element/AbstractElement.php#L79


 * @param array $data
 */
public function __construct(
    Factory $factoryElement,
    CollectionFactory $factoryCollection,
    Escaper $escaper,
    $data = []
) {
    $this->_escaper = $escaper;
    parent::__construct($factoryElement, $factoryCollection, $data);
    $this->_renderer = \Magento\Framework\Data\Form::getElementRenderer();
}


/**
 * Add form element
 *
 * @param AbstractElement $element
 * @param bool $after
 * @return Form
 */
public function addElement(AbstractElement $element, $after = false)

github.com

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Data/Form.php#L99-L102


public static function getElementRenderer()
{
    return self::$_defaultElementRenderer;
}

github.com

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Data/Form.php#L73-L76


public static function setElementRenderer(RendererInterface $renderer = null)
{
    self::$_defaultElementRenderer = $renderer;
}

github.com

magento/magento2/blob/2.0.0/app/code/Magento/Backend/Block/Widget/Form.php#L58-L63


\Magento\Framework\Data\Form::setElementRenderer(
    $this->getLayout()->createBlock(
        'Magento\Backend\Block\Widget\Form\Renderer\Element',
        $this->getNameInLayout() . '_element'
    )
);

dmitry_fedyuk · November 21, 2015, 3:51pm