Form Class Reference

Inheritance diagram for Form:

Public Member Functions
	__construct (\Magento\Backend\Block\Template\Context $context, array $data=[])
	getForm ()
	getFormHtml ()
	setForm (\Magento\Framework\Data\Form $form)
Public Member Functions inherited from Widget
	getId ()
	getSuffixId ($suffix)
	getHtmlId ()
	getCurrentUrl ($params=[])
	getButtonHtml ($label, $onclick, $class='', $buttonId=null, $dataAttr=[])
Public Member Functions inherited from Template
	__construct (\Magento\Backend\Block\Template\Context $context, array $data=[])
	getFormKey ()
	isOutputEnabled ($moduleName=null)
	getAuthorization ()
	getToolbar ()
Public Member Functions inherited from Template
	__construct (Template\Context $context, array $data=[])
	setTemplateContext ($templateContext)
	getTemplate ()
	setTemplate ($template)
	getTemplateFile ($template=null)
	getArea ()
	assign ($key, $value=null)
	fetchView ($fileName)
	getBaseUrl ()
	getObjectData (\Magento\Framework\DataObject $object, $key)
	getCacheKeyInfo ()
Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Framework\View\Element\Context $context, array $data=[])
	getJsLayout ()
	getRequest ()
	getParentBlock ()
	setLayout (\Magento\Framework\View\LayoutInterface $layout)
	getLayout ()
	setNameInLayout ($name)
	getChildNames ()
	setAttribute ($name, $value=null)
	setChild ($alias, $block)
	addChild ($alias, $block, $data=[])
	unsetChild ($alias)
	unsetCallChild ($alias, $callback, $result, $params)
	unsetChildren ()
	getChildBlock ($alias)
	getChildHtml ($alias='', $useCache=true)
	getChildChildHtml ($alias, $childChildAlias='', $useCache=true)
	getBlockHtml ($name)
	insert ($element, $siblingName=0, $after=true, $alias='')
	append ($element, $alias='')
	getGroupChildNames ($groupName)
	getChildData ($alias, $key='')
	getUiId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)
	getJsId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)
	getUrl ($route='', $params=[])
	getViewFileUrl ($fileId, array $params=[])
	formatDate ( $date=null, $format=\IntlDateFormatter::SHORT, $showTime=false, $timezone=null)
	formatTime ( $time=null, $format=\IntlDateFormatter::SHORT, $showDate=false)
	getModuleName ()
	escapeHtml ($data, $allowedTags=null)
	escapeJs ($string)
	escapeHtmlAttr ($string, $escapeSingleQuote=true)
	escapeCss ($string)
	stripTags ($data, $allowableTags=null, $allowHtmlEntities=false)
	escapeUrl ($string)
	escapeXssInUrl ($data)
	escapeQuote ($data, $addSlashes=false)
	escapeJsQuote ($data, $quote='\'')
	getNameInLayout ()
	getCacheKeyInfo ()
	getCacheKey ()
	getVar ($name, $module=null)
	isScopePrivate ()
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)
Public Member Functions inherited from BlockInterface
	toHtml ()

Protected Member Functions
	_construct ()
	_prepareLayout ()
	_prepareForm ()
	_beforeToHtml ()
	_initFormValues ()
	_setFieldset ($attributes, $fieldset, $exclude=[])
	_isAttributeVisible (\Magento\Eav\Model\Entity\Attribute $attribute)
	_applyTypeSpecificConfig ($inputType, $element, \Magento\Eav\Model\Entity\Attribute $attribute)
	_addElementTypes (\Magento\Framework\Data\Form\AbstractForm $baseElement)
	_getAdditionalElementTypes ()
	_getAdditionalElementHtml ($element)
Protected Member Functions inherited from Widget
	_addBreadcrumb ($label, $title=null, $link=null)
Protected Member Functions inherited from Template
	_toHtml ()
Protected Member Functions inherited from Template
	_construct ()
	_toHtml ()
	getRootDirectory ()
	getMediaDirectory ()
Protected Member Functions inherited from AbstractBlock
	_construct ()
	_prepareLayout ()
	_beforeToHtml ()
	_afterToHtml ($html)
	_toHtml ()
	_getNotFoundUrl ($route='', $params=['_direct'=> 'core/index/notFound'])
	getCacheTags ()
	getCacheLifetime ()
	_loadCache ()
	_saveCache ($data)
	_getSidPlaceholder ($cacheKey=null)
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$_form
	$_template = 'Magento_Backend::widget/form.phtml'
