Inheritance diagram for Form:

Public Member Functions
	__construct (\Magento\Backend\Block\Template\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Data\FormFactory $formFactory, \Magento\Config\Model\Config\Factory $configFactory, \Magento\Config\Model\Config\Structure $configStructure, \Magento\Config\Block\System\Config\Form\Fieldset\Factory $fieldsetFactory, \Magento\Config\Block\System\Config\Form\Field\Factory $fieldFactory, array $data=[])

	getConfigValue ($path)

	canUseDefaultValue ($fieldValue)

	canUseWebsiteValue ($fieldValue)

	isCanRestoreToDefault ($fieldValue)

	getScope ()

	getScopeLabel (\Magento\Config\Model\Config\Structure\Element\Field $field)

	getScopeCode ()

	getScopeId ()

	getSectionCode ()

	getWebsiteCode ()

	getStoreCode ()

	getElementVisibility ()

Public Member Functions inherited from Generic
	__construct (\Magento\Backend\Block\Template\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Data\FormFactory $formFactory, array $data=[])

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

	getForm ()

	getFormHtml ()

	setForm (\Magento\Framework\Data\Form $form)

Public Member Functions inherited from Widget
	getId ()

	getSuffixId ($suffix)

	getHtmlId ()

	getCurrentUrl ($params=[])

	getButtonHtml ($label, $onclick, $class='', $buttonId=null, $dataAttr=[])

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

Data Fields
const	SCOPE_DEFAULT = 'default'

const	SCOPE_WEBSITES = 'websites'

const	SCOPE_STORES = 'stores'

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

Protected Member Functions
	_initObjects ()

	_initGroup (\Magento\Config\Model\Config\Structure\Element\Group $group, \Magento\Config\Model\Config\Structure\Element\Section $section, \Magento\Framework\Data\Form\AbstractForm $form)

	_getDependence ()

	_initElement (\Magento\Config\Model\Config\Structure\Element\Field $field, \Magento\Framework\Data\Form\Element\Fieldset $fieldset, $path, $fieldPrefix='', $labelPrefix='')

	_generateElementName ($elementPath, $fieldPrefix='', $separator='/')

	_generateElementId ($path)

	_beforeToHtml ()

	_afterToHtml ($html)

	_getAdditionalElementTypes ()

	_getSharedCssClass (\Magento\Config\Model\Config\Structure\Element\Field $field)

	_getRequiresCssClass (\Magento\Config\Model\Config\Structure\Element\Field $field, $fieldPrefix)

Protected Member Functions inherited from Form
	_construct ()

	_prepareLayout ()

	_prepareForm ()

	_beforeToHtml ()

	_initFormValues ()

	_setFieldset ($attributes, $fieldset, $exclude=[])

	_isAttributeVisible (\Magento\Eav\Model\Entity\Attribute $attribute)

	_applyTypeSpecificConfig ($inputType, $element, \Magento\Eav\Model\Entity\Attribute $attribute)

	_addElementTypes (\Magento\Framework\Data\Form\AbstractForm $baseElement)

	_getAdditionalElementTypes ()

	_getAdditionalElementHtml ($element)

Protected Member Functions inherited from Widget
	_addBreadcrumb ($label, $title=null, $link=null)

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

	$_configDataObject

	$_fieldsetRenderer

	$_fieldRenderer

	$_fieldsets = []

	$_scopeLabels = []

	$_configFactory

	$_formFactory

	$_configStructure

	$_fieldsetFactory

	$_fieldFactory

Protected Attributes inherited from Generic
	$_formFactory

	$_coreRegistry

Protected Attributes inherited from Form
	$_form

	$_template = 'Magento_Backend::widget/form.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)

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

Detailed Description

System config form block

@SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.DepthOfInheritance) @api

Since: 100.0.2

Definition at line 25 of file Form.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Backend\Block\Template\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Data\FormFactory	$formFactory,
		\Magento\Config\Model\Config\Factory	$configFactory,
		\Magento\Config\Model\Config\Structure	$configStructure,
		\Magento\Config\Block\System\Config\Form\Fieldset\Factory	$fieldsetFactory,
		\Magento\Config\Block\System\Config\Form\Field\Factory	$fieldFactory,
		array	$data = `[]`
	)

Parameters

\Magento\Backend\Block\Template\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Data\FormFactory	$formFactory
\Magento\Config\Model\Config\Factory	$configFactory
\Magento\Config\Model\Config\Structure	$configStructure
\Magento\Config\Block\System\Config\Form\Fieldset\Factory	$fieldsetFactory
\Magento\Config\Block\System\Config\Form\Field\Factory	$fieldFactory
array	$data

