AbstractFieldArray Class Reference

Inheritance diagram for AbstractFieldArray:

Public Member Functions
	addColumn ($name, $params)
	renderCellTemplate ($columnName)
	isAddAfter ()
	getColumns ()
	getAddButtonLabel ()
Public Member Functions inherited from Field
	render (\Magento\Framework\Data\Form\Element\AbstractElement $element)
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 ()
Public Member Functions inherited from RendererInterface
	render (\Magento\Framework\Data\Form\Element\AbstractElement $element)

Protected Member Functions
	_construct ()
	_getParam ($params, $paramName, $defaultValue=null)
	_getElementHtml (\Magento\Framework\Data\Form\Element\AbstractElement $element)
	_prepareArrayRow (\Magento\Framework\DataObject $row)
	_getCellInputElementId ($rowId, $columnName)
	_getCellInputElementName ($columnName)
	_prepareToRender ()
	_toHtml ()
Protected Member Functions inherited from Field
	_getElementHtml (\Magento\Framework\Data\Form\Element\AbstractElement $element)
	_renderValue (\Magento\Framework\Data\Form\Element\AbstractElement $element)
	_renderInheritCheckbox (\Magento\Framework\Data\Form\Element\AbstractElement $element)
	_isInheritCheckboxRequired (\Magento\Framework\Data\Form\Element\AbstractElement $element)
	_getInheritCheckboxLabel (\Magento\Framework\Data\Form\Element\AbstractElement $element)
	_renderScopeLabel (\Magento\Framework\Data\Form\Element\AbstractElement $element)
	_renderHint (\Magento\Framework\Data\Form\Element\AbstractElement $element)
	_decorateRowHtml (\Magento\Framework\Data\Form\Element\AbstractElement $element, $html)
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
	$_columns = []
	$_addAfter = true
	$_addButtonLabel
	$_isPreparedToRender = false
	$_template = 'Magento_Config::system/config/form/field/array.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 system config array field renderer

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m @api

Since

100.0.2

Definition at line 16 of file AbstractFieldArray.php.

Member Function Documentation

_construct()

_construct ( )

protected

Check if columns are defined, set template

Returns

void

Definition at line 63 of file AbstractFieldArray.php.

    {
        if (!$this->_addButtonLabel) {
            $this->_addButtonLabel = __('Add');
        }
        parent::_construct();
    }

_getCellInputElementId()

_getCellInputElementId (   $rowId,   $columnName  )

protected

Get name for cell element

Parameters

string	$rowId
string	$columnName

Returns

string

Definition at line 173 of file AbstractFieldArray.php.

    {
        return $rowId . '_' . $columnName;
    }

_getCellInputElementName()

_getCellInputElementName (   $columnName )

protected

Get id for cell element

Parameters

string

$columnName

Returns

string

Definition at line 184 of file AbstractFieldArray.php.

    {
        return $this->getElement()->getName() . '[<%- _id %>][' . $columnName . ']';
    }

_getElementHtml()

_getElementHtml ( \Magento\Framework\Data\Form\Element\AbstractElement  $element )

protected

Get the grid and scripts contents

Parameters

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

$element

Returns

string

Definition at line 113 of file AbstractFieldArray.php.

    {
        $this->setElement($element);
        $html = $this->_toHtml();
        $this->_arrayRowsCache = null;
        // doh, the object is used as singleton!
        return $html;
    }

_getParam()

_getParam (   $params,   $paramName,   $defaultValue = null  )

protected

Retrieve param

Parameters

array	$params
string	$paramName
string | bool	$defaultValue

Returns

string|bool

Definition at line 102 of file AbstractFieldArray.php.

    {
        return empty($params[$paramName]) ? $defaultValue : $params[$paramName];
    }

_prepareArrayRow()

_prepareArrayRow ( \Magento\Framework\DataObject  $row )

protected

Prepare existing row data object

Parameters

\Magento\Framework\DataObject

$row

Returns

void @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 129 of file AbstractFieldArray.php.

    {
        // override in descendants
    }

