Inheritance diagram for Fieldset:

Public Member Functions
	__construct (\Magento\Backend\Block\Context $context, \Magento\Backend\Model\Auth\Session $authSession, \Magento\Framework\View\Helper\Js $jsHelper, array $data=[])

	render (AbstractElement $element)

Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Backend\Block\Context $context, array $data=[])

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
	_getChildrenElementsHtml (AbstractElement $element)

	_getHeaderHtml ($element)

	_getFrontendClass ($element)

	_getHeaderTitleHtml ($element)

	_getHeaderCommentHtml ($element)

	_getFooterHtml ($element)

	_getExtraJs ($element)

	_isCollapseState ($element)

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
	$_authSession

	$_jsHelper

	$isCollapsedDefault = false

Protected Attributes inherited from AbstractBlock
	$_authorization

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 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

@api

Since: 100.0.2

Definition at line 18 of file Fieldset.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Backend\Block\Context	$context,
		\Magento\Backend\Model\Auth\Session	$authSession,
		\Magento\Framework\View\Helper\Js	$jsHelper,
		array	$data = `[]`
	)

Parameters

\Magento\Backend\Block\Context	$context
\Magento\Backend\Model\Auth\Session	$authSession
\Magento\Framework\View\Helper\Js	$jsHelper
array	$data

Definition at line 44 of file Fieldset.php.

       {
         $this->_jsHelper = $jsHelper;
         $this->_authSession = $authSession;
         parent::__construct($context, $data);
     }

Member Function Documentation

◆ _getChildrenElementsHtml()

_getChildrenElementsHtml ( AbstractElement $element )

protected

Parameters

AbstractElement $element

Returns: string

Since: 100.1.0

Definition at line 78 of file Fieldset.php.

     {
         $elements = '';
         foreach ($element->getElements() as $field) {
             if ($field instanceof \Magento\Framework\Data\Form\Element\Fieldset) {
                 $elements .= '<tr id="row_' . $field->getHtmlId() . '">'
                     . '<td colspan="4">' . $field->toHtml() . '</td></tr>';
             } else {
                 $elements .= $field->toHtml();
             }
         }
 
         return $elements;
     }

◆ _getExtraJs()

_getExtraJs ( $element )

protected

Return js code for fieldset:

observe fieldset rows;
apply collapse;

Parameters

AbstractElement $element

Returns: string

Definition at line 232 of file Fieldset.php.

     {
         $htmlId = $element->getHtmlId();
         $output = "require(['prototype'], function(){Fieldset.applyCollapse('{$htmlId}');});";
         return $this->_jsHelper->getScript($output);
     }

◆ _getFooterHtml()

_getFooterHtml ( $element )

protected

Return footer html for fieldset Add extra tooltip comments to elements

Parameters

AbstractElement $element

Returns: string

Definition at line 202 of file Fieldset.php.

     {
         $html = '</tbody></table>';
         foreach ($element->getElements() as $field) {
             if ($field->getTooltip()) {
                 $html .= sprintf(
                     '<div id="row_%s_comment" class="system-tooltip-box" style="display:none;">%s</div>',
                     $field->getId(),
                     $field->getTooltip()
                 );
             }
         }
         $html .= '</fieldset>' . $this->_getExtraJs($element);
 
         if ($element->getIsNested()) {
             $html .= '</td></tr>';
         } else {
             $html .= '</div>';
         }
         return $html;
     }

◆ _getFrontendClass()

_getFrontendClass ( $element )

protected

Get frontend class

Parameters

AbstractElement $element

Returns: string

Definition at line 144 of file Fieldset.php.

     {
         $group = $element->getGroup();
         $cssClass = isset($group['fieldset_css']) ? $group['fieldset_css'] : '';
         return 'section-config' . (empty($cssClass) ? '' : ' ' . $cssClass);
     }

◆ _getHeaderCommentHtml()

_getHeaderCommentHtml ( $element )

protected

Return header comment part of html for fieldset

Parameters

AbstractElement $element

Returns: string

Definition at line 177 of file Fieldset.php.

     {
         return $element->getComment() ? '<div class="comment">' . $element->getComment() . '</div>' : '';
     }