Protected Attributes inherited from Template
	$_authorization
	$mathRandom
	$_backendSession
	$formKey
	$nameBuilder
Protected Attributes inherited from Template
	$_viewVars = []
	$_baseUrl
	$_jsUrl
	$_allowSymlinks
	$_filesystem
	$_template
	$templateEnginePool
	$_storeManager
	$_appState
	$directory
	$templateContext
	$pageConfig
	$resolver
	$validator
Protected Attributes inherited from AbstractBlock
	$_design
	$_session
	$_sidResolver
	$_nameInLayout
	$_layout
	$jsLayout = []
	$_request
	$_urlBuilder
	$_eventManager
	$_frontController
	$_assetRepo
	$_viewConfig
	$_cacheState
	$_logger
	$_escaper
	$filterManager
	$_localeDate
	$inlineTranslation
	$_isScopePrivate = false
	$_scopeConfig
	$_cache
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Public Member Functions inherited from AbstractBlock
static	extractModuleName ($className)
Data Fields inherited from Template
const	XML_PATH_TEMPLATE_ALLOW_SYMLINK = 'dev/template/allow_symlink'
Data Fields inherited from AbstractBlock
const	CACHE_GROUP = \Magento\Framework\App\Cache\Type\Block::TYPE_IDENTIFIER
const	CACHE_KEY_PREFIX = 'BLOCK_'
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Backend form widget

@api

Deprecated:

100.2.0 in favour of UI component implementation @SuppressWarnings(PHPMD.NumberOfChildren)

Since

100.0.2

Definition at line 16 of file Form.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Backend\Block\Template\Context	$context,
		array	$data = []
	)

Parameters

\Magento\Backend\Block\Template\Context	$context
array	$data

Definition at line 34 of file Form.php.

    {
        parent::__construct($context, $data);
    }

Member Function Documentation

_addElementTypes()

_addElementTypes ( \Magento\Framework\Data\Form\AbstractForm  $baseElement )

protected

Add new element type

Parameters

\Magento\Framework\Data\Form\AbstractForm

$baseElement

Returns

void

Definition at line 255 of file Form.php.

    {
        $types = $this->_getAdditionalElementTypes();
        foreach ($types as $code => $className) {
            $baseElement->addType($code, $className);
        }
    }

_applyTypeSpecificConfig()

_applyTypeSpecificConfig (   $inputType,   $element, \Magento\Eav\Model\Entity\Attribute  $attribute  )

protected

Apply configuration specific for different element type

Parameters

string	$inputType
\Magento\Framework\Data\Form\Element\AbstractElement	$element
\Magento\Eav\Model\Entity\Attribute	$attribute

Returns

void

Definition at line 228 of file Form.php.

    {
        switch ($inputType) {
            case 'select':
                $element->setValues($attribute->getSource()->getAllOptions(true, true));
                break;
            case 'multiselect':
                $element->setValues($attribute->getSource()->getAllOptions(false, true));
                $element->setCanBeEmpty(true);
                break;
            case 'date':
                $element->setDateFormat($this->_localeDate->getDateFormatWithLongYear());
                break;
            case 'multiline':
                $element->setLineCount($attribute->getMultilineCount());
                break;
            default:
                break;
        }
    }

_beforeToHtml()

_beforeToHtml ( )

protected

This method is called before rendering HTML

Returns

$this

Definition at line 142 of file Form.php.

    {
        $this->_prepareForm();
        $this->_initFormValues();
        return parent::_beforeToHtml();
    }

_construct()

_construct ( )

protected

Class constructor

Returns

void

Definition at line 44 of file Form.php.

    {
        parent::_construct();

        $this->setDestElementId('edit_form');
        $this->setShowGlobalIcon(false);
    }

_getAdditionalElementHtml()

_getAdditionalElementHtml (   $element )

protected

Render additional element

Parameters

\Magento\Framework\Data\Form\Element\AbstractElement

$element

Returns

string @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 280 of file Form.php.

    {
        return '';
    }

_getAdditionalElementTypes()

_getAdditionalElementTypes ( )

protected

Retrieve predefined additional element types

Returns

array

Definition at line 268 of file Form.php.

    {
        return [];
    }

_initFormValues()

_initFormValues ( )

protected

Initialize form fields values Method will be called after prepareForm and can be used for field values initialization

Returns

$this

Definition at line 155 of file Form.php.

    {
        return $this;
    }

_isAttributeVisible()

_isAttributeVisible ( \Magento\Eav\Model\Entity\Attribute  $attribute )

protected

Check whether attribute is visible