_prepareToRender()

_prepareToRender ( )

protected

Prepare to render

Returns

void

Definition at line 240 of file AbstractFieldArray.php.

    {
        // Override in descendants to add columns, change add button label etc
    }

_toHtml()

_toHtml ( )

protected

Render block HTML

Returns

string

Exceptions

Definition at line 251 of file AbstractFieldArray.php.

    {
        if (!$this->_isPreparedToRender) {
            $this->_prepareToRender();
            $this->_isPreparedToRender = true;
        }
        if (empty($this->_columns)) {
            throw new \Exception('At least one column must be defined.');
        }
        return parent::_toHtml();
    }

addColumn()

addColumn	(		$name,
			$params
	)

Add a column to array-grid

Parameters

string	$name
array	$params

Returns

void

Definition at line 78 of file AbstractFieldArray.php.

    {
        $this->_columns[$name] = [
            'label' => $this->_getParam($params, 'label', 'Column'),
            'size' => $this->_getParam($params, 'size', false),
            'style' => $this->_getParam($params, 'style'),
            'class' => $this->_getParam($params, 'class'),
            'renderer' => false,
        ];
        if (!empty($params['renderer'])
            && $params['renderer'] instanceof \Magento\Framework\View\Element\AbstractBlock
        ) {
            $this->_columns[$name]['renderer'] = $params['renderer'];
        }
    }

getAddButtonLabel()

getAddButtonLabel

(

)

Returns

string

Since

101.0.0

Definition at line 287 of file AbstractFieldArray.php.

    {
        return $this->_addButtonLabel;
    }

getColumns()

getColumns

(

)

Returns columns array

Returns

array

Definition at line 278 of file AbstractFieldArray.php.

    {
        return $this->_columns;
    }

isAddAfter()

isAddAfter

(

)

Returns true if the addAfter directive is set

Returns

bool

Definition at line 268 of file AbstractFieldArray.php.

    {
        return $this->_addAfter;
    }

renderCellTemplate()

renderCellTemplate

(

$columnName

)

Render array cell for prototypeJS template

Parameters

string

$columnName

Returns

string

Exceptions

Definition at line 196 of file AbstractFieldArray.php.

    {
        if (empty($this->_columns[$columnName])) {
            throw new \Exception('Wrong column name specified.');
        }
        $column = $this->_columns[$columnName];
        $inputName = $this->_getCellInputElementName($columnName);

        if ($column['renderer']) {
            return $column['renderer']->setInputName(
                $inputName
            )->setInputId(
                $this->_getCellInputElementId('<%- _id %>', $columnName)
            )->setColumnName(
                $columnName
            )->setColumn(
                $column
            )->toHtml();
        }

        return '<input type="text" id="' . $this->_getCellInputElementId(
            '<%- _id %>',
            $columnName
        ) .
            '"' .
            ' name="' .
            $inputName .
            '" value="<%- ' .
            $columnName .
            ' %>" ' .
            ($column['size'] ? 'size="' .
            $column['size'] .
            '"' : '') .
            ' class="' .
            (isset($column['class'])
                ? $column['class']
                : 'input-text') . '"' . (isset($column['style']) ? ' style="' . $column['style'] . '"' : '') . '/>';
    }

Field Documentation

$_addAfter

$_addAfter = true

protected

Definition at line 30 of file AbstractFieldArray.php.

$_addButtonLabel

$_addButtonLabel

protected

Definition at line 37 of file AbstractFieldArray.php.

$_columns

$_columns = []

protected

Definition at line 23 of file AbstractFieldArray.php.

$_isPreparedToRender

$_isPreparedToRender = false

protected

Definition at line 51 of file AbstractFieldArray.php.

$_template

$_template = 'Magento_Config::system/config/form/field/array.phtml'

protected

Definition at line 56 of file AbstractFieldArray.php.

---

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

• vendor/magento/module-config/Block/System/Config/Form/Field/FieldArray/AbstractFieldArray.php