Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Data Fields
StoreConfig Class Reference
Inheritance diagram for StoreConfig:
AbstractExtensibleObject StoreConfigInterface AbstractSimpleObject CustomAttributesDataInterface ExtensibleDataInterface ExtensibleDataInterface

Public Member Functions

 getId ()
 
 setId ($id)
 
 getCode ()
 
 setCode ($code)
 
 getWebsiteId ()
 
 setWebsiteId ($websiteId)
 
 getLocale ()
 
 setLocale ($locale)
 
 getBaseCurrencyCode ()
 
 setBaseCurrencyCode ($baseCurrencyCode)
 
 getDefaultDisplayCurrencyCode ()
 
 setDefaultDisplayCurrencyCode ($defaultDisplayCurrencyCode)
 
 getWeightUnit ()
 
 setWeightUnit ($weightUnit)
 
 getBaseUrl ()
 
 setBaseUrl ($baseUrl)
 
 getBaseLinkUrl ()
 
 setBaseLinkUrl ($baseLinkUrl)
 
 getTimezone ()
 
 setTimezone ($timezone)
 
 getBaseStaticUrl ()
 
 setBaseStaticUrl ($baseStaticUrl)
 
 getBaseMediaUrl ()
 
 setBaseMediaUrl ($baseMediaUrl)
 
 getSecureBaseUrl ()
 
 setSecureBaseUrl ($secureBaseUrl)
 
 getSecureBaseLinkUrl ()
 
 setSecureBaseLinkUrl ($secureBaseLinkUrl)
 
 getSecureBaseStaticUrl ()
 
 setSecureBaseStaticUrl ($secureBaseStaticUrl)
 
 getSecureBaseMediaUrl ()
 
 setSecureBaseMediaUrl ($secureBaseMediaUrl)
 
 getExtensionAttributes ()
 
 setExtensionAttributes (\Magento\Store\Api\Data\StoreConfigExtensionInterface $extensionAttributes)
 
- Public Member Functions inherited from AbstractExtensibleObject
 __construct (\Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $attributeValueFactory, $data=[])
 
 getCustomAttribute ($attributeCode)
 
 getCustomAttributes ()
 
 setCustomAttributes (array $attributes)
 
- Public Member Functions inherited from AbstractSimpleObject
 __construct (array $data=[])
 
 setData ($key, $value)
 
 __toArray ()
 
- Public Member Functions inherited from CustomAttributesDataInterface
 setCustomAttribute ($attributeCode, $attributeValue)
 
- Public Member Functions inherited from StoreConfigInterface
 setExtensionAttributes (\Magento\Store\Api\Data\StoreConfigExtensionInterface $extensionAttributes)
 

Data Fields

const KEY_ID = 'id'
 
const KEY_CODE = 'code'
 
const KEY_WEBSITE_ID = 'website_id'
 
const KEY_LOCALE = 'locale'
 
const KEY_BASE_CURRENCY_CODE = 'base_currency_code'
 
const KEY_DEFAULT_DISPLAY_CURRENCY_CODE = 'default_display_currency_code'
 
const KEY_TIMEZONE = 'timezone'
 
const KEY_WEIGHT_UNIT = 'weight_unit'
 
const KEY_BASE_URL = 'base_url'
 
const KEY_BASE_LINK_URL = 'base_link_url'
 
const KEY_BASE_STATIC_URL = 'base_static_url'
 
const KEY_BASE_MEDIA_URL = 'base_media_url'
 
const KEY_SECURE_BASE_URL = 'secure_base_url'
 
const KEY_SECURE_BASE_LINK_URL = 'secure_base_link_url'
 
const KEY_SECURE_BASE_STATIC_URL = 'secure_base_static_url'
 
const KEY_SECURE_BASE_MEDIA_URL = 'secure_base_media_url'
 
- Data Fields inherited from AbstractExtensibleObject
const CUSTOM_ATTRIBUTES_KEY = 'custom_attributes'
 
- Data Fields inherited from CustomAttributesDataInterface
const CUSTOM_ATTRIBUTES = 'custom_attributes'
 
- Data Fields inherited from ExtensibleDataInterface
const EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'
 

Additional Inherited Members

- Protected Member Functions inherited from AbstractExtensibleObject
 getCustomAttributesCodes ()
 
 _getExtensionAttributes ()
 
 _setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)
 
- Protected Member Functions inherited from AbstractSimpleObject
 _get ($key)
 
- Protected Attributes inherited from AbstractExtensibleObject
 $extensionFactory
 
 $attributeValueFactory
 
 $customAttributesCodes
 
- Protected Attributes inherited from AbstractSimpleObject
 $_data
 