Definition at line 138 of file Form.php.

       {
         parent::__construct($context, $registry, $formFactory, $data);
         $this->_configFactory = $configFactory;
         $this->_configStructure = $configStructure;
         $this->_fieldsetFactory = $fieldsetFactory;
         $this->_fieldFactory = $fieldFactory;
 
         $this->_scopeLabels = [
             self::SCOPE_DEFAULT => __('[GLOBAL]'),
             self::SCOPE_WEBSITES => __('[WEBSITE]'),
             self::SCOPE_STORES => __('[STORE VIEW]'),
         ];
     }

Member Function Documentation

◆ _afterToHtml()

_afterToHtml ( $html )

protected

Append dependence block at then end of form block

Parameters

string $html

Returns: string

Definition at line 558 of file Form.php.

     {
         if ($this->_getDependence()) {
             $html .= $this->_getDependence()->toHtml();
         }
         $html = parent::_afterToHtml($html);
         return $html;
     }

◆ _beforeToHtml()

_beforeToHtml ( )

protected

Returns: \Magento\Backend\Block\Widget\Form|\Magento\Framework\View\Element\AbstractBlock

This method is called before rendering HTML

Returns: \Magento\Backend\Block\Widget\Form

Definition at line 546 of file Form.php.

     {
         $this->initForm();
         return parent::_beforeToHtml();
     }

◆ _generateElementId()

_generateElementId ( $path )

protected

Generate element id

Parameters

string $path

Returns: string

Definition at line 527 of file Form.php.

     {
         return str_replace('/', '_', $path);
     }

◆ _generateElementName()

_generateElementName	(	$elementPath,
		$fieldPrefix = `''`,
		$separator = `'/'`
	)

protected

Generate element name

Parameters

string	$elementPath
string	$fieldPrefix
string	$separator

Returns: string

Definition at line 509 of file Form.php.

     {
         $part = explode($separator, $elementPath);
         array_shift($part);
         //shift section name
         $fieldId = array_pop($part);
         //shift filed id
         $groupName = implode('][groups][', $part);
         $name = 'groups[' . $groupName . '][fields][' . $fieldPrefix . $fieldId . '][value]';
         return $name;
     }

◆ _getAdditionalElementTypes()

_getAdditionalElementTypes ( )

protected

Get additional element types

Returns: array

Definition at line 702 of file Form.php.

     {
         return [
             'allowspecific' => \Magento\Config\Block\System\Config\Form\Field\Select\Allowspecific::class,
             'image' => \Magento\Config\Block\System\Config\Form\Field\Image::class,
             'file' => \Magento\Config\Block\System\Config\Form\Field\File::class
         ];
     }

◆ _getDependence()

_getDependence ( )

protected

Return dependency block object

Returns: \Magento\Backend\Block\Widget\Form\Element\Dependence

Definition at line 276 of file Form.php.

     {
         if (!$this->getChildBlock('element_dependence')) {
             $this->addChild('element_dependence', \Magento\Backend\Block\Widget\Form\Element\Dependence::class);
         }
         return $this->getChildBlock('element_dependence');
     }

◆ _getRequiresCssClass()

_getRequiresCssClass	(	\Magento\Config\Model\Config\Structure\Element\Field	$field,
			$fieldPrefix
	)

protected

Get css class for "requires" functionality

Parameters

\Magento\Config\Model\Config\Structure\Element\Field	$field
string	$fieldPrefix

Returns: string

Definition at line 772 of file Form.php.

     {
         $requiresClass = '';
         $requiredPaths = array_merge($field->getRequiredFields($fieldPrefix), $field->getRequiredGroups($fieldPrefix));
         if (!empty($requiredPaths)) {
             $requiresClass = ' requires';
             foreach ($requiredPaths as $requiredPath) {
                 $requiresClass .= ' requires-' . $this->_generateElementId($requiredPath);
             }
             return $requiresClass;
         }
         return $requiresClass;
     }

◆ _getSharedCssClass()

_getSharedCssClass ( \Magento\Config\Model\Config\Structure\Element\Field $field )

protected

Get css class for "shared" functionality

Parameters

\Magento\Config\Model\Config\Structure\Element\Field $field

Returns: string

Definition at line 755 of file Form.php.

     {
         $sharedClass = '';
         if ($field->getAttribute('shared') && $field->getConfigPath()) {
             $sharedClass = ' shared shared-' . str_replace('/', '-', $field->getConfigPath());
             return $sharedClass;
         }
         return $sharedClass;
     }

◆ _initElement()

