currency

Класс для работы с валютой

Переменные

Переменные отсутсвуют

Методы

void __call ()
mixed convert ({ [toCurrencyId], [currencyId], sum, [numAfterPoint] }) Конвертирует сумму с одной валюты в другую
mixed getChar ({ [id] }) Возвращает символ валюты
mixed getCode ({ [id] }) Возвращает код валюты
mixed getDefaultId () Возвращает id валюты по умолчанию
mixed getFrontDefaultId () Возвращает id валюты по умолчанию на сайте
mixed getId ({ [code] }) Возвращает id валюты
array getList () Возвращает список валют
object getNew () Возвращает новую копию объекта класса
mixed getRate ({ [toCurrencyId], [currencyId], [numAfterPoint] }) Возвращает коэффициент конвертации валюты
mixed getTitle ({ [id] }) Возвращает наименование валюты
mixed init ({ id }) Инициализация класса
mixed isDefault ({ [id] }) Проверяет, является ли валюта по умолчанию
mixed isExist ({ [id], [code] }) Проверяет существование валюты
mixed isFrontDefault ({ [id] }) Проверяет, является ли валюта по умолчанию на сайте

__call

Примеры кода




convert

Конвертирует сумму с одной валюты в другую

Параметры

[toCurrencyId] int Id валюты в какую конвертировать (deprecated)
[currencyId] int Id валюты в какую конвертировать
sum float Сумма которую нужно конвертировать
[numAfterPoint] int Количество символов после точки. По умолчанию: значнеие указанное в настройках магазина

Возвращаемые значения

float Сумма
bool False - в случае ошибки

Примеры кода




getChar

Синоним: char
Возвращает символ валюты

Параметры

[id] int Id валюты

Возвращаемые значения

string Символ валюты
bool False - в случае ошибки

Примеры кода




getCode

Синоним: code
Возвращает код валюты

Параметры

[id] int Id валюты

Возвращаемые значения

string Код валюты
bool False - в случае ошибки

Примеры кода




getDefaultId

Синоним: defaultId
Возвращает id валюты по умолчанию

Возвращаемые значения

int Id валюты по умолчанию
bool False - в случае ошибки

Примеры кода




getFrontDefaultId

Синоним: frontDefaultId
Возвращает id валюты по умолчанию на сайте

Возвращаемые значения

int Id валюты по умолчанию на сайте
bool False - в случае ошибки

Примеры кода




getId

Синоним: id
Возвращает id валюты

Параметры

[code] string Code валюты

Возвращаемые значения

int Id валюты
bool False - в случае ошибки

Примеры кода




getList

Синоним: list
Возвращает список валют

Возвращаемые значения

array Массив обьектов currency

Примеры кода




getNew

Синоним: new
Возвращает новую копию объекта класса

Возвращаемые значения

object currency

Примеры кода




getRate

Синоним: rate
Возвращает коэффициент конвертации валюты

Параметры

[toCurrencyId] int Id результирующей валюты (deprecated)
[currencyId] int Id результирующей валюты
[numAfterPoint] int Количество символов после точки. По умолчанию: 4

Возвращаемые значения

float Сумма конвертированной валюты
bool False - в случае ошибки

Примеры кода




getTitle

Синоним: title
Возвращает наименование валюты

Параметры

[id] int Id валюты

Возвращаемые значения

string Наименование валюты
bool False - в случае ошибки

Примеры кода




init

Инициализация класса

Параметры

id int Id валюты

Возвращаемые значения

bool True - обьект инициализирован
bool False - в случае ошибки

Примеры кода




isDefault

Проверяет, является ли валюта по умолчанию

Параметры

[id] int Id валюты

Возвращаемые значения

bool True - если валюта по умолчанию
bool False - если валюта не по умолчанию или в случае ошибки

Примеры кода




isExist

Проверяет существование валюты

Параметры

[id] int Id валюты
[code] string Код валюты

Возвращаемые значения

bool True - валюта существует
bool False - валюты не существует или в случае ошибки

Примеры кода




isFrontDefault

Проверяет, является ли валюта по умолчанию на сайте

Параметры

[id] int Id валюты

Возвращаемые значения

bool True - если валюта по умолчанию на сайте
bool False - если валюта не по умолчанию на сайте или в случае ошибки

Примеры кода