CurrencyInterface Interface Reference

Inheritance diagram for CurrencyInterface:

Public Member Functions
	getGlobalCurrencyCode ()
	setGlobalCurrencyCode ($globalCurrencyCode)
	getBaseCurrencyCode ()
	setBaseCurrencyCode ($baseCurrencyCode)
	getStoreCurrencyCode ()
	setStoreCurrencyCode ($storeCurrencyCode)
	getQuoteCurrencyCode ()
	setQuoteCurrencyCode ($quoteCurrencyCode)
	getStoreToBaseRate ()
	setStoreToBaseRate ($storeToBaseRate)
	getStoreToQuoteRate ()
	setStoreToQuoteRate ($storeToQuoteRate)
	getBaseToGlobalRate ()
	setBaseToGlobalRate ($baseToGlobalRate)
	getBaseToQuoteRate ()
	setBaseToQuoteRate ($baseToQuoteRate)
	getExtensionAttributes ()
	setExtensionAttributes (\Magento\Quote\Api\Data\CurrencyExtensionInterface $extensionAttributes)

Data Fields
const	KEY_GLOBAL_CURRENCY_CODE = 'global_currency_code'
const	KEY_BASE_CURRENCY_CODE = 'base_currency_code'
const	KEY_STORE_CURRENCY_CODE = 'store_currency_code'
const	KEY_QUOTE_CURRENCY_CODE = 'quote_currency_code'
const	KEY_STORE_TO_BASE_RATE = 'store_to_base_rate'
const	KEY_STORE_TO_QUOTE_RATE = 'store_to_quote_rate'
const	KEY_BASE_TO_GLOBAL_RATE = 'base_to_global_rate'
const	KEY_BASE_TO_QUOTE_RATE = 'base_to_quote_rate'
Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Detailed Description

Interface CurrencyInterface @api

Since

100.0.2

Definition at line 13 of file CurrencyInterface.php.

Member Function Documentation

getBaseCurrencyCode()

getBaseCurrencyCode

(

)

Get base currency code

Returns

string|null

Implemented in Currency.

getBaseToGlobalRate()

getBaseToGlobalRate

(

)

Get base currency to global currency rate

Returns

float|null

Implemented in Currency.

getBaseToQuoteRate()

getBaseToQuoteRate

(

)

Get base currency to quote currency rate

Returns

float|null

Implemented in Currency.

getExtensionAttributes()

getExtensionAttributes

(

)

Retrieve existing extension attributes object or create a new one.

Returns

\Magento\Quote\Api\Data\CurrencyExtensionInterface|null

Implemented in Currency.

getGlobalCurrencyCode()

getGlobalCurrencyCode

(

)

#- Get global currency code

Returns

string|null

Implemented in Currency.

getQuoteCurrencyCode()

getQuoteCurrencyCode

(

)

Get quote currency code

Returns

string|null

Implemented in Currency.

getStoreCurrencyCode()

getStoreCurrencyCode

(

)

Get store currency code

Returns

string|null

Implemented in Currency.

getStoreToBaseRate()

getStoreToBaseRate

(

)

Get store currency to base currency rate

Returns

float|null

Implemented in Currency.

getStoreToQuoteRate()

getStoreToQuoteRate

(

)

Get store currency to quote currency rate

Returns

float|null

Implemented in Currency.

setBaseCurrencyCode()

setBaseCurrencyCode

(

$baseCurrencyCode

)

Set base currency code

Parameters

string

$baseCurrencyCode

Returns

$this

Implemented in Currency.

setBaseToGlobalRate()

setBaseToGlobalRate

(

$baseToGlobalRate

)

Set base currency to global currency rate

Parameters

float

$baseToGlobalRate

Returns

$this

Implemented in Currency.

setBaseToQuoteRate()

setBaseToQuoteRate

(

$baseToQuoteRate

)

Set base currency to quote currency rate

Parameters

float

$baseToQuoteRate

Returns

$this

Implemented in Currency.

setExtensionAttributes()

setExtensionAttributes

(

\Magento\Quote\Api\Data\CurrencyExtensionInterface

$extensionAttributes

)

Set an extension attributes object.

Parameters

\Magento\Quote\Api\Data\CurrencyExtensionInterface

$extensionAttributes

Returns

$this

setGlobalCurrencyCode()

setGlobalCurrencyCode

(

$globalCurrencyCode

)

Set global currency code

Parameters

string

$globalCurrencyCode

Returns

$this

Implemented in Currency.

setQuoteCurrencyCode()

setQuoteCurrencyCode

(

$quoteCurrencyCode

)

Set quote currency code

Parameters

string

$quoteCurrencyCode

Returns

$this

Implemented in Currency.

setStoreCurrencyCode()

setStoreCurrencyCode

(

$storeCurrencyCode

)

Set store currency code

Parameters

string

$storeCurrencyCode

Returns

$this

Implemented in Currency.

setStoreToBaseRate()

setStoreToBaseRate

(

$storeToBaseRate

)

Set store currency to base currency rate

Parameters

float

$storeToBaseRate

Returns

$this

Implemented in Currency.

setStoreToQuoteRate()

setStoreToQuoteRate

(

$storeToQuoteRate

)

Set store currency to quote currency rate

Parameters

float

$storeToQuoteRate

Returns

$this

Implemented in Currency.

Field Documentation

KEY_BASE_CURRENCY_CODE

const KEY_BASE_CURRENCY_CODE = 'base_currency_code'

Definition at line 20 of file CurrencyInterface.php.

KEY_BASE_TO_GLOBAL_RATE

const KEY_BASE_TO_GLOBAL_RATE = 'base_to_global_rate'

Definition at line 30 of file CurrencyInterface.php.

KEY_BASE_TO_QUOTE_RATE

const KEY_BASE_TO_QUOTE_RATE = 'base_to_quote_rate'

Definition at line 32 of file CurrencyInterface.php.

KEY_GLOBAL_CURRENCY_CODE

const KEY_GLOBAL_CURRENCY_CODE = 'global_currency_code'

#+ Constants defined for keys of array, makes typos less likely

Definition at line 18 of file CurrencyInterface.php.

KEY_QUOTE_CURRENCY_CODE

const KEY_QUOTE_CURRENCY_CODE = 'quote_currency_code'

Definition at line 24 of file CurrencyInterface.php.

KEY_STORE_CURRENCY_CODE

const KEY_STORE_CURRENCY_CODE = 'store_currency_code'

Definition at line 22 of file CurrencyInterface.php.

KEY_STORE_TO_BASE_RATE

const KEY_STORE_TO_BASE_RATE = 'store_to_base_rate'

Definition at line 26 of file CurrencyInterface.php.

KEY_STORE_TO_QUOTE_RATE

const KEY_STORE_TO_QUOTE_RATE = 'store_to_quote_rate'

Definition at line 28 of file CurrencyInterface.php.

---

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

• vendor/magento/module-quote/Api/Data/CurrencyInterface.php