Detailed Description

Class StoreConfig

@codeCoverageIgnore

Definition at line 13 of file StoreConfig.php.

Member Function Documentation

◆ getBaseCurrencyCode()

getBaseCurrencyCode ( )

Get base currency code

Returns
string

Implements StoreConfigInterface.

Definition at line 122 of file StoreConfig.php.

123  {
124  return $this->_get(self::KEY_BASE_CURRENCY_CODE);
125  }

◆ getBaseLinkUrl()

getBaseLinkUrl ( )

Get base link URL for the store

Returns
string

Implements StoreConfigInterface.

Definition at line 206 of file StoreConfig.php.

207  {
208  return $this->_get(self::KEY_BASE_LINK_URL);
209  }

◆ getBaseMediaUrl()

getBaseMediaUrl ( )

Get base media URL for the store

Returns
string

Implements StoreConfigInterface.

Definition at line 269 of file StoreConfig.php.

270  {
271  return $this->_get(self::KEY_BASE_MEDIA_URL);
272  }

◆ getBaseStaticUrl()

getBaseStaticUrl ( )

Get base static URL for the store

Returns
string

Implements StoreConfigInterface.

Definition at line 248 of file StoreConfig.php.

249  {
250  return $this->_get(self::KEY_BASE_STATIC_URL);
251  }

◆ getBaseUrl()

getBaseUrl ( )

Get base URL for the store

Returns
string

Implements StoreConfigInterface.

Definition at line 185 of file StoreConfig.php.

186  {
187  return $this->_get(self::KEY_BASE_URL);
188  }

◆ getCode()

getCode ( )

Get store code

Returns
string

Implements StoreConfigInterface.

Definition at line 59 of file StoreConfig.php.

60  {
61  return $this->_get(self::KEY_CODE);
62  }

◆ getDefaultDisplayCurrencyCode()

getDefaultDisplayCurrencyCode ( )

Get default display currency code

Returns
string

Implements StoreConfigInterface.

Definition at line 143 of file StoreConfig.php.

144  {
145  return $this->_get(self::KEY_DEFAULT_DISPLAY_CURRENCY_CODE);
146  }

◆ getExtensionAttributes()

getExtensionAttributes ( )

{Retrieve existing extension attributes object or create a new one.

Returns
\Magento\Store\Api\Data\StoreConfigExtensionInterface|null
}

Returns
\Magento\Store\Api\Data\StoreConfigExtensionInterface|null

Implements StoreConfigInterface.

Definition at line 374 of file StoreConfig.php.

◆ getId()

getId ( )

Get store id

Returns
int

Implements StoreConfigInterface.

Definition at line 38 of file StoreConfig.php.

39  {
40  return $this->_get(self::KEY_ID);
41  }

◆ getLocale()

getLocale ( )

Get store locale

Returns
string

Implements StoreConfigInterface.

Definition at line 101 of file StoreConfig.php.

102  {
103  return $this->_get(self::KEY_LOCALE);
104  }

◆ getSecureBaseLinkUrl()

getSecureBaseLinkUrl ( )

Get secure base link URL for the store

Returns
string

Implements StoreConfigInterface.

Definition at line 311 of file StoreConfig.php.

312  {
313  return $this->_get(self::KEY_SECURE_BASE_LINK_URL);
314  }

◆ getSecureBaseMediaUrl()

getSecureBaseMediaUrl ( )

Get secure base media URL for the store

Returns
string

Implements StoreConfigInterface.

Definition at line 353 of file StoreConfig.php.

354  {
355  return $this->_get(self::KEY_SECURE_BASE_MEDIA_URL);
356  }

◆ getSecureBaseStaticUrl()

getSecureBaseStaticUrl ( )

Get secure base static URL for the store

Returns
string

Implements StoreConfigInterface.

Definition at line 332 of file StoreConfig.php.

333  {
334  return $this->_get(self::KEY_SECURE_BASE_STATIC_URL);
335  }

◆ getSecureBaseUrl()

getSecureBaseUrl ( )

Get secure base URL for the store

Returns
string

Implements StoreConfigInterface.

Definition at line 290 of file StoreConfig.php.

291  {
292  return $this->_get(self::KEY_SECURE_BASE_URL);
293  }

◆ getTimezone()

getTimezone ( )

Get timezone of the store

Returns
string

Implements StoreConfigInterface.

Definition at line 227 of file StoreConfig.php.

228  {
229  return $this->_get(self::KEY_TIMEZONE);
230  }

◆ getWebsiteId()

getWebsiteId ( )

Get website id of the store

Returns
int

Implements StoreConfigInterface.

