Inheritance diagram for Structure:

Public Member Functions
	__construct (\Magento\Config\Model\Config\Structure\Data $structureData, \Magento\Config\Model\Config\Structure\Element\Iterator\Tab $tabIterator, \Magento\Config\Model\Config\Structure\Element\FlyweightFactory $flyweightFactory, ScopeDefiner $scopeDefiner)

	getTabs ()

	getSectionList ()

	getElement ($path)

	getElementByConfigPath ($path)

	getElementByPathParts (array $pathParts)

	getFieldPathsByAttribute ($attributeName, $attributeValue)

	getFieldPaths ()

Data Fields
const	TYPE_KEY = '_elementType'

Protected Member Functions
	_createEmptyElement (array $pathParts)

	_getGroupFieldPathsByAttribute (array $fields, $parentPath, $attributeName, $attributeValue)

Protected Attributes
	$_data

	$_tabIterator

	$_flyweightFactory

	$_scopeDefiner

	$_elements

	$sectionList

Detailed Description

System configuration structure.

All paths are declared in module's system.xml.

<section id="section_id">
     <group id="group_id" ...>
         <field id="field_one_id" ...>
             <label>Field One</label>
             ...
         </field>
         <field id="field_two_id" ...>
             <label>Field Two</label>
             <config_path>section/group/field</config_path>
             ...
         </field>
     </group>
</section>

Structure path is the nested path of node ids (section, group, field).

Config path is the path which is declared in <config_path> node. If this node is not provided then config path is the same as structure path.

With the example above you can see that the field <field id="field_one_id"> has the next paths:

the structure path section_id/group_id/field_one_id
the configuration path section_id/group_id/field_one_id

Also you can see that the field <field id="field_two_id"> has the next paths:

the structure path section_id/group_id/field_two_id
the configuration path section/group/field

@api

Since: 100.0.2

Definition at line 47 of file Structure.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Config\Model\Config\Structure\Data	$structureData,
		\Magento\Config\Model\Config\Structure\Element\Iterator\Tab	$tabIterator,
		\Magento\Config\Model\Config\Structure\Element\FlyweightFactory	$flyweightFactory,
		ScopeDefiner	$scopeDefiner
	)

Parameters

\Magento\Config\Model\Config\Structure\Data	$structureData
\Magento\Config\Model\Config\Structure\Element\Iterator\Tab	$tabIterator
\Magento\Config\Model\Config\Structure\Element\FlyweightFactory	$flyweightFactory
ScopeDefiner	$scopeDefiner

Definition at line 121 of file Structure.php.

       {
         $this->_data = $structureData->get();
         $this->_tabIterator = $tabIterator;
         $this->_flyweightFactory = $flyweightFactory;
         $this->_scopeDefiner = $scopeDefiner;
     }

Member Function Documentation

◆ _createEmptyElement()

_createEmptyElement ( array $pathParts )

protected

Create empty element data

Parameters

string[] $pathParts

Returns: array

Definition at line 258 of file Structure.php.

     {
         switch (count($pathParts)) {
             case 1:
                 $elementType = 'section';
                 break;
             case 2:
                 $elementType = 'group';
                 break;
             default:
                 $elementType = 'field';
         }
         $elementId = array_pop($pathParts);
         return ['id' => $elementId, 'path' => implode('/', $pathParts), '_elementType' => $elementType];
     }

◆ _getGroupFieldPathsByAttribute()

_getGroupFieldPathsByAttribute	(	array	$fields,
			$parentPath,
			$attributeName,
			$attributeValue
	)

protected

Find group fields with specified attribute and attribute value

Parameters

array	$fields
string	$parentPath
string	$attributeName
mixed	$attributeValue

Returns: array

Definition at line 319 of file Structure.php.

     {
         $result = [];
         foreach ($fields as $field) {
             if (isset($field['children'])) {
                 $result += $this->_getGroupFieldPathsByAttribute(
                     $field['children'],
                     $parentPath . '/' . $field['id'],
                     $attributeName,
                     $attributeValue
                 );
             } elseif (isset($field[$attributeName]) && $field[$attributeName] == $attributeValue) {
                 $result[] = $parentPath . '/' . $field['id'];
             }
         }
         return $result;
     }

◆ getElement()

getElement ( $path )

Find element by structure path

Parameters

string $path The structure path

Returns: \Magento\Config\Model\Config\Structure\ElementInterface|null

Implements SearchInterface.

Definition at line 178 of file Structure.php.

     {
         return $this->getElementByPathParts(explode('/', $path));
     }

◆ getElementByConfigPath()

getElementByConfigPath ( $path )

Find element by config path

Parameters

string $path The configuration path

Returns: \Magento\Config\Model\Config\Structure\ElementInterface|null

Since: 101.0.0

Definition at line 190 of file Structure.php.

     {
         $allPaths = $this->getFieldPaths();
 
         if (isset($allPaths[$path])) {
             $path = array_shift($allPaths[$path]);
         }
 
         return $this->getElementByPathParts(explode('/', $path));
     }

◆ getElementByPathParts()

getElementByPathParts ( array $pathParts )

Find element by path parts

Parameters

string[] $pathParts

Returns: \Magento\Config\Model\Config\Structure\ElementInterface|null

