Inheritance diagram for Form:

Public Member Functions
	__construct (Factory $factoryElement, ElementCollectionFactory $factoryCollection, FormKey $formKey, $data=[])

	getHtmlAttributes ()

	addElement (AbstractElement $element, $after=false)

	addElementToCollection ($element)

	checkElementId ($elementId)

	getForm ()

	getElement ($elementId)

	setValues ($values)

	addValues ($values)

	addFieldNameSuffix ($suffix)

	addSuffixToName ($name, $suffix)

	removeField ($elementId)

	setFieldContainerIdPrefix ($prefix)

	getFieldContainerIdPrefix ()

	toHtml ()

	getHtml ()

Public Member Functions inherited from AbstractForm
	__construct (Factory $factoryElement, CollectionFactory $factoryCollection, $data=[])

	addType ($type, $className)

	getElements ()

	setReadonly ($readonly, $useDisabled=false)

	addElement (AbstractElement $element, $after=null)

	addField ($elementId, $type, $config, $after=false)

	removeField ($elementId)

	addFieldset ($elementId, $config, $after=false, $isAdvanced=false)

	addColumn ($elementId, $config)

	convertToArray (array $arrAttributes=[])

	addCustomAttribute ($key, $value)

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

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)

Static Public Member Functions
static	setElementRenderer (RendererInterface $renderer=null)

static	setFieldsetRenderer (RendererInterface $renderer=null)

static	setFieldsetElementRenderer (RendererInterface $renderer=null)

static	getElementRenderer ()

static	getFieldsetRenderer ()

static	getFieldsetElementRenderer ()

Protected Member Functions
	_elementIdExists ($elementId)

Protected Member Functions inherited from AbstractForm
	_construct ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_allElements

	$_elementsIndex

	$formKey

Protected Attributes inherited from AbstractForm
	$_elements

	$_types = []

	$_factoryElement

	$_factoryCollection

	$customAttributes = []

Protected Attributes inherited from DataObject
	$_data = []

Static Protected Attributes
static	$_defaultElementRenderer

static	$_defaultFieldsetRenderer

static	$_defaultFieldsetElementRenderer

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

@api

Since: 100.0.2

Definition at line 21 of file Form.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	Factory	$factoryElement,
		ElementCollectionFactory	$factoryCollection,
		FormKey	$formKey,
			$data = `[]`
	)

Parameters

Factory	$factoryElement
ElementCollectionFactory	$factoryCollection
FormKey	$formKey
array	$data

Definition at line 63 of file Form.php.

       {
         parent::__construct($factoryElement, $factoryCollection, $data);
         $this->_allElements = $this->_factoryCollection->create(['container' => $this]);
         $this->formKey = $formKey;
     }

Member Function Documentation

◆ _elementIdExists()

_elementIdExists ( $elementId )

protected

Check existing element

Parameters

string $elementId

Returns: bool

Definition at line 156 of file Form.php.

     {
         return isset($this->_elementsIndex[$elementId]);
     }

◆ addElement()

addElement	(	AbstractElement	$element,
			$after = `false`
	)

Add form element

Parameters

AbstractElement	$element
bool	$after

Returns: $this

Definition at line 142 of file Form.php.

     {
         $this->checkElementId($element->getId());
         parent::addElement($element, $after);
         $this->addElementToCollection($element);
         return $this;
     }

◆ addElementToCollection()

addElementToCollection ( $element )

Parameters

AbstractElement $element

Returns: $this

Definition at line 165 of file Form.php.

     {
         $this->_elementsIndex[$element->getId()] = $element;
         $this->_allElements->add($element);
         return $this;
     }

◆ addFieldNameSuffix()

addFieldNameSuffix ( $suffix )

Add suffix to name of all elements

Parameters

string $suffix

Returns: $this

Definition at line 249 of file Form.php.

     {
         foreach ($this->_allElements as $element) {
             $name = $element->getName();
             if ($name) {
                 $element->setName($this->addSuffixToName($name, $suffix));
             }
         }
         return $this;
     }

◆ addSuffixToName()

addSuffixToName	(	$name,
		$suffix
	)

Parameters

string	$name
string	$suffix

Returns: string

Definition at line 265 of file Form.php.

     {
         if (!$name) {
             return $suffix;
         }
         $vars = explode('[', $name);
         $newName = $suffix;
         foreach ($vars as $index => $value) {
             $newName .= '[' . $value;
             if ($index == 0) {
                 $newName .= ']';
             }
         }
         return $newName;
     }

◆ addValues()

addValues ( $values )

Parameters

array $values

Returns: $this

Definition at line 229 of file Form.php.

     {
         if (!is_array($values)) {
             return $this;
         }
         foreach ($values as $elementId => $value) {
             $element = $this->getElement($elementId);
             if ($element) {
                 $element->setValue($value);
             }
         }
         return $this;
     }

◆ checkElementId()

checkElementId ( $elementId )

Parameters

string $elementId

Returns: bool

Exceptions

Definition at line 177 of file Form.php.

     {
         if ($this->_elementIdExists($elementId)) {
             throw new \InvalidArgumentException(
                 'An element with a "' . $elementId . '" ID already exists.'
             );
         }
         return true;
     }

◆ getElement()

getElement ( $elementId )

Retrieve form element by id

Parameters

string $elementId

Returns: null|AbstractElement

Definition at line 201 of file Form.php.

     {
         if ($this->_elementIdExists($elementId)) {
             return $this->_elementsIndex[$elementId];
         }
         return null;
     }