Definition at line 80 of file StoreConfig.php.

81  {
82  return $this->_get(self::KEY_WEBSITE_ID);
83  }

◆ getWeightUnit()

getWeightUnit ( )

Return the unit of weight

Returns
string

Implements StoreConfigInterface.

Definition at line 164 of file StoreConfig.php.

165  {
166  return $this->_get(self::KEY_WEIGHT_UNIT);
167  }

◆ setBaseCurrencyCode()

setBaseCurrencyCode (   $baseCurrencyCode)

Set base currency code

Parameters
string$baseCurrencyCode
Returns
$this

Implements StoreConfigInterface.

Definition at line 133 of file StoreConfig.php.

134  {
135  return $this->setData(self::KEY_BASE_CURRENCY_CODE, $baseCurrencyCode);
136  }

◆ setBaseLinkUrl()

setBaseLinkUrl (   $baseLinkUrl)

Get base link URL for the store

Parameters
string$baseLinkUrl
Returns
$this

Implements StoreConfigInterface.

Definition at line 217 of file StoreConfig.php.

218  {
219  return $this->setData(self::KEY_BASE_LINK_URL, $baseLinkUrl);
220  }

◆ setBaseMediaUrl()

setBaseMediaUrl (   $baseMediaUrl)

Set base media URL for the store

Parameters
string$baseMediaUrl
Returns
$this

Implements StoreConfigInterface.

Definition at line 280 of file StoreConfig.php.

281  {
282  return $this->setData(self::KEY_BASE_MEDIA_URL, $baseMediaUrl);
283  }

◆ setBaseStaticUrl()

setBaseStaticUrl (   $baseStaticUrl)

Set base static URL for the store

Parameters
string$baseStaticUrl
Returns
$this

Implements StoreConfigInterface.

Definition at line 259 of file StoreConfig.php.

260  {
261  return $this->setData(self::KEY_BASE_STATIC_URL, $baseStaticUrl);
262  }

◆ setBaseUrl()

setBaseUrl (   $baseUrl)

set base URL

Parameters
string$baseUrl
Returns
$this

Implements StoreConfigInterface.

Definition at line 196 of file StoreConfig.php.

197  {
198  return $this->setData(self::KEY_BASE_URL, $baseUrl);
199  }

◆ setCode()

setCode (   $code)

Set store code

Parameters
string$code
Returns
$this

Implements StoreConfigInterface.

Definition at line 70 of file StoreConfig.php.

71  {
72  return $this->setData(self::KEY_CODE, $code);
73  }
$code
Definition: info.phtml:12

◆ setDefaultDisplayCurrencyCode()

setDefaultDisplayCurrencyCode (   $defaultDisplayCurrencyCode)

Set default display currency code

Parameters
string$defaultDisplayCurrencyCode
Returns
$this

Implements StoreConfigInterface.

Definition at line 154 of file StoreConfig.php.

155  {
156  return $this->setData(self::KEY_DEFAULT_DISPLAY_CURRENCY_CODE, $defaultDisplayCurrencyCode);
157  }

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Store\Api\Data\StoreConfigExtensionInterface  $extensionAttributes)

{}

Parameters
\Magento\Store\Api\Data\StoreConfigExtensionInterface$extensionAttributes
Returns
$this

Definition at line 385 of file StoreConfig.php.

387  {
389  }
_setExtensionAttributes(\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)
$extensionAttributes
Definition: payment.php:22

◆ setId()

setId (   $id)

Set store id

Parameters
int$id
Returns
$this

Implements StoreConfigInterface.

Definition at line 49 of file StoreConfig.php.

50  {
51  return $this->setData(self::KEY_ID, $id);
52  }
$id
Definition: fieldset.phtml:14

◆ setLocale()

setLocale (   $locale)

Set store locale

Parameters
string$locale
Returns
$this

Implements StoreConfigInterface.

Definition at line 112 of file StoreConfig.php.

113  {
114  return $this->setData(self::KEY_LOCALE, $locale);
115  }

◆ setSecureBaseLinkUrl()

setSecureBaseLinkUrl (   $secureBaseLinkUrl)

Set secure base link URL for the store

Parameters
string$secureBaseLinkUrl
Returns
$this

Implements StoreConfigInterface.

Definition at line 322 of file StoreConfig.php.

323  {
324  return $this->setData(self::KEY_SECURE_BASE_LINK_URL, $secureBaseLinkUrl);
325  }

◆ setSecureBaseMediaUrl()

setSecureBaseMediaUrl (   $secureBaseMediaUrl)

Set secure base media URL for the store

Parameters
string$secureBaseMediaUrl
Returns
$this