Definition at line 227 of file Structure.php.

     {
         $path = implode('_', $pathParts);
         if (isset($this->_elements[$path])) {
             return $this->_elements[$path];
         }
         $children = [];
         if ($this->_data) {
             $children = $this->_data['sections'];
         }
         $child = [];
         foreach ($pathParts as $pathPart) {
             if ($children && (array_key_exists($pathPart, $children))) {
                 $child = $children[$pathPart];
                 $children = array_key_exists('children', $child) ? $child['children'] : [];
             } else {
                 $child = $this->_createEmptyElement($pathParts);
                 break;
             }
         }
         $this->_elements[$path] = $this->_flyweightFactory->create($child['_elementType']);
         $this->_elements[$path]->setData($child, $this->_scopeDefiner->getScope());
         return $this->_elements[$path];
     }

◆ getFieldPaths()

getFieldPaths ( )

Collects config paths and their structure paths from configuration files. Returns the map of config paths and their structure paths.

All paths are declared in module's system.xml.

<section id="section_id">
     <group id="group_id" ...>
         <field id="field_one_id" ...>
             <label>Field One</label>
             ...
         </field>
         <field id="field_two_id" ...>
             <label>Field Two</label>
             <config_path>section/group/field</config_path>
             ...
         </field>
     </group>
</section>

If <config_path> node does not exist, then config path duplicates structure path. The result of this example will be:

[
 'section_id/group_id/field_one_id' => [
     'section_id/group_id/field_one_id'
 ],
'section/group/field' => [
     'section_id/group_id/field_two_id'
]

Returns: array An array of config path to config structure path map

Since: 101.0.0

Definition at line 374 of file Structure.php.

     {
         $sections = !empty($this->_data['sections']) ? $this->_data['sections'] : [];
 
         if (!$this->mappedPaths) {
             $this->mappedPaths = $this->getFieldsRecursively($sections);
         }
 
         return $this->mappedPaths;
     }

◆ getFieldPathsByAttribute()

getFieldPathsByAttribute	(	$attributeName,
		$attributeValue
	)

Retrieve paths of fields that have provided attributes with provided values

Parameters

string	$attributeName
mixed	$attributeValue

Returns: array

Definition at line 281 of file Structure.php.

     {
         $result = [];
         if (empty($this->_data['sections'])) {
             return $result;
         }
 
         foreach ($this->_data['sections'] as $section) {
             if (!isset($section['children'])) {
                 continue;
             }
             foreach ($section['children'] as $group) {
                 if (isset($group['children'])) {
                     $path = $section['id'] . '/' . $group['id'];
                     $result = array_merge(
                         $result,
                         $this->_getGroupFieldPathsByAttribute(
                             $group['children'],
                             $path,
                             $attributeName,
                             $attributeValue
                         )
                     );
                 }
             }
         }
         return $result;
     }

◆ getSectionList()

getSectionList ( )

Retrieve config section list

Returns: array @SuppressWarnings(PHPMD.UnusedLocalVariable)

Since: 100.1.0

Definition at line 158 of file Structure.php.

     {
         if (empty($this->sectionList)) {
             foreach ($this->_data['sections'] as $sectionId => $section) {
                 if (array_key_exists('children', $section) && is_array($section['children'])) {
                     foreach ($section['children'] as $childId => $child) {
                         $this->sectionList[$sectionId . '_' . $childId] = true;
                     }
                 }
             }
         }
         return $this->sectionList;
     }

◆ getTabs()

getTabs ( )

Retrieve tab iterator

Returns: \Magento\Config\Model\Config\Structure\Element\Iterator

Definition at line 138 of file Structure.php.

     {
         if (isset($this->_data['sections'])) {
             foreach ($this->_data['sections'] as $sectionId => $section) {
                 if (isset($section['tab']) && $section['tab']) {
                     $this->_data['tabs'][$section['tab']]['children'][$sectionId] = $section;
                 }
             }
             $this->_tabIterator->setElements($this->_data['tabs'], $this->_scopeDefiner->getScope());
         }
         return $this->_tabIterator;
     }

Field Documentation

◆ $_data

$_data

protected

Definition at line 59 of file Structure.php.

◆ $_elements

$_elements

protected

Definition at line 87 of file Structure.php.

◆ $_flyweightFactory

$_flyweightFactory

protected

Definition at line 73 of file Structure.php.

◆ $_scopeDefiner

$_scopeDefiner

protected

Definition at line 80 of file Structure.php.

◆ $_tabIterator

$_tabIterator

protected

Definition at line 66 of file Structure.php.

◆ $sectionList

$sectionList

protected

Definition at line 95 of file Structure.php.

◆ TYPE_KEY

const TYPE_KEY = '_elementType'

Key that contains field type in structure array

Definition at line 52 of file Structure.php.

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

vendor/magento/module-config/Model/Config/Structure.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _createEmptyElement()

◆ _getGroupFieldPathsByAttribute()

◆ getElement()

◆ getElementByConfigPath()

◆ getElementByPathParts()

◆ getFieldPaths()

◆ getFieldPathsByAttribute()

◆ getSectionList()

◆ getTabs()

Field Documentation

◆ $_data

◆ $_elements

◆ $_flyweightFactory

◆ $_scopeDefiner

◆ $_tabIterator

◆ $sectionList

◆ TYPE_KEY