CurrencyServiceInterface

CurrencyServiceInterface.php : 18 Copy path

The currency service is used to manage currencies in the context of storefront.

Methods¶

CurrencyServiceInterface.php : 30 Copy path

Returns list of the currencies assigned to the storefront.

public getAvailableCurrencies() : iterable<string|int, CurrencyInterface>

iterable<string|int, CurrencyInterface>

CurrencyServiceInterface.php : 23 Copy path

public getCurrencyByCode(string $code) : CurrencyInterface

Name	Type	Default value	Description
$code	string	-	-

CurrencyServiceInterface.php : 37 Copy path

Get the default currency according to user preferences.

public getDefaultCurrency() : CurrencyInterface|null

Default currency is used when no currency is set in the session.

CurrencyServiceInterface.php : 54 Copy path

Get the currency used in the current user session (or null if not set).

public getSessionCurrency() : CurrencyInterface|null

Currency stored in the session is usually manually selected by user and has higher priority than the "default" currency.

CurrencyServiceInterface.php : 66 Copy path

Checks if the currency can be used in the current storefront.

public isAcceptable(CurrencyInterface $currency) : bool

Name	Type	Default value	Description
$currency	CurrencyInterface	-	-

bool

CurrencyServiceInterface.php : 45 Copy path

Sets the default currency for the current user.

public setDefaultCurrency(CurrencyInterface|null $currency) : void

Name	Type	Default value	Description
$currency	CurrencyInterface\|null	-	-

CurrencyServiceInterface.php : 61 Copy path

Sets the currency to be used for a current user session.

public setSessionCurrency(CurrencyInterface|null $currency) : void

Currency stored in the session is usually manually selected by user and has higher priority than the "default" currency.

Name	Type	Default value	Description
$currency	CurrencyInterface\|null	-	-