◆ getElementRenderer()

static getElementRenderer ( )

static

Returns: RendererInterface

Definition at line 104 of file Form.php.

     {
         return self::$_defaultElementRenderer;
     }

◆ getFieldContainerIdPrefix()

getFieldContainerIdPrefix ( )

Returns: string

Definition at line 306 of file Form.php.

     {
         return $this->getData('field_container_id_prefix');
     }

◆ getFieldsetElementRenderer()

static getFieldsetElementRenderer ( )

static

Returns: RendererInterface

Definition at line 120 of file Form.php.

     {
         return self::$_defaultFieldsetElementRenderer;
     }

◆ getFieldsetRenderer()

static getFieldsetRenderer ( )

static

Returns: RendererInterface

Definition at line 112 of file Form.php.

     {
         return self::$_defaultFieldsetRenderer;
     }

◆ getForm()

getForm ( )

Returns: $this

Definition at line 190 of file Form.php.

     {
         return $this;
     }

◆ getHtml()

getHtml ( )

Returns: string

Definition at line 342 of file Form.php.

     {
         return $this->toHtml();
     }

◆ getHtmlAttributes()

getHtmlAttributes ( )

Return allowed HTML form attributes

Returns: string[]

Definition at line 130 of file Form.php.

     {
         return ['id', 'name', 'method', 'action', 'enctype', 'class', 'onsubmit', 'target'];
     }

◆ removeField()

removeField ( $elementId )

Parameters

string $elementId

Returns: $this

Definition at line 285 of file Form.php.

     {
         if ($this->_elementIdExists($elementId)) {
             unset($this->_elementsIndex[$elementId]);
         }
         return $this;
     }

◆ setElementRenderer()

static setElementRenderer ( RendererInterface $renderer = null )

static

Parameters

RendererInterface $renderer

Returns: void

Definition at line 78 of file Form.php.

     {
         self::$_defaultElementRenderer = $renderer;
     }

◆ setFieldContainerIdPrefix()

setFieldContainerIdPrefix ( $prefix )

Parameters

string $prefix

Returns: $this

Definition at line 297 of file Form.php.

     {
         $this->setData('field_container_id_prefix', $prefix);
         return $this;
     }

◆ setFieldsetElementRenderer()

static setFieldsetElementRenderer ( RendererInterface $renderer = null )

static

Parameters

RendererInterface $renderer

Returns: void

Definition at line 96 of file Form.php.

     {
         self::$_defaultFieldsetElementRenderer = $renderer;
     }

◆ setFieldsetRenderer()

static setFieldsetRenderer ( RendererInterface $renderer = null )

static

Parameters

RendererInterface $renderer

Returns: void

Definition at line 87 of file Form.php.

     {
         self::$_defaultFieldsetRenderer = $renderer;
     }

◆ setValues()

setValues ( $values )

Parameters

array $values

Returns: $this

Definition at line 213 of file Form.php.

     {
         foreach ($this->_allElements as $element) {
             if (isset($values[$element->getId()])) {
                 $element->setValue($values[$element->getId()]);
             } else {
                 $element->setValue(null);
             }
         }
         return $this;
     }

◆ toHtml()

toHtml ( )

Returns: string

Definition at line 314 of file Form.php.

     {
         Profiler::start('form/toHtml');
         $html = '';
         $useContainer = $this->getUseContainer();
         if ($useContainer) {
             $html .= '<form ' . $this->serialize($this->getHtmlAttributes()) . '>';
             $html .= '<div>';
             if (strtolower($this->getData('method')) == 'post') {
                 $html .= '<input name="form_key" type="hidden" value="' . $this->formKey->getFormKey() . '" />';
             }
             $html .= '</div>';
         }
 
         foreach ($this->getElements() as $element) {
             $html .= $element->toHtml();
         }
 
         if ($useContainer) {
             $html .= '</form>';
         }
         Profiler::stop('form/toHtml');
         return $html;
     }

Field Documentation

◆ $_allElements

$_allElements

protected

Definition at line 28 of file Form.php.

◆ $_defaultElementRenderer

$_defaultElementRenderer

staticprotected

Definition at line 45 of file Form.php.

◆ $_defaultFieldsetElementRenderer

$_defaultFieldsetElementRenderer

staticprotected

Definition at line 55 of file Form.php.

◆ $_defaultFieldsetRenderer

$_defaultFieldsetRenderer

staticprotected

Definition at line 50 of file Form.php.

◆ $_elementsIndex

$_elementsIndex

protected

Definition at line 35 of file Form.php.

◆ $formKey

$formKey

protected

Definition at line 40 of file Form.php.

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

vendor/magento/framework/Data/Form.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _elementIdExists()

◆ addElement()

◆ addElementToCollection()

◆ addFieldNameSuffix()

◆ addSuffixToName()

◆ addValues()

◆ checkElementId()

◆ getElement()

◆ getElementRenderer()

◆ getFieldContainerIdPrefix()

◆ getFieldsetElementRenderer()

◆ getFieldsetRenderer()

◆ getForm()

◆ getHtml()

◆ getHtmlAttributes()

◆ removeField()

◆ setElementRenderer()

◆ setFieldContainerIdPrefix()

◆ setFieldsetElementRenderer()

◆ setFieldsetRenderer()

◆ setValues()

◆ toHtml()

Field Documentation

◆ $_allElements

◆ $_defaultElementRenderer

◆ $_defaultFieldsetElementRenderer

◆ $_defaultFieldsetRenderer

◆ $_elementsIndex

◆ $formKey