void|string
BX.translit(
String str,
Object params
);
Функция производит транслитерацию строки.
Параметры функции
| Параметр |
Описание |
| str |
|
| params |
Возможные ключи объекта params:
- max_len - максимальная длина результирующей строки;
- change_case - к какому регистру приводить строку: L – к нижнему, U – к верхнему, false – не менять регистр;
- replace_space - строка, на которую заменяются пробелы;
- replace_other - строка, на которую заменяются остальные небуквенноцифровые символы;
- delete_repeat_replace - флаг, удалять ли повторяющиеся небуквенноцифровые замены;
- use_google - использовать ли внешний сервис для перевода строки перед транслитерацией. По умолчанию false.
Параметр получил название из-за того, что раньше использовался сервис перевода Google.Translate. Поскольку сервис уже закрыт, то используется сервис Яндекс.Перевода. Имя параметра осталось для сохранения совместимости.
Помимо этого можно указать параметр callback, которому будет передан результат обработки. Если параметр use_google установлен в true, то callback обязателен. |
Возвращаемое значение
Функция вернет транслитерированную строку (или ничего, если транслитерирование отложено параметром use_google.)