Parameters

\Magento\Eav\Model\Entity\Attribute

$attribute

Returns

bool

Definition at line 215 of file Form.php.

    {
        return !(!$attribute || $attribute->hasIsVisible() && !$attribute->getIsVisible());
    }

_prepareForm()

_prepareForm ( )

protected

Prepare form before rendering HTML

Returns

$this

Definition at line 132 of file Form.php.

    {
        return $this;
    }

_prepareLayout()

_prepareLayout ( )

protected

Preparing global layout

You can redefine this method in child classes for changing layout

Returns

$this

Definition at line 59 of file Form.php.

    {
        \Magento\Framework\Data\Form::setElementRenderer(
            $this->getLayout()->createBlock(
                \Magento\Backend\Block\Widget\Form\Renderer\Element::class,
                $this->getNameInLayout() . '_element'
            )
        );
        \Magento\Framework\Data\Form::setFieldsetRenderer(
            $this->getLayout()->createBlock(
                \Magento\Backend\Block\Widget\Form\Renderer\Fieldset::class,
                $this->getNameInLayout() . '_fieldset'
            )
        );
        \Magento\Framework\Data\Form::setFieldsetElementRenderer(
            $this->getLayout()->createBlock(
                \Magento\Backend\Block\Widget\Form\Renderer\Fieldset\Element::class,
                $this->getNameInLayout() . '_fieldset_element'
            )
        );

        return parent::_prepareLayout();
    }

_setFieldset()

_setFieldset (   $attributes,   $fieldset,   $exclude = []  )

protected

Set Fieldset to Form

Parameters

array	$attributes	attributes that are to be added
\Magento\Framework\Data\Form\Element\Fieldset	$fieldset
array	$exclude	attributes that should be skipped

Returns

void

Definition at line 168 of file Form.php.

    {
        $this->_addElementTypes($fieldset);
        foreach ($attributes as $attribute) {
            /* @var $attribute \Magento\Eav\Model\Entity\Attribute */
            if (!$this->_isAttributeVisible($attribute)) {
                continue;
            }
            if (($inputType = $attribute->getFrontend()->getInputType()) && !in_array(
                $attribute->getAttributeCode(),
                $exclude
            ) && ('media_image' != $inputType || $attribute->getAttributeCode() == 'image')
            ) {
                $fieldType = $inputType;
                $rendererClass = $attribute->getFrontend()->getInputRendererClass();
                if (!empty($rendererClass)) {
                    $fieldType = $inputType . '_' . $attribute->getAttributeCode();
                    $fieldset->addType($fieldType, $rendererClass);
                }

                $element = $fieldset->addField(
                    $attribute->getAttributeCode(),
                    $fieldType,
                    [
                        'name' => $attribute->getAttributeCode(),
                        'label' => $attribute->getFrontend()->getLocalizedLabel(),
                        'class' => $attribute->getFrontend()->getClass(),
                        'required' => $attribute->getIsRequired(),
                        'note' => $attribute->getNote()
                    ]
                )->setEntityAttribute(
                    $attribute
                );

                $element->setAfterElementHtml($this->_getAdditionalElementHtml($element));

                $this->_applyTypeSpecificConfig($inputType, $element, $attribute);
            }
        }
    }

getForm()

getForm

(

)

Get form object

Returns

\Magento\Framework\Data\Form

Definition at line 88 of file Form.php.

    {
        return $this->_form;
    }

getFormHtml()

getFormHtml

(

)

Get form HTML

Returns

string

Definition at line 98 of file Form.php.

    {
        if (is_object($this->getForm())) {
            return $this->getForm()->getHtml();
        }
        return '';
    }

setForm()

setForm

(

\Magento\Framework\Data\Form

$form

)

Set form object

Parameters

\Magento\Framework\Data\Form

$form

Returns

$this

Definition at line 112 of file Form.php.

    {
        $this->_form = $form;
        $this->_form->setParent($this);
        $this->_form->setBaseUrl($this->_urlBuilder->getBaseUrl());

        $customAttributes = $this->getData('custom_attributes');
        if (is_array($customAttributes)) {
            foreach ($customAttributes as $key => $value) {
                $this->_form->addCustomAttribute($key, $value);
            }
        }
        return $this;
    }

Field Documentation

$_form

$_form

protected

Definition at line 23 of file Form.php.

$_template

$_template = 'Magento_Backend::widget/form.phtml'

protected

Definition at line 28 of file Form.php.

---

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

• vendor/magento/module-backend/Block/Widget/Form.php