Implements StoreConfigInterface.

Definition at line 364 of file StoreConfig.php.

365  {
366  return $this->setData(self::KEY_SECURE_BASE_MEDIA_URL, $secureBaseMediaUrl);
367  }

◆ setSecureBaseStaticUrl()

setSecureBaseStaticUrl (   $secureBaseStaticUrl)

Set secure base static URL for the store

Parameters
string$secureBaseStaticUrl
Returns
$this

Implements StoreConfigInterface.

Definition at line 343 of file StoreConfig.php.

344  {
345  return $this->setData(self::KEY_SECURE_BASE_STATIC_URL, $secureBaseStaticUrl);
346  }

◆ setSecureBaseUrl()

setSecureBaseUrl (   $secureBaseUrl)

set secure base URL

Parameters
string$secureBaseUrl
Returns
$this

Implements StoreConfigInterface.

Definition at line 301 of file StoreConfig.php.

302  {
303  return $this->setData(self::KEY_SECURE_BASE_URL, $secureBaseUrl);
304  }

◆ setTimezone()

setTimezone (   $timezone)

Set timezone of the store

Parameters
string$timezone
Returns
$this

Implements StoreConfigInterface.

Definition at line 238 of file StoreConfig.php.

239  {
240  return $this->setData(self::KEY_TIMEZONE, $timezone);
241  }

◆ setWebsiteId()

setWebsiteId (   $websiteId)

Set website id

Parameters
int$websiteId
Returns
$this

Implements StoreConfigInterface.

Definition at line 91 of file StoreConfig.php.

92  {
93  return $this->setData(self::KEY_WEBSITE_ID, $websiteId);
94  }

◆ setWeightUnit()

setWeightUnit (   $weightUnit)

Set the unit of weight

Parameters
string$weightUnit
Returns
$this

Implements StoreConfigInterface.

Definition at line 175 of file StoreConfig.php.

176  {
177  return $this->setData(self::KEY_WEIGHT_UNIT, $weightUnit);
178  }

Field Documentation

◆ KEY_BASE_CURRENCY_CODE

const KEY_BASE_CURRENCY_CODE = 'base_currency_code'

Definition at line 20 of file StoreConfig.php.

◆ KEY_BASE_LINK_URL

const KEY_BASE_LINK_URL = 'base_link_url'

Definition at line 25 of file StoreConfig.php.

◆ KEY_BASE_MEDIA_URL

const KEY_BASE_MEDIA_URL = 'base_media_url'

Definition at line 27 of file StoreConfig.php.

◆ KEY_BASE_STATIC_URL

const KEY_BASE_STATIC_URL = 'base_static_url'

Definition at line 26 of file StoreConfig.php.

◆ KEY_BASE_URL

const KEY_BASE_URL = 'base_url'

Definition at line 24 of file StoreConfig.php.

◆ KEY_CODE

const KEY_CODE = 'code'

Definition at line 17 of file StoreConfig.php.

◆ KEY_DEFAULT_DISPLAY_CURRENCY_CODE

const KEY_DEFAULT_DISPLAY_CURRENCY_CODE = 'default_display_currency_code'

Definition at line 21 of file StoreConfig.php.

◆ KEY_ID

const KEY_ID = 'id'

Definition at line 16 of file StoreConfig.php.

◆ KEY_LOCALE

const KEY_LOCALE = 'locale'

Definition at line 19 of file StoreConfig.php.

◆ KEY_SECURE_BASE_LINK_URL

const KEY_SECURE_BASE_LINK_URL = 'secure_base_link_url'

Definition at line 29 of file StoreConfig.php.

◆ KEY_SECURE_BASE_MEDIA_URL

const KEY_SECURE_BASE_MEDIA_URL = 'secure_base_media_url'

Definition at line 31 of file StoreConfig.php.

◆ KEY_SECURE_BASE_STATIC_URL

const KEY_SECURE_BASE_STATIC_URL = 'secure_base_static_url'

Definition at line 30 of file StoreConfig.php.

◆ KEY_SECURE_BASE_URL

const KEY_SECURE_BASE_URL = 'secure_base_url'

Definition at line 28 of file StoreConfig.php.

◆ KEY_TIMEZONE

const KEY_TIMEZONE = 'timezone'

Definition at line 22 of file StoreConfig.php.

◆ KEY_WEBSITE_ID

const KEY_WEBSITE_ID = 'website_id'

Definition at line 18 of file StoreConfig.php.

◆ KEY_WEIGHT_UNIT

const KEY_WEIGHT_UNIT = 'weight_unit'

Definition at line 23 of file StoreConfig.php.


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