Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Data Fields
ScopeConfigInterface Interface Reference
Inheritance diagram for ScopeConfigInterface:
Config MutableScopeConfigInterface MutableScopeConfig Config ReinitableConfigInterface MutableScopeConfig MutableScopeConfig ReinitableConfig ReinitableConfig ReinitableConfig ReinitableConfig ReinitableConfig

Public Member Functions

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

Data Fields

const SCOPE_TYPE_DEFAULT = 'default'
 

Detailed Description

@api

Since
100.0.2

Definition at line 15 of file ScopeConfigInterface.php.

Member Function Documentation

◆ getValue()

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

Retrieve config value by path and scope.

Parameters
string$pathThe path through the tree of configuration values, e.g., 'general/store_information/name'
string$scopeTypeThe scope to use to determine config value, e.g., 'store' or 'default'
null | string$scopeCode
Returns
mixed

Implemented in Config, MutableScopeConfig, and MutableScopeConfig.

◆ isSetFlag()

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

Retrieve config flag by path and scope

Parameters
string$pathThe path through the tree of configuration values, e.g., 'general/store_information/name'
string$scopeTypeThe scope to use to determine config value, e.g., 'store' or 'default'
null | string$scopeCode
Returns
bool

Implemented in Config, and MutableScopeConfig.

Field Documentation

◆ SCOPE_TYPE_DEFAULT

const SCOPE_TYPE_DEFAULT = 'default'

Default scope type

Definition at line 20 of file ScopeConfigInterface.php.


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