◆ _getHeaderHtml()

_getHeaderHtml ( $element )

protected

Return header html for fieldset

Parameters

AbstractElement $element

Returns: string

Definition at line 99 of file Fieldset.php.

     {
         if ($element->getIsNested()) {
             $html = '<tr class="nested"><td colspan="4"><div class="' . $this->_getFrontendClass($element) . '">';
         } else {
             $html = '<div class="' . $this->_getFrontendClass($element) . '">';
         }
 
         $html .= '<div class="entry-edit-head admin__collapsible-block">' .
             '<span id="' .
             $element->getHtmlId() .
             '-link" class="entry-edit-head-link"></span>';
 
         $html .= $this->_getHeaderTitleHtml($element);
 
         $html .= '</div>';
         $html .= '<input id="' .
             $element->getHtmlId() .
             '-state" name="config_state[' .
             $element->getId() .
             ']" type="hidden" value="' .
             (int)$this->_isCollapseState(
                 $element
             ) . '" />';
         $html .= '<fieldset class="' . $this->_getFieldsetCss() . '" id="' . $element->getHtmlId() . '">';
         $html .= '<legend>' . $element->getLegend() . '</legend>';
 
         $html .= $this->_getHeaderCommentHtml($element);
 
         // field label column
         $html .= '<table cellspacing="0" class="form-list"><colgroup class="label" /><colgroup class="value" />';
         if ($this->getRequest()->getParam('website') || $this->getRequest()->getParam('store')) {
             $html .= '<colgroup class="use-default" />';
         }
         $html .= '<colgroup class="scope-label" /><colgroup class="" /><tbody>';
 
         return $html;
     }

◆ _getHeaderTitleHtml()

_getHeaderTitleHtml ( $element )

protected

Return header title part of html for fieldset

Parameters

AbstractElement $element

Returns: string

Definition at line 157 of file Fieldset.php.

     {
         return '<a id="' .
             $element->getHtmlId() .
             '-head" href="#' .
             $element->getHtmlId() .
             '-link" onclick="Fieldset.toggleCollapse(\'' .
             $element->getHtmlId() .
             '\', \'' .
             $this->getUrl(
                 '*/*/state'
             ) . '\'); return false;">' . $element->getLegend() . '</a>';
     }

◆ _isCollapseState()

_isCollapseState ( $element )

protected

Collapsed or expanded fieldset when page loaded?

Parameters

AbstractElement $element

Returns: bool

Definition at line 245 of file Fieldset.php.

     {
         if ($element->getExpanded() ||
             ($element->getForm() && $element->getForm()->getElements()->count() === 1)
         ) {
             return true;
         }
 
         $extra = $this->_authSession->getUser()->getExtra();
         if (isset($extra['configState'][$element->getId()])) {
             return $extra['configState'][$element->getId()];
         }
         return $this->isCollapsedDefault;
     }

◆ render()

render ( AbstractElement $element )

Render fieldset html

Parameters

AbstractElement $element

Returns: string

Definition at line 61 of file Fieldset.php.

     {
         $this->setElement($element);
         $header = $this->_getHeaderHtml($element);
 
         $elements = $this->_getChildrenElementsHtml($element);
 
         $footer = $this->_getFooterHtml($element);
 
         return $header . $elements . $footer;
     }

Field Documentation

◆ $_authSession

$_authSession

protected

Definition at line 24 of file Fieldset.php.

◆ $_jsHelper

$_jsHelper

protected

Definition at line 29 of file Fieldset.php.

◆ $isCollapsedDefault

$isCollapsedDefault = false

protected

Definition at line 36 of file Fieldset.php.

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

vendor/magento/module-config/Block/System/Config/Form/Fieldset.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getChildrenElementsHtml()

◆ _getExtraJs()

◆ _getFooterHtml()

◆ _getFrontendClass()

◆ _getHeaderCommentHtml()

◆ _getHeaderHtml()

◆ _getHeaderTitleHtml()

◆ _isCollapseState()

◆ render()

Field Documentation

◆ $_authSession

◆ $_jsHelper

◆ $isCollapsedDefault