Inheritance diagram for AbstractElement:

Public Member Functions
	__construct (Factory $factoryElement, CollectionFactory $factoryCollection, Escaper $escaper, $data=[])

	addElement (AbstractElement $element, $after=false)

	isAdvanced ()

	setAdvanced ($advanced)

	getId ()

	getType ()

	getForm ()

	setId ($id)

	getHtmlId ()

	getName ()

	setType ($type)

	setForm ($form)

	removeField ($elementId)

	getHtmlAttributes ()

	addClass ($class)

	removeClass ($class)

	getEscapedValue ($index=null)

	setRenderer (RendererInterface $renderer)

	getRenderer ()

	getElementHtml ()

	getBeforeElementHtml ()

	getAfterElementHtml ()

	getAfterElementJs ()

	getLabelHtml ($idSuffix='', $scopeLabel='')

	getDefaultHtml ()

	getHtml ()

	toHtml ()

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

	getReadonly ()

	getHtmlContainerId ()

	addElementValues ($values, $overwrite=false)

	lock ()

	isLocked ()

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)

Protected Member Functions
	_escape ($string)

	_getUiId ($suffix=null)

Protected Member Functions inherited from AbstractForm
	_construct ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_id

	$_type

	$_form

	$_elements

	$_renderer

	$_advanced = false

	$_escaper

Protected Attributes inherited from AbstractForm
	$_elements

	$_types = []

	$_factoryElement

	$_factoryCollection

	$customAttributes = []

Protected Attributes inherited from DataObject
	$_data = []

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

Detailed Description

Data form abstract class

@api

Author: Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m @SuppressWarnings(PHPMD.NumberOfChildren)

Since: 100.0.2

Definition at line 21 of file AbstractElement.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	Factory	$factoryElement,
		CollectionFactory	$factoryCollection,
		Escaper	$escaper,
			$data = `[]`
	)

Parameters

Factory	$factoryElement
CollectionFactory	$factoryCollection
Escaper	$escaper
array	$data

Definition at line 73 of file AbstractElement.php.

       {
         $this->_escaper = $escaper;
         parent::__construct($factoryElement, $factoryCollection, $data);
         $this->_renderer = \Magento\Framework\Data\Form::getElementRenderer();
     }

Member Function Documentation

◆ _escape()

_escape ( $string )

protected

Escape a string's contents.

Parameters

string $string

Returns: string

Definition at line 286 of file AbstractElement.php.

     {
         return htmlspecialchars($string, ENT_COMPAT);
     }

◆ _getUiId()

_getUiId ( $suffix = null )

protected

Parameters

null | string $suffix

Returns: string

Definition at line 333 of file AbstractElement.php.

     {
         if ($this->_renderer instanceof \Magento\Framework\View\Element\AbstractBlock) {
             return $this->_renderer->getUiId($this->getType(), $this->getName(), $suffix);
         } else {
             return ' data-ui-id="form-element-' . $this->getName() . ($suffix ?: '') . '"';
         }
     }

◆ addClass()

addClass ( $class )

Add a class.

Parameters

string $class

Returns: $this

Definition at line 257 of file AbstractElement.php.

     {
         $oldClass = $this->getClass();
         $this->setClass($oldClass . ' ' . $class);
         return $this;
     }

◆ addElement()

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

Add form element

Parameters

AbstractElement	$element
bool	$after

Returns: Form

Definition at line 91 of file AbstractElement.php.

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

◆ addElementValues()

addElementValues	(	$values,
		$overwrite = `false`
	)

Add specified values to element values

Parameters

string \| int \| array	$values
bool	$overwrite

