Статические методы - Линейка решений INTEC: Universe

Метод Add(array $arFields)

Описание: Добавляет новую валюту в систему.

Параметры:

• array $arFields — массив. Имеет вид: array(„Поле 1“ => „Значение 1“, „Поле 2“ => „Значение 2“, … , „Поле N“ => „Значение N“).

Возвращает: integer|boolean. Если добавление прошло успешно, то возвращает индекс валюты иначе возвращает false.

Метод Update(integer $iCurrencyID, array $arFields)

Описание: Обновляет поля существующей валюты.

Параметры:

• integer $iICurrencyID — индекс валюты, поля которой необходимо обновить.

• array $arFields — массив. Имеет вид: array(„Поле 1“ => „Значение 1“, „Поле 2“ => „Значение 2“, … , „Поле N“ => „Значение N“).

Возвращает: integer|boolean. Если обновление прошло успешно, то возвращает true иначе возвращает false.

Метод Delete(integer $iICurrencyID)

Описание: Удаляет валюту из системы.

Параметры:

• integer $iICurrencyID — индекс валюты, которую необходимо удалить.

Метод DeleteAll()

Описание: Удаляет все валюты из системы.

Метод GetList(array $arSort = array(), array $arFilter = array())

Описание: Получает отсортированный и отфильтрованный список валют.

Параметры:

• array $arSort — массив, содержащий поля для сортировки вида array(„Поле 1“ => „ASC|DESC“, „Поле 2“ => „ASC|DESC“, … , „Поле N“ => „ASC|DESC“), где ASC|DESC порядок сортировки по возрастанию и убыванию соответственно.

• array $arFilter — массив, содержащий условия фильтрации, поддерживает сложные условия.

Возвращает: Экземпляр класса CDBResult.

Метод GetBase()

Описание: Получает базовую валюту.
Возвращает: Экземпляр класса CDBResult.

Метод GetByID(integer $iCurrencyID)

Описание: Получает информацию о валюте по индексу.

Параметры:

• integer $iCurrencyID — индекс валюты.

Возвращает: Экземпляр класса CDBResult.

Метод GetByCode(integer $sCurrencyCode)

Описание: Получает информацию о валюте по коду.

Параметры:

• integer $sCurrencyCode — код валюты.

Возвращает: Экземпляр класса CDBResult.

Метод Convert(float $fPrice, string|null $sFromCurrency = null, string|null $sToCurrency = null)

Описание: Конвертирует значение цены из 1 валюты в другую.

Параметры:

• float $fPrice — дробное значение. Значение цены.

• string $sFromCurrency — строка или null. Указывает, из какой валюты конвертировать. Строка означает код валюты. Если null или валюта по коду не была найдена, то берется валюта по умолчанию.

• string $sToCurrency — строка или null. Указывает, в какую валюту конвертировать. Строка означает код валюты. Если null или валюта по коду не была найдена, то берется валюта по умолчанию.

Возвращает: float.

Метод FormatAsString(float $fPrice, string|null $sCurrencyCode = null, string $sLanguageID = LANGUAGE_ID)

Описание: Форматирует значение цены в соответствии с валютой и языком.

Параметры:

• float $fPrice — дробное значение. Значение цены.

• string $sCurrencyCode — строка или null. Указывает, какая валюта используется для форматирования. Строка означает код валюты. Если null или валюта по коду не была найдена, то берется валюта по умолчанию.

• string $sLanguageID — строка. Идентификатор языка. По умолчанию берется текущий язык сайта.

Возвращает: string. Форматированное значение.

Метод FormatAsArray(float $fPrice, string|null $sCurrencyCode = null, string $sLanguageID = LANGUAGE_ID)

Описание: Форматирует значение цены в соответствии с валютой и языком.
Параметры:

• float $fPrice — дробное значение. Значение цены.

• string $sCurrencyCode — строка или null. Указывает, какая валюта используется для форматирования. Строка означает код валюты. Если null или валюта по коду не была найдена, то берется валюта по умолчанию.

• string $sLanguageID — строка. Идентификатор языка. По умолчанию берется текущий язык сайта.

Возвращает: array. Вид массива: array(„VALUE“ => „Значение“, „CURRENCY“ => „Код валюты“, „PRINT_VALUE“ => „Форматированное значение“).

Метод ConvertAndFormatAsArray(float $fPrice, string|null $sFromCurrency = null, string|null $sToCurrency = null, string $sLanguageID = LANGUAGE_ID)

Описание: Конвертирует значение цены из 1 валюты в другую и форматирует в соответствии с валютой, в которую происходила конвертация и языком.

Параметры:

• float $fPrice — дробное значение. Значение цены.

• string $sFromCurrency — строка или null. Указывает, из какой валюты конвертировать. Строка означает код валюты. Если null или валюта по коду не была найдена, то берется валюта по умолчанию.

• string $sToCurrency — строка или null. Указывает, в какую валюту конвертировать. Строка означает код валюты. Если null или валюта по коду не была найдена, то берется валюта по умолчанию.

• string $sLanguageID — строка. Идентификатор языка. По умолчанию берется текущий язык сайта.

Возвращает: array(„VALUE“ => „Конвертированное значение“, „CURRENCY“ => „Код валюты в которую конвертировало“, „PRINT_VALUE“ => „Форматированное и конвертированное значение“).

Метод ConvertAndFormatAsString(float $fPrice, string|null $sFromCurrency = null, string|null $sToCurrency = null, string $sLanguageID = LANGUAGE_ID)

Описание: Конвертирует значение цены из 1 валюты в другую и форматирует в соответствии с валютой, в которую происходила конвертация и языком.

Параметры:

• float $fPrice — дробное значение. Значение цены.

• string $sFromCurrency — строка или null. Указывает, из какой валюты конвертировать. Строка означает код валюты. Если null или валюта по коду не была найдена, то берется валюта по умолчанию.

• string $sToCurrency — строка или null. Указывает, в какую валюту конвертировать. Строка означает код валюты. Если null или валюта по коду не была найдена, то берется валюта по умолчанию.

• string $sLanguageID — строка. Идентификатор языка. По умолчанию берется текущий язык сайта.

Возвращает: string. Конвертированное и форматированное значение.