_initElement	(	\Magento\Config\Model\Config\Structure\Element\Field	$field,
		\Magento\Framework\Data\Form\Element\Fieldset	$fieldset,
			$path,
			$fieldPrefix = `''`,
			$labelPrefix = `''`
	)

protected

Initialize form element

Parameters

\Magento\Config\Model\Config\Structure\Element\Field	$field
\Magento\Framework\Data\Form\Element\Fieldset	$fieldset
string	$path
string	$fieldPrefix
string	$labelPrefix

Returns: void

Definition at line 341 of file Form.php.

       {
         $inherit = !array_key_exists($path, $this->_configData);
         $data = $this->getFieldData($field, $path);
 
         $fieldRendererClass = $field->getFrontendModel();
         if ($fieldRendererClass) {
             $fieldRenderer = $this->_layout->getBlockSingleton($fieldRendererClass);
         } else {
             $fieldRenderer = $this->_fieldRenderer;
         }
 
         $fieldRenderer->setForm($this);
         $fieldRenderer->setConfigData($this->_configData);
 
         $elementName = $this->_generateElementName($field->getPath(), $fieldPrefix);
         $elementId = $this->_generateElementId($field->getPath($fieldPrefix));
 
         $dependencies = $field->getDependencies($fieldPrefix, $this->getStoreCode());
         $this->_populateDependenciesBlock($dependencies, $elementId, $elementName);
 
         $sharedClass = $this->_getSharedCssClass($field);
         $requiresClass = $this->_getRequiresCssClass($field, $fieldPrefix);
 
         $isReadOnly = $this->getElementVisibility()->isDisabled($field->getPath())
             ?: $this->getSettingChecker()->isReadOnly($path, $this->getScope(), $this->getStringScopeCode());
         $formField = $fieldset->addField(
             $elementId,
             $field->getType(),
             [
                 'name' => $elementName,
                 'label' => $field->getLabel($labelPrefix),
                 'comment' => $field->getComment($data),
                 'tooltip' => $field->getTooltip(),
                 'hint' => $field->getHint(),
                 'value' => $data,
                 'inherit' => $inherit,
                 'class' => $field->getFrontendClass() . $sharedClass . $requiresClass,
                 'field_config' => $field->getData(),
                 'scope' => $this->getScope(),
                 'scope_id' => $this->getScopeId(),
                 'scope_label' => $this->getScopeLabel($field),
                 'can_use_default_value' => $this->canUseDefaultValue($field->showInDefault()),
                 'can_use_website_value' => $this->canUseWebsiteValue($field->showInWebsite()),
                 'can_restore_to_default' => $this->isCanRestoreToDefault($field->canRestore()),
                 'disabled' => $isReadOnly,
                 'is_disable_inheritance' => $isReadOnly
             ]
         );
         $field->populateInput($formField);
 
         if ($field->hasValidation()) {
             $formField->addClass($field->getValidation());
         }
         if ($field->getType() == 'multiselect') {
             $formField->setCanBeEmpty($field->canBeEmpty());
         }
         if ($field->hasOptions()) {
             $formField->setValues($field->getOptions());
         }
         $formField->setRenderer($fieldRenderer);
     }

◆ _initGroup()

_initGroup	(	\Magento\Config\Model\Config\Structure\Element\Group	$group,
		\Magento\Config\Model\Config\Structure\Element\Section	$section,
		\Magento\Framework\Data\Form\AbstractForm	$form
	)

protected

Initialize config field group

Parameters

\Magento\Config\Model\Config\Structure\Element\Group	$group
\Magento\Config\Model\Config\Structure\Element\Section	$section
\Magento\Framework\Data\Form\AbstractForm	$form

Returns: void

Definition at line 227 of file Form.php.

       {
         $frontendModelClass = $group->getFrontendModel();
         $fieldsetRenderer = $frontendModelClass ? $this->_layout->getBlockSingleton(
             $frontendModelClass
         ) : $this->_fieldsetRenderer;
 
         $fieldsetRenderer->setForm($this);
         $fieldsetRenderer->setConfigData($this->_configData);
         $fieldsetRenderer->setGroup($group);
 
         $fieldsetConfig = [
             'legend' => $group->getLabel(),
             'comment' => $group->getComment(),
             'expanded' => $group->isExpanded(),
             'group' => $group->getData(),
         ];
 
         $fieldset = $form->addFieldset($this->_generateElementId($group->getPath()), $fieldsetConfig);
         $fieldset->setRenderer($fieldsetRenderer);
         $group->populateFieldset($fieldset);
         $this->_addElementTypes($fieldset);
 
         $dependencies = $group->getDependencies($this->getStoreCode());
         $elementName = $this->_generateElementName($group->getPath());
         $elementId = $this->_generateElementId($group->getPath());
 
         $this->_populateDependenciesBlock($dependencies, $elementId, $elementName);
 
         if ($group->shouldCloneFields()) {
             $cloneModel = $group->getCloneModel();
             foreach ($cloneModel->getPrefixes() as $prefix) {
                 $this->initFields($fieldset, $group, $section, $prefix['field'], $prefix['label']);
             }
         } else {
             $this->initFields($fieldset, $group, $section);
         }
 
         $this->_fieldsets[$group->getId()] = $fieldset;
     }

