CurrencyFormat

string
CCurrencyLang::CurrencyFormat(
	float price, 
	string currency,
	bool useTemplate
);

Форматирует цену в соответствии с настройками валюты. В случае вызова в административной части дополнительно выполняет очистку формата от тегов и скриптов. Если метод вызывается в публичной части, то будет задействован параметр HIDE_ZERO, который отвечает за скрытие незначащих нулей в дробной части. Метод статический.

Примечание: используется взамен функций CurrencyFormat и CurrencyFormatNumber, которые считаются устаревшими с версии модуля 14.0.0.

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

Параметр	Тип	Описание
price	string float int	Цена (денежная сумма), которую нужно сконвертировать. Корректно обрабатываются числа в формате string, float или int (целое число). В случае, когда значение не может быть описано в рамках типа float или int, можно передать его в виде string (с версии модуля 24.0.0). Примечание. Обрабатываются только строки вида: LNUM [0-9]+ DNUM ([0-9][\.]{LNUM}) \| ({LNUM}[\.][0-9]) Смотрите документацию по числовым строкам. Все остальные значения числовых строк будут приведены к float. Например: $price = '123456789012345678901234567.45'; $currency = 'RUB'; $result = \CCurrencyLang::CurrencyFormat( $price, $currency ); echo $result; выведет (рассматриваем формат по умолчанию для русского языка) 123 456 789 012 345 678 901 234 567.45 ₽
currency	string	Код валюты.
useTemplate	boolean	Если указано true, то работает как CurrencyFormat и вызывается событие CurrencyFormat. Если задано false, то работает как CurrencyFormatNumber.

Параметр

Тип

Описание

price

string

float

int

Цена (денежная сумма), которую нужно сконвертировать.

Корректно обрабатываются числа в формате string, float или int (целое число).

В случае, когда значение не может быть описано в рамках типа float или int, можно передать его в виде string (с версии модуля 24.0.0).

Примечание. Обрабатываются только строки вида:

LNUM		[0-9]+
DNUM		([0-9]*[\.]{LNUM}) | ({LNUM}[\.][0-9]*)

Смотрите документацию по числовым строкам.

Все остальные значения числовых строк будут приведены к float.

Например:

$price = '123456789012345678901234567.45';
$currency = 'RUB';

$result = \CCurrencyLang::CurrencyFormat(
    $price,
    $currency
);

echo $result;

выведет (рассматриваем формат по умолчанию для русского языка)

123 456 789 012 345 678 901 234 567.45 ₽

currency

string

Код валюты.

useTemplate

boolean

Если указано true, то работает как CurrencyFormat и вызывается событие CurrencyFormat. Если задано false, то работает как CurrencyFormatNumber.

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

Возвращает отформатированную строку.