Textarea Class Reference

Inheritance diagram for Textarea:

Public Member Functions
	__construct (Factory $factoryElement, CollectionFactory $factoryCollection, Escaper $escaper, $data=[])
	getHtmlAttributes ()
	getElementHtml ()
Public Member Functions inherited from AbstractElement
	__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)

Data Fields
const	DEFAULT_ROWS = 2
const	DEFAULT_COLS = 15

Additional Inherited Members
Protected Member Functions inherited from AbstractElement
	_escape ($string)
	_getUiId ($suffix=null)
Protected Member Functions inherited from AbstractForm
	_construct ()
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)
Protected Attributes inherited from AbstractElement
	$_id
	$_type
	$_form
	$_elements
	$_renderer
	$_advanced = false
	$_escaper
Protected Attributes inherited from AbstractForm
	$_elements
	$_types = []
	$_factoryElement
	$_factoryCollection
	$customAttributes = []
Protected Attributes inherited from DataObject
	$_data = []
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Definition at line 16 of file Textarea.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 34 of file Textarea.php.

      {
        parent::__construct($factoryElement, $factoryCollection, $escaper, $data);
        $this->setType('textarea');
        $this->setExtType('textarea');
        if (!$this->getRows()) {
            $this->setRows(self::DEFAULT_ROWS);
        }
        if (!$this->getCols()) {
            $this->setCols(self::DEFAULT_COLS);
        }
    }

Member Function Documentation

getElementHtml()

getElementHtml

(

)

Return the element as HTML

Returns

string

Definition at line 81 of file Textarea.php.

    {
        $this->addClass('textarea admin__control-textarea');
        $html = '<textarea id="' . $this->getHtmlId() . '" name="' . $this->getName() . '" '
            . $this->serialize($this->getHtmlAttributes()) . $this->_getUiId() . ' >';
        $html .= $this->getEscapedValue();
        $html .= "</textarea>";
        $html .= $this->getAfterElementHtml();
        return $html;
    }

getHtmlAttributes()

getHtmlAttributes

(

)

Return the HTML attributes

Returns

string[]

Definition at line 56 of file Textarea.php.

    {
        return [
            'title',
            'class',
            'style',
            'onclick',
            'onchange',
            'rows',
            'cols',
            'readonly',
            'disabled',
            'onkeyup',
            'tabindex',
            'data-form-part',
            'data-role',
            'data-action'
        ];
    }

Field Documentation

DEFAULT_COLS

const DEFAULT_COLS = 15

Default number of columns

Definition at line 26 of file Textarea.php.

DEFAULT_ROWS

const DEFAULT_ROWS = 2

Default number of rows

Definition at line 21 of file Textarea.php.

---

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

• vendor/magento/framework/Data/Form/Element/Textarea.php