Config Class Reference

Inheritance diagram for Config:

Data Structures
class	BaseTest
class	DataTest
class	InitialTest

Public Member Functions
	__construct (ScopeCodeResolver $scopeCodeResolver, array $types=[])
	getValue ( $path=null, $scope=ScopeConfigInterface::SCOPE_TYPE_DEFAULT, $scopeCode=null)
	isSetFlag ($path, $scope=ScopeConfigInterface::SCOPE_TYPE_DEFAULT, $scopeCode=null)
	clean ()
	get ($configType, $path='', $default=null)

Data Fields
const	CACHE_TAG = 'CONFIG'
Data Fields inherited from ScopeConfigInterface
const	SCOPE_TYPE_DEFAULT = 'default'

Detailed Description

Class Config

Definition at line 17 of file Config.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ScopeCodeResolver	$scopeCodeResolver,
		array	$types = []
	)

Config constructor.

Parameters

ScopeCodeResolver	$scopeCodeResolver
array	$types

Definition at line 40 of file Config.php.

      {
        $this->scopeCodeResolver = $scopeCodeResolver;
        $this->types = $types;
    }

Member Function Documentation

clean()

clean

(

)

Invalidate cache by type Clean scopeCodeResolver

Returns

void

Definition at line 102 of file Config.php.

    {
        foreach ($this->types as $type) {
            $type->clean();
        }
        $this->scopeCodeResolver->clean();
    }

get()

get	(		$configType,
			$path = '',
			$default = null
	)

Retrieve configuration.

('modules') - modules status configuration data ('scopes', 'websites/base') - base website data ('scopes', 'stores/default') - default store data

('system', 'default/web/seo/use_rewrites') - default system configuration data ('system', 'websites/base/web/seo/use_rewrites') - 'base' website system configuration data

('i18n', 'default/en_US') - translations for default store and 'en_US' locale

Parameters

string	$configType
string | null	$path
mixed | null	$default

Returns

array

Definition at line 127 of file Config.php.

    {
        $result = null;
        if (isset($this->types[$configType])) {
            $result = $this->types[$configType]->get($path);
        }

        return $result !== null ? $result : $default;
    }

getValue()

getValue	(		$path = null,
			$scope = ScopeConfigInterface::SCOPE_TYPE_DEFAULT,
			$scopeCode = null
	)

Retrieve config value by path and scope

Parameters

string	$path
string	$scope
null | string	$scopeCode

Returns

mixed

Implements ScopeConfigInterface.

Definition at line 56 of file Config.php.

      {
        if ($scope === 'store') {
            $scope = 'stores';
        } elseif ($scope === 'website') {
            $scope = 'websites';
        }
        $configPath = $scope;
        if ($scope !== 'default') {
            if (is_numeric($scopeCode) || $scopeCode === null) {
                $scopeCode = $this->scopeCodeResolver->resolve($scope, $scopeCode);
            } elseif ($scopeCode instanceof \Magento\Framework\App\ScopeInterface) {
                $scopeCode = $scopeCode->getCode();
            }
            if ($scopeCode) {
                $configPath .= '/' . $scopeCode;
            }
        }
        if ($path) {
            $configPath .= '/' . $path;
        }
        return $this->get('system', $configPath);
    }

isSetFlag()

isSetFlag	(		$path,
			$scope = ScopeConfigInterface::SCOPE_TYPE_DEFAULT,
			$scopeCode = null
	)

Retrieve config flag

Parameters

string	$path
string	$scope
null | string	$scopeCode

Returns

bool

Implements ScopeConfigInterface.

Definition at line 91 of file Config.php.

    {
        return !!$this->getValue($path, $scope, $scopeCode);
    }

Field Documentation

CACHE_TAG

const CACHE_TAG = 'CONFIG'

Config cache tag

Definition at line 22 of file Config.php.

---

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

• vendor/magento/framework/App/Config.php