◆ _initObjects()

_initObjects ( )

protected

Initialize objects required to render config form

Returns: $this

Definition at line 178 of file Form.php.

     {
         $this->_configDataObject = $this->_configFactory->create(
             [
                 'data' => [
                     'section' => $this->getSectionCode(),
                     'website' => $this->getWebsiteCode(),
                     'store' => $this->getStoreCode(),
                 ],
             ]
         );
 
         $this->_configData = $this->_configDataObject->load();
         $this->_fieldsetRenderer = $this->_fieldsetFactory->create();
         $this->_fieldRenderer = $this->_fieldFactory->create();
         return $this;
     }

◆ canUseDefaultValue()

canUseDefaultValue ( $fieldValue )

Check if can use default value

Parameters

int $fieldValue

Returns: boolean

Definition at line 573 of file Form.php.

     {
         if ($this->getScope() == self::SCOPE_STORES && $fieldValue) {
             return true;
         }
         if ($this->getScope() == self::SCOPE_WEBSITES && $fieldValue) {
             return true;
         }
         return false;
     }

◆ canUseWebsiteValue()

canUseWebsiteValue ( $fieldValue )

Check if can use website value

Parameters

int $fieldValue

Returns: boolean

Definition at line 590 of file Form.php.

     {
         if ($this->getScope() == self::SCOPE_STORES && $fieldValue) {
             return true;
         }
         return false;
     }

◆ getConfigValue()

getConfigValue ( $path )

Get config value

Parameters

string $path

Returns: mixed

Definition at line 538 of file Form.php.

     {
         return $this->_scopeConfig->getValue($path, $this->getScope(), $this->getScopeCode());
     }

◆ getElementVisibility()

getElementVisibility ( )

Gets instance of ElementVisibilityInterface.

Returns: ElementVisibilityInterface

Deprecated:: 101.0.0 Added to not break backward compatibility of the constructor signature by injecting the new dependency directly. The method can be removed in a future major release, when constructor signature can be changed.

Since: 101.0.0

Definition at line 829 of file Form.php.

     {
         if (null === $this->elementVisibility) {
             $this->elementVisibility = ObjectManager::getInstance()->get(ElementVisibilityInterface::class);
         }
 
         return $this->elementVisibility;
     }

◆ getScope()

getScope ( )

Retrieve current scope

Returns: string

Definition at line 618 of file Form.php.

     {
         $scope = $this->getData('scope');
         if ($scope === null) {
             if ($this->getStoreCode()) {
                 $scope = self::SCOPE_STORES;
             } elseif ($this->getWebsiteCode()) {
                 $scope = self::SCOPE_WEBSITES;
             } else {
                 $scope = self::SCOPE_DEFAULT;
             }
             $this->setScope($scope);
         }
 
         return $scope;
     }

◆ getScopeCode()

getScopeCode ( )

Get current scope code

Returns: string

Definition at line 659 of file Form.php.

     {
         $scopeCode = $this->getData('scope_code');
         if ($scopeCode === null) {
             if ($this->getStoreCode()) {
                 $scopeCode = $this->getStoreCode();
             } elseif ($this->getWebsiteCode()) {
                 $scopeCode = $this->getWebsiteCode();
             } else {
                 $scopeCode = '';
             }
             $this->setScopeCode($scopeCode);
         }
 
         return $scopeCode;
     }

◆ getScopeId()

getScopeId ( )

Get current scope code

Returns: int|string

Definition at line 681 of file Form.php.

     {
         $scopeId = $this->getData('scope_id');
         if ($scopeId === null) {
             if ($this->getStoreCode()) {
                 $scopeId = $this->_storeManager->getStore($this->getStoreCode())->getId();
             } elseif ($this->getWebsiteCode()) {
                 $scopeId = $this->_storeManager->getWebsite($this->getWebsiteCode())->getId();
             } else {
                 $scopeId = '';
             }
             $this->setScopeId($scopeId);
         }
         return $scopeId;
     }

