Config Class Reference

Inheritance diagram for Config:

Public Member Functions
	__construct (\Magento\Framework\App\Config\ReinitableConfigInterface $config, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Config\Model\Config\Structure $configStructure, \Magento\Framework\DB\TransactionFactory $transactionFactory, \Magento\Config\Model\Config\Loader $configLoader, \Magento\Framework\App\Config\ValueFactory $configValueFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, SettingChecker $settingChecker=null, array $data=[])
	load ()
	extendConfig ($path, $full=true, $oldConfig=[])
	setDataByPath ($path, $value)
	getConfigDataValue ($path, &$inherit=null, $configData=null)
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)

Protected Member Functions
	_getConfig ($full=true)
	_checkSingleStoreMode (\Magento\Config\Model\Config\Structure\Element\Field $fieldConfig, $dataObject)
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$_configData
	$_eventManager
	$_configStructure
	$_appConfig
	$_objectFactory
	$_transactionFactory
	$_configLoader
	$_configValueFactory
	$_storeManager
Protected Attributes inherited from DataObject
	$_data = []

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

Detailed Description

Backend config model

Used to save configuration

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m @SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since

100.0.2

Definition at line 22 of file Config.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Config\ReinitableConfigInterface	$config,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Config\Model\Config\Structure	$configStructure,
		\Magento\Framework\DB\TransactionFactory	$transactionFactory,
		\Magento\Config\Model\Config\Loader	$configLoader,
		\Magento\Framework\App\Config\ValueFactory	$configValueFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		SettingChecker	$settingChecker = null,
		array	$data = []
	)

Parameters

\Magento\Framework\App\Config\ReinitableConfigInterface	$config
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Config\Model\Config\Structure	$configStructure
\Magento\Framework\DB\TransactionFactory	$transactionFactory
\Magento\Config\Model\Config\Loader	$configLoader
\Magento\Framework\App\Config\ValueFactory	$configValueFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
Config\Reader\Source\Deployed\SettingChecker | null	$settingChecker
array	$data

Definition at line 101 of file Config.php.

      {
        parent::__construct($data);
        $this->_eventManager = $eventManager;
        $this->_configStructure = $configStructure;
        $this->_transactionFactory = $transactionFactory;
        $this->_appConfig = $config;
        $this->_configLoader = $configLoader;
        $this->_configValueFactory = $configValueFactory;
        $this->_storeManager = $storeManager;
        $this->settingChecker = $settingChecker ?: ObjectManager::getInstance()->get(SettingChecker::class);
    }

Member Function Documentation

_checkSingleStoreMode()

_checkSingleStoreMode ( \Magento\Config\Model\Config\Structure\Element\Field  $fieldConfig,   $dataObject  )

protected

Set correct scope if isSingleStoreMode = true

Parameters

\Magento\Config\Model\Config\Structure\Element\Field	$fieldConfig
\Magento\Framework\App\Config\ValueInterface	$dataObject

Returns

void

Definition at line 568 of file Config.php.

      {
        $isSingleStoreMode = $this->_storeManager->isSingleStoreMode();
        if (!$isSingleStoreMode) {
            return;
        }
        if (!$fieldConfig->showInDefault()) {
            $websites = $this->_storeManager->getWebsites();
            $singleStoreWebsite = array_shift($websites);
            $dataObject->setScope('websites');
            $dataObject->setWebsiteCode($singleStoreWebsite->getCode());
            $dataObject->setScopeCode($singleStoreWebsite->getCode());
            $dataObject->setScopeId($singleStoreWebsite->getId());
        }
    }

_getConfig()

_getConfig (   $full = true )

protected

Return formatted config data for current section

Parameters

bool

$full

Simple config structure or not

Returns

array

Definition at line 551 of file Config.php.

    {
        return $this->_configLoader->getConfigByPath(
            $this->getSection(),
            $this->getScope(),
            $this->getScopeId(),
            $full
        );
    }

extendConfig()

extendConfig	(		$path,
			$full = true,
			$oldConfig = []
	)

Extend config data with additional config data by specified path

Parameters

string	$path	Config path prefix
bool	$full	Simple config structure or not
array	$oldConfig	Config data to extend

Returns

array

Definition at line 463 of file Config.php.

    {
        $extended = $this->_configLoader->getConfigByPath($path, $this->getScope(), $this->getScopeId(), $full);
        if (is_array($oldConfig) && !empty($oldConfig)) {
            return $oldConfig + $extended;
        }
        return $extended;
    }

getConfigDataValue()

getConfigDataValue	(		$path,
		&	$inherit = null,
			$configData = null
	)

Get config data value

Parameters

string	$path
null | bool	&$inherit
null | array	$configData

Returns

\Magento\Framework\Simplexml\Element

Definition at line 594 of file Config.php.

    {
        $this->load();
        if ($configData === null) {
            $configData = $this->_configData;
        }
        if (isset($configData[$path])) {
            $data = $configData[$path];
            $inherit = false;
        } else {
            $data = $this->_appConfig->getValue($path, $this->getScope(), $this->getScopeCode());
            $inherit = true;
        }

        return $data;
    }

load()

load

(

)

Load config data for section

Returns

array

Definition at line 446 of file Config.php.

    {
        if ($this->_configData === null) {
            $this->initScope();
            $this->_configData = $this->_getConfig(false);
        }
        return $this->_configData;
    }

setDataByPath()

setDataByPath	(		$path,
			$value
	)

Add data by path section/group/field

Parameters

string	$path
mixed	$value

Returns

void

Exceptions

Definition at line 480 of file Config.php.

    {
        $path = trim($path);
        if ($path === '') {
            throw new \UnexpectedValueException('Path must not be empty');
        }
        $pathParts = explode('/', $path);
        $keyDepth = count($pathParts);
        if ($keyDepth !== 3) {
            throw new \UnexpectedValueException(
                "Allowed depth of configuration is 3 (<section>/<group>/<field>). Your configuration depth is "
                . $keyDepth . " for path '$path'"
            );
        }
        $data = [
            'section' => $pathParts[0],
            'groups' => [
                $pathParts[1] => [
                    'fields' => [
                        $pathParts[2] => ['value' => $value],
                    ],
                ],
            ],
        ];
        $this->addData($data);
    }

Field Documentation

$_appConfig

$_appConfig

protected

Definition at line 50 of file Config.php.

$_configData

$_configData

protected

Definition at line 29 of file Config.php.

$_configLoader

$_configLoader

protected

Definition at line 71 of file Config.php.

$_configStructure

$_configStructure

protected

Definition at line 43 of file Config.php.

$_configValueFactory

$_configValueFactory

protected

Definition at line 78 of file Config.php.

$_eventManager

$_eventManager

protected

Definition at line 36 of file Config.php.

$_objectFactory

$_objectFactory

protected

Definition at line 57 of file Config.php.

$_storeManager

$_storeManager

protected

Definition at line 83 of file Config.php.

$_transactionFactory

$_transactionFactory

protected

Definition at line 64 of file Config.php.

---

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

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