Add

Описание и параметры

string
CCurrency::Add(
	array arFields
);

Статический метод добавляет новую валюту, если ее еще не было. После добавления новой валюты необходимо установить ее языкозависимые параметры в помощью метода CCurrencyLang::Add.

Параметры метода

Параметр	Описание
arFields	Ассоциативный массив параметров валюты, в котором ключами являются названия параметров, а значениями - значения параметров. Допустимые названия параметров: CURRENCY - трехсимвольный код валюты (обязательный); AMOUNT_CNT - количество единиц валюты по-умолчанию, которое учавствует в задании курса валюты (например, если 10 Датских крон стоят 48.7 рублей, то 10 - это количество единиц); AMOUNT - курс валюты по-умолчанию (одна из валют сайта должна иметь курс 1, она называется базовой, остальные валюты имеют курс относительно базовой валюты); SORT - порядок сортировки; NUMCODE - трехзначный цифровой код валюты; BASE - флаг (Y/N) является ли валюта базовой (если для добавляемой валюты указано Y и в системе уже есть некоторая базовая валюта, то флаг с существующей валюты будет снят и AMOUNT у базовой валюты станет равен 1); CREATED_BY - ID пользователя, добавившего валюту; MODIFIED_BY - ID последнего пользователя, изменившего валюту. LANG - массив языкозависимых параметров, ключи - языки, значение каждого ключа - массив и CCurrencyLang CURRENT_BASE_RATE - Текущая стоимость 1 денежной единицы в базовой валюте. Служебное поле, используется для сортировки с учетом валют, значение по умолчанию не менять!

Параметр

Описание

arFields

Ассоциативный массив параметров валюты, в котором ключами являются названия параметров, а значениями - значения параметров.

Допустимые названия параметров:

CURRENCY - трехсимвольный код валюты (обязательный);
AMOUNT_CNT - количество единиц валюты по-умолчанию, которое учавствует в задании курса валюты (например, если 10 Датских крон стоят 48.7 рублей, то 10 - это количество единиц);
AMOUNT - курс валюты по-умолчанию (одна из валют сайта должна иметь курс 1, она называется базовой, остальные валюты имеют курс относительно базовой валюты);
SORT - порядок сортировки;
NUMCODE - трехзначный цифровой код валюты;
BASE - флаг (Y/N) является ли валюта базовой (если для добавляемой валюты указано Y и в системе уже есть некоторая базовая валюта, то флаг с существующей валюты будет снят и AMOUNT у базовой валюты станет равен 1);
CREATED_BY - ID пользователя, добавившего валюту;
MODIFIED_BY - ID последнего пользователя, изменившего валюту.
LANG - массив языкозависимых параметров, ключи - языки, значение каждого ключа - массив и CCurrencyLang
CURRENT_BASE_RATE - Текущая стоимость 1 денежной единицы в базовой валюте. Служебное поле, используется для сортировки с учетом валют, значение по умолчанию не менять!

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

Метод возвращает код добавленной валюты (сбрасывает кеш currency_currency_list и currency_base_currency в случае успешного добавления). Или false в случае ошибки (текст ошибки берётся через $APPLICATION->GetException()).

Пример использования

<?
// Добавим новую валюту "Исландские кроны"
$arFields = array(
	"CURRENCY" => "ISK",
	"AMOUNT" => 44.8378,
	"AMOUNT_CNT" => 100,
	"SORT" => 250
);
CCurrency::Add($arFields);
?>

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Наверх