Returns: $this @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 541 of file AbstractElement.php.

     {
         if (empty($values) || is_string($values) && trim($values) == '') {
             return $this;
         }
         if (!is_array($values)) {
             $values = $this->_escaper->escapeHtml(trim($values));
             $values = [$values => $values];
         }
         $elementValues = $this->getValues();
         if (!empty($elementValues)) {
             foreach ($values as $key => $value) {
                 if (isset($elementValues[$key]) && $overwrite || !isset($elementValues[$key])) {
                     $elementValues[$key] = $this->_escaper->escapeHtml($value);
                 }
             }
             $values = $elementValues;
         }
         $this->setValues($values);
 
         return $this;
     }

◆ getAfterElementHtml()

getAfterElementHtml ( )

Get the after element html.

Returns: mixed

Definition at line 393 of file AbstractElement.php.

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

◆ getAfterElementJs()

getAfterElementJs ( )

Get the after element Javascript.

Returns: mixed

Definition at line 403 of file AbstractElement.php.

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

◆ getBeforeElementHtml()

getBeforeElementHtml ( )

Get the before element html.

Returns: mixed

Definition at line 383 of file AbstractElement.php.

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

◆ getDefaultHtml()

getDefaultHtml ( )

Get the default html.

Returns: mixed

Definition at line 437 of file AbstractElement.php.

     {
         $html = $this->getData('default_html');
         if ($html === null) {
             $html = $this->getNoSpan() === true ? '' : '<div class="admin__field">' . "\n";
             $html .= $this->getLabelHtml();
             $html .= $this->getElementHtml();
             $html .= $this->getNoSpan() === true ? '' : '</div>' . "\n";
         }
         return $html;
     }

◆ getElementHtml()

getElementHtml ( )

Get the Html for the element.

Returns: string

Definition at line 347 of file AbstractElement.php.

     {
         $html = '';
         $htmlId = $this->getHtmlId();
 
         $beforeElementHtml = $this->getBeforeElementHtml();
         if ($beforeElementHtml) {
             $html .= '<label class="addbefore" for="' . $htmlId . '">' . $beforeElementHtml . '</label>';
         }
 
         if (is_array($this->getValue())) {
             foreach ($this->getValue() as $value) {
                 $html .= $this->getHtmlForInputByValue($this->_escape($value));
             }
         } else {
             $html .= $this->getHtmlForInputByValue($this->getEscapedValue());
         }
 
         $afterElementJs = $this->getAfterElementJs();
         if ($afterElementJs) {
             $html .= $afterElementJs;
         }
 
         $afterElementHtml = $this->getAfterElementHtml();
         if ($afterElementHtml) {
             $html .= '<label class="addafter" for="' . $htmlId . '">' . $afterElementHtml . '</label>';
         }
 
         return $html;
     }

◆ getEscapedValue()

getEscapedValue ( $index = null )

Return the escaped value of the element specified by the given index.

Parameters

null | int | string $index

Returns: string

Definition at line 297 of file AbstractElement.php.

     {
         $value = $this->getValue($index);
 
         if ($filter = $this->getValueFilter()) {
             $value = $filter->filter($value);
         }
         return $this->_escape($value);
     }

◆ getForm()

getForm ( )

Get form

Returns: Form

Definition at line 149 of file AbstractElement.php.

     {
         return $this->_form;
     }

◆ getHtml()

getHtml ( )

Get the html.

Returns: mixed

Definition at line 454 of file AbstractElement.php.

     {
         if ($this->getRequired()) {
             $this->addClass('required-entry _required');
         }
         if ($this->_renderer) {
             $html = $this->_renderer->render($this);
         } else {
             $html = $this->getDefaultHtml();
         }
         return $html;
     }

◆ getHtmlAttributes()

getHtmlAttributes ( )

Return the attributes for Html.

Returns: string[]

Definition at line 231 of file AbstractElement.php.

     {
         return [
             'type',
             'title',
             'class',
             'style',
             'onclick',
             'onchange',
             'disabled',
             'readonly',
             'tabindex',
             'placeholder',
             'data-form-part',
             'data-role',
             'data-action',
             'checked',
         ];
     }

◆ getHtmlContainerId()