◆ getScopeLabel()

getScopeLabel ( \Magento\Config\Model\Config\Structure\Element\Field $field )

Retrieve label for scope

Parameters

\Magento\Config\Model\Config\Structure\Element\Field $field

Returns: string

Definition at line 641 of file Form.php.

     {
         $showInStore = $field->showInStore();
         $showInWebsite = $field->showInWebsite();
 
         if ($showInStore == 1) {
             return $this->_scopeLabels[self::SCOPE_STORES];
         } elseif ($showInWebsite == 1) {
             return $this->_scopeLabels[self::SCOPE_WEBSITES];
         }
         return $this->_scopeLabels[self::SCOPE_DEFAULT];
     }

◆ getSectionCode()

getSectionCode ( )

Temporary moved those $this->getRequest()->getParam('blabla') from the code across this block to getBlala() methods to be later set from controller with settersEnter description here...

@TODO delete this methods when {^see above^} is done

Returns: string

Definition at line 722 of file Form.php.

     {
         return $this->getRequest()->getParam('section', '');
     }

◆ getStoreCode()

getStoreCode ( )

Enter description here...

@TODO delete this methods when {^see above^} is done

Returns: string

Definition at line 744 of file Form.php.

     {
         return $this->getRequest()->getParam('store', '');
     }

◆ getWebsiteCode()

getWebsiteCode ( )

Enter description here...

@TODO delete this methods when {^see above^} is done

Returns: string

Definition at line 733 of file Form.php.

     {
         return $this->getRequest()->getParam('website', '');
     }

◆ isCanRestoreToDefault()

isCanRestoreToDefault ( $fieldValue )

Check if can use restore value

Parameters

int $fieldValue

Returns: bool

Since: 100.1.0

Definition at line 605 of file Form.php.

     {
         if ($this->getScope() == self::SCOPE_DEFAULT && $fieldValue) {
             return true;
         }
         return false;
     }

Field Documentation

◆ $_configData

$_configData

protected

Definition at line 38 of file Form.php.

◆ $_configDataObject

$_configDataObject

protected

Definition at line 45 of file Form.php.

◆ $_configFactory

$_configFactory

protected

Definition at line 80 of file Form.php.

◆ $_configStructure

$_configStructure

protected

Definition at line 94 of file Form.php.

◆ $_fieldFactory

$_fieldFactory

protected

Definition at line 108 of file Form.php.

◆ $_fieldRenderer

$_fieldRenderer

protected

Definition at line 59 of file Form.php.

◆ $_fieldsetFactory

$_fieldsetFactory

protected

Definition at line 101 of file Form.php.

◆ $_fieldsetRenderer

$_fieldsetRenderer

protected

Definition at line 52 of file Form.php.

◆ $_fieldsets

$_fieldsets = []

protected

Definition at line 66 of file Form.php.

◆ $_formFactory

$_formFactory

protected

Definition at line 87 of file Form.php.

◆ $_scopeLabels

$_scopeLabels = []

protected

Definition at line 73 of file Form.php.

◆ SCOPE_DEFAULT

const SCOPE_DEFAULT = 'default'

Definition at line 27 of file Form.php.

◆ SCOPE_STORES

const SCOPE_STORES = 'stores'

Definition at line 31 of file Form.php.

◆ SCOPE_WEBSITES

const SCOPE_WEBSITES = 'websites'

Definition at line 29 of file Form.php.

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _afterToHtml()

◆ _beforeToHtml()

◆ _generateElementId()

◆ _generateElementName()

◆ _getAdditionalElementTypes()

◆ _getDependence()

◆ _getRequiresCssClass()

◆ _getSharedCssClass()

◆ _initElement()

◆ _initGroup()

◆ _initObjects()

◆ canUseDefaultValue()

◆ canUseWebsiteValue()

◆ getConfigValue()

◆ getElementVisibility()

◆ getScope()

◆ getScopeCode()

◆ getScopeId()

◆ getScopeLabel()

◆ getSectionCode()

◆ getStoreCode()

◆ getWebsiteCode()

◆ isCanRestoreToDefault()

Field Documentation

◆ $_configData

◆ $_configDataObject

◆ $_configFactory

◆ $_configStructure

◆ $_fieldFactory

◆ $_fieldRenderer

◆ $_fieldsetFactory

◆ $_fieldsetRenderer

◆ $_fieldsets

◆ $_formFactory

◆ $_scopeLabels

◆ SCOPE_DEFAULT

◆ SCOPE_STORES

◆ SCOPE_WEBSITES