Bitrix API

CurrencyManager

Class CurrencyTable

Table of Contents

Constants

CACHE_BASE_CURRENCY_ID  = 'currency_base_currency'
CACHE_CURRENCY_LIST_ID  = 'currency_currency_list'
CACHE_CURRENCY_NAME_LIST_ID  = 'currency_name_list_'
CACHE_CURRENCY_SHORT_LIST_ID  = 'currency_short_list_'
CACHE_CURRENCY_SYMBOL_LIST_ID  = 'currency_symbol_list_'
EVENT_ON_AFTER_UPDATE_BASE_CURRENCY  = 'onAfterUpdateBaseCurrency'
EVENT_ON_AFTER_UPDATE_BASE_RATE  = 'onAfterUpdateCurrencyBaseRate'
EVENT_ON_UPDATE_BASE_CURRENCY  = 'onUpdateBaseCurrency'

Methods

checkCurrencyID()  : bool|string
Check currency id.
checkLanguage()  : bool|string
Check language id.
clearCurrencyCache()  : void
Clear currency cache.
clearTagCache()  : void
Clear tag currency cache.
currencyBaseRateAgent()  : string
Agent for update current currencies rates to base currency.
getBaseCurrency()  : string
Return base currency.
getCurrencyList()  : array<string|int, mixed>
Return currency short list.
getInstalledCurrencies()  : array<string|int, mixed>
Return currency list, create to install module.
getNameList()  : array<string|int, mixed>
Returns currency name list.
getSymbolList()  : array<string|int, mixed>
Returns currency symbol list.
isCurrencyExist()  : bool
Verifying the existence of the currency by its code.
updateBaseCurrency()  : bool
Update base currency.
updateBaseRates()  : void
Update current currencies rates to base currency.

Constants

CACHE_BASE_CURRENCY_ID

public mixed CACHE_BASE_CURRENCY_ID = 'currency_base_currency'

CACHE_CURRENCY_LIST_ID

public mixed CACHE_CURRENCY_LIST_ID = 'currency_currency_list'

CACHE_CURRENCY_NAME_LIST_ID

public mixed CACHE_CURRENCY_NAME_LIST_ID = 'currency_name_list_'

CACHE_CURRENCY_SHORT_LIST_ID

public mixed CACHE_CURRENCY_SHORT_LIST_ID = 'currency_short_list_'

CACHE_CURRENCY_SYMBOL_LIST_ID

public mixed CACHE_CURRENCY_SYMBOL_LIST_ID = 'currency_symbol_list_'

EVENT_ON_AFTER_UPDATE_BASE_CURRENCY

public mixed EVENT_ON_AFTER_UPDATE_BASE_CURRENCY = 'onAfterUpdateBaseCurrency'

EVENT_ON_AFTER_UPDATE_BASE_RATE

public mixed EVENT_ON_AFTER_UPDATE_BASE_RATE = 'onAfterUpdateCurrencyBaseRate'

EVENT_ON_UPDATE_BASE_CURRENCY

public mixed EVENT_ON_UPDATE_BASE_CURRENCY = 'onUpdateBaseCurrency'

Methods

checkCurrencyID()

Check currency id.

public static checkCurrencyID(string $currency) : bool|string
Parameters
$currency : string

Currency id.

Return values
bool|string

checkLanguage()

Check language id.

public static checkLanguage(string $language) : bool|string
Parameters
$language : string

Language.

Return values
bool|string

clearCurrencyCache()

Clear currency cache.

public static clearCurrencyCache([string $language = '' ]) : void
Parameters
$language : string = ''

Language id.

clearTagCache()

Clear tag currency cache.

public static clearTagCache(string $currency) : void
Parameters
$currency : string

Currency id.

currencyBaseRateAgent()

Agent for update current currencies rates to base currency.

public static currencyBaseRateAgent() : string
Return values
string

getBaseCurrency()

Return base currency.

public static getBaseCurrency() : string
Return values
string

getCurrencyList()

Return currency short list.

public static getCurrencyList() : array<string|int, mixed>
Return values
array<string|int, mixed>

getInstalledCurrencies()

Return currency list, create to install module.

public static getInstalledCurrencies() : array<string|int, mixed>
Return values
array<string|int, mixed>

getNameList()

Returns currency name list.

public static getNameList() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSymbolList()

Returns currency symbol list.

public static getSymbolList() : array<string|int, mixed>
Return values
array<string|int, mixed>

isCurrencyExist()

Verifying the existence of the currency by its code.

public static isCurrencyExist(string $currency) : bool
Parameters
$currency : string

Currency code.

Return values
bool

updateBaseCurrency()

Update base currency.

public static updateBaseCurrency(string $currency) : bool
Parameters
$currency : string

Currency id.

Return values
bool

updateBaseRates()

Update current currencies rates to base currency.

public static updateBaseRates([string $updateCurrency = '' ]) : void
Parameters
$updateCurrency : string = ''

Update currency id.

Tags
throws
ArgumentException
throws
Exception 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results