GetList
Описание и параметры
CDBResult CCurrency::GetList( string &by, string &order, string lang = LANGUAGE_ID );
Метод возвращает список валют, отсортированный по полю из параметра by в направлении order. Языкозависимые параметры валют берутся для языка, указанного в параметре lang (по умолчанию равен текущему языку). Нестатический метод.
Параметры метода
Параметр | Описание |
---|---|
by | Переменная, содержащая порядок сортировки валют. Допустимые значения переменной: currency - код валюты name - название валюты на языке lang sort - индекс сортировки (по-умолчанию) |
order | Переменная, содержащая направление сортировки. Допустимые значения: asc - по возрастанию значений (по-умолчанию) desc - по убыванию значений. |
lang | Код языка, для которого выбираются языкозависимые параметры валют. Необязательный параметр. |
Возвращаемые значения
Возвращается объект класса CDBResult, каждая запись в котором представляет собой массив с ключами:
Ключ | Описание |
---|---|
CURRENCY | Код валюты (трехсимвольный) |
AMOUNT_CNT | Количество единиц валюты по-умолчанию, которое учавствует в задании курса валюты (например, если 10 Датских крон стоят 48.7 рублей, то 10 - это количество единиц) |
AMOUNT | Курс валюты по-умолчанию (одна из валют сайта должна иметь курс 1, она называется базовой, остальные валюты имеют курс относительно базовой валюты) |
SORT | Порядок сортировки. |
DATE_UPDATE | Дата последнего изменения записи (в формате базы данных). |
BASE | Флаг (Y/N) является ли валюта базовой. |
NUMCODE | Трехзначный цифровой код валюты. |
CREATED_BY | ID пользователя, добавившего валюту. |
MODIFIED_BY | ID последнего пользователя, изменившего валюту. |
DATE_UPDATE_FORMAT | Отформатированная в соответствии с настройками сайта дата последнего изменения записи. |
LID | Код языка. |
FORMAT_STRING | Строка формата для показа сумм в этой валюте. |
FULL_NAME | Полное название валюты. |
DEC_POINT | Символ, который используется при показе сумм в этой валюте для отображения десятичной точки. |
THOUSANDS_SEP | Символ, который используется при показе сумм в этой валюте для отображения разделителя тысяч. |
DECIMALS | Количество знаков после запятой при показе. |
HIDE_ZERO | Флаг (Y/N) убирает показ в публичной части незначащих нулей у дробной части цены. |
Пример использования
<? // Выведем список валют на текущем языке, отсортированный по названию // Кроме того выведем сумму 11.95 в формате этой валюты на текущем языке $lcur = CCurrency::GetList(($by="name"), ($order="asc"), LANGUAGE_ID); while($lcur_res = $lcur->Fetch()) { echo "[".$lcur_res["CURRENCY"]."] ".$lcur_res["FULL_NAME"].": "; echo CurrencyFormat(11.95, $lcur_res["CURRENCY"])."<br>"; } ?>
© «Битрикс», 2001-2024, «1С-Битрикс», 2024