getHtmlContainerId ( )

Get the container Id.

Returns: mixed

Definition at line 523 of file AbstractElement.php.

     {
         if ($this->hasData('container_id')) {
             return $this->getData('container_id');
         } elseif ($idPrefix = $this->getForm()->getFieldContainerIdPrefix()) {
             return $idPrefix . $this->getId();
         }
         return '';
     }

◆ getHtmlId()

getHtmlId ( )

Get the Html Id.

Returns: string

Definition at line 172 of file AbstractElement.php.

     {
         return $this->getForm()->getHtmlIdPrefix() . $this->getData('html_id') . $this->getForm()->getHtmlIdSuffix();
     }

◆ getId()

getId ( )

Get id.

Returns: string|int

Definition at line 129 of file AbstractElement.php.

     {
         return $this->_id;
     }

◆ getLabelHtml()

getLabelHtml	(	$idSuffix = `''`,
		$scopeLabel = `''`
	)

Render HTML for element's label

Parameters

string	$idSuffix
string	$scopeLabel

Returns: string

Definition at line 415 of file AbstractElement.php.

     {
         $scopeLabel = $scopeLabel ? ' data-config-scope="' . $scopeLabel . '"' : '';
 
         if ($this->getLabel() !== null) {
             $html = '<label class="label admin__field-label" for="' .
                 $this->getHtmlId() . $idSuffix . '"' . $this->_getUiId(
                     'label'
                 ) . '><span' . $scopeLabel . '>' . $this->_escape(
                     $this->getLabel()
                 ) . '</span></label>' . "\n";
         } else {
             $html = '';
         }
         return $html;
     }

◆ getName()

getName ( )

Get the name.

Returns: mixed

Definition at line 182 of file AbstractElement.php.

     {
         $name = $this->getData('name');
         if ($suffix = $this->getForm()->getFieldNameSuffix()) {
             $name = $this->getForm()->addSuffixToName($name, $suffix);
         }
         return $name;
     }

◆ getReadonly()

getReadonly ( )

Indicates the elements readonly status.

Returns: mixed

Definition at line 509 of file AbstractElement.php.

     {
         if ($this->hasData('readonly_disabled')) {
             return $this->_getData('readonly_disabled');
         }
 
         return $this->_getData('readonly');
     }

◆ getRenderer()

getRenderer ( )

Get the renderer.

Returns: RendererInterface

Definition at line 324 of file AbstractElement.php.

     {
         return $this->_renderer;
     }

◆ getType()

getType ( )

Get type.

Returns: string

Definition at line 139 of file AbstractElement.php.

     {
         return $this->_type;
     }

◆ isAdvanced()

isAdvanced ( )

Shows whether current element belongs to Basic or Advanced form layout

Returns: bool

Definition at line 107 of file AbstractElement.php.

     {
         return $this->_advanced;
     }

◆ isLocked()

isLocked ( )

Is element locked

Returns: bool

Definition at line 579 of file AbstractElement.php.

     {
         return $this->getData($this->lockHtmlAttribute) == 1;
     }

◆ lock()

lock ( )

Lock element

Returns: void

Definition at line 569 of file AbstractElement.php.

     {
         $this->setData($this->lockHtmlAttribute, 1);
     }

◆ removeClass()

removeClass ( $class )

Remove CSS class

Parameters

string $class

Returns: $this

Definition at line 270 of file AbstractElement.php.

     {
         $classes = array_unique(explode(' ', $this->getClass()));
         if (false !== ($key = array_search($class, $classes))) {
             unset($classes[$key]);
         }
         $this->setClass(implode(' ', $classes));
         return $this;
     }

◆ removeField()

removeField ( $elementId )

Remove field

Parameters

string $elementId

Returns: AbstractForm

Definition at line 220 of file AbstractElement.php.

     {
         $this->getForm()->removeField($elementId);
         return parent::removeField($elementId);
     }

◆ serialize()

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

Serialize the element.

Parameters

	string[]	$attributes
string	$valueSeparator
string	$fieldSeparator
string	$quote

Returns: string

Definition at line 486 of file AbstractElement.php.

     {
         if ($this->isLocked() && !empty($attributes)) {
             $attributes[] = $this->lockHtmlAttribute;
         }
         if (in_array('disabled', $attributes) && !empty($this->_data['disabled'])) {
             $this->_data['disabled'] = 'disabled';
         } else {
             unset($this->_data['disabled']);
         }
         if (in_array('checked', $attributes) && !empty($this->_data['checked'])) {
             $this->_data['checked'] = 'checked';
         } else {
             unset($this->_data['checked']);
         }
         return parent::serialize($attributes, $valueSeparator, $fieldSeparator, $quote);
     }

◆ setAdvanced()

setAdvanced ( $advanced )

Set _advanced layout property

Parameters

bool $advanced

Returns: $this

Definition at line 118 of file AbstractElement.php.

     {
         $this->_advanced = $advanced;
         return $this;
     }

◆ setForm()

setForm ( $form )

Parameters

AbstractForm $form

Returns: $this

Definition at line 208 of file AbstractElement.php.

     {
         $this->_form = $form;
         return $this;
     }

◆ setId()

setId ( $id )

Set the Id.

Parameters

string | int $id

Returns: $this

Definition at line 160 of file AbstractElement.php.

     {
         $this->_id = $id;
         $this->setData('html_id', $id);
         return $this;
     }

◆ setRenderer()

setRenderer ( RendererInterface $renderer )

Set the renderer.

Parameters

RendererInterface $renderer

Returns: $this

Definition at line 313 of file AbstractElement.php.

     {
         $this->_renderer = $renderer;
         return $this;
     }

◆ setType()

setType ( $type )

Set the type.

Parameters

string $type

Returns: $this

Definition at line 197 of file AbstractElement.php.

     {
         $this->_type = $type;
         $this->setData('type', $type);
         return $this;
     }

◆ toHtml()

toHtml ( )

Get the html.

Returns: mixed

Definition at line 472 of file AbstractElement.php.

     {
         return $this->getHtml();
     }

Field Documentation

◆ $_advanced

$_advanced = false

protected

Definition at line 53 of file AbstractElement.php.

◆ $_elements

$_elements

protected

Definition at line 41 of file AbstractElement.php.

◆ $_escaper

$_escaper

protected

Definition at line 58 of file AbstractElement.php.

◆ $_form

$_form

protected

Definition at line 36 of file AbstractElement.php.

◆ $_id

$_id

protected

Definition at line 26 of file AbstractElement.php.

◆ $_renderer

$_renderer

protected

Definition at line 46 of file AbstractElement.php.

◆ $_type

$_type

protected

Definition at line 31 of file AbstractElement.php.

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

vendor/magento/framework/Data/Form/Element/AbstractElement.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _escape()

◆ _getUiId()

◆ addClass()

◆ addElement()

◆ addElementValues()

◆ getAfterElementHtml()

◆ getAfterElementJs()

◆ getBeforeElementHtml()

◆ getDefaultHtml()

◆ getElementHtml()

◆ getEscapedValue()

◆ getForm()

◆ getHtml()

◆ getHtmlAttributes()

◆ getHtmlContainerId()

◆ getHtmlId()

◆ getId()

◆ getLabelHtml()

◆ getName()

◆ getReadonly()

◆ getRenderer()

◆ getType()

◆ isAdvanced()

◆ isLocked()

◆ lock()

◆ removeClass()

◆ removeField()

◆ serialize()

◆ setAdvanced()

◆ setForm()

◆ setId()

◆ setRenderer()

◆ setType()

◆ toHtml()

Field Documentation

◆ $_advanced

◆ $_elements

◆ $_escaper

◆ $_form

◆ $_id

◆ $_renderer

◆ $_type