slexx/lang

Internalization library

Internalization library

Класс для управления локализацией, не привязан к файловой системе, может работать с любой структурой файлов и папок. Умеет работать с json, yaml, ini и php файлами., _(*1)

, _(*2)

// Устанавливаем файлы с переводами
Lang::setFile('ru', 'messages', __DIR__ . '/locales/ru/messages.json');
Lang::setFile('en', 'messages', __DIR__ . '/locales/en/messages.yaml');

// Устанавливаем локализацию
Lang::setLocale(Lang::searchLocale('ru'));

// Добываем переводы в нужных местах
Lang::translate('messages:key');

Установка

Установка через composer:, _(*3)

$ composer require slexx/lang

Документация

Lang::setFile($locale, $namespace, $path)

Устанавливает файл локализации, _(*4)

Аргументы:, _(*5)

Исключения:, _(*6)

Возвращает: void, _(*7)

Lang::hasFile($locale, $namespace)

Проверка существования файла локализации, _(*8)

Аргументы:, _(*9)

Возвращает: bool, _(*10)

Lang::getFile($locale, $namespace)

Получение пути к файлу локализации, _(*11)

Аргументы:, _(*12)

Возвращает: string, null - Путь к файлу или null в случае его отсуцтвия, _(*13)

Lang::removeFile($locale, $namespace)

Удаление файла локализации, _(*14)

Аргументы:, _(*15)

Возвращает: void, _(*16)

Lang::getLocales()

Получение списка всех доступных локализаций, _(*17)

Возвращает: string[], _(*18)

Lang::props($string, $props)

Замена переменных в строке, _(*19)

Возвращает: string, _(*20)

Пример:, _(*21)

echo Lang::props('Hello, :name!', ['name' => 'World']);
// Hello, World!

Lang::parseAcceptLanguage()

Парсинг HTTP заголовка Accept-Language, _(*22)

Возвращает: array, _(*23)

Пример:, _(*24)

var_dump(Lang::parseAcceptLanguage());
// [
//     ['code' => 'ru', 'region' => 'RU', 'quality' => 1],
//     ['code' => 'ru', 'region' => null, 'quality' => 0.8],
//     ['code' => 'en', 'region' => 'US', 'quality' => 0.6],
//     ['code' => 'en', 'region' => null, 'quality' => 0.4],
//     ...
// ]

Lang::hasLocale($locale)

Проверка доступности локализации, _(*25)

Аргументы:, _(*26)

Возвращает: bool, _(*27)

Lang::setLocale($locale)

Установка локализации, _(*28)

Аргументы:, _(*29)

Исключения:, _(*30)

Возвращает: void, _(*31)

Lang::getLocale()

Получение локализации, _(*32)

Возвращает: string, _(*33)

Lang::searchLocale([$default])

Ищет наиболее подходящюю локализацию по заголовку Accept-Language. Перед использованием метода следует указать файлы локализации с помощью метода setFile, _(*34)

Аргументы:, _(*35)

Возвращает: string - ISO код наиболее подходящей локализации, _(*36)

Lang::raw($path)

Получение сырого не обработанного перевода, _(*37)

Аргументы:, _(*38)

Исключения:, _(*39)

Возвращает: array, string, null, _(*40)

Lang::translate($path[, $props])

Получение перевода с заменой параметров, _(*41)

Аргументы:, _(*42)

Исключения:, _(*43)

Возвращает: string, _(*44)

Пример:, _(*45)

messages.php:, _(*46)

<?php
return [
    'hello' => 'Привет, :name!',
];

index.php:, _(*47)

Lang::setFile('ru', 'messages', __DIR__ . '/messages.php');
Lang::setLocale('ru');

echo Lang::translate('messages:hello', ['name' => 'Алексей']);
// Выведет: 'Привет, Алексей!'

Lang::setPluralFunction($locale, $function)

Установка функции плюрализации для языка, _(*48)

Возвращает: void, _(*49)

Пример:, _(*50)

Lang::setPluralFunction('ru', function($n) {
    return $n%10==1&&$n%100!=11?0:($n%10>=2&&$n%10<=4&&($n%100<10||$n%100>=20)?1:2);
});
Lang::setPluralFunction('en', function($n) {
    return $n>1?1:0;
});

Lang::removePluralFunction($locale)

Удаление функции плюрализации для языка, _(*51)

Возвращает: void, _(*52)

Lang::hasPluralFunction($locale)

Проверка существования функции плюрализации для языка, _(*53)

Возвращает: bool, _(*54)

Lang::getPluralFunction($locale)

Получение функции плюрализации для языка, _(*55)

Возвращает: callable, null, _(*56)

Lang::getPluralFunction($path, $counter[, $props])

Плюрализация перевода, _(*57)

Возвращает: string, _(*58)

Исключения:, _(*59)

Пример:, _(*60)

blog.php:, _(*61)

<?php
return [
    'comments' => [':count комментарий', ':count комментария', ':count коментариев'],
];

index.php:, _(*62)

Lang::setFile('ru', 'blog', __DIR__ . '/blog.php');
Lang::setLocale('ru');

Lang::plural('blog:comments', 1); // 1 комментарий
Lang::plural('blog:comments', 2); // 2 комментария
Lang::plural('blog:comments', 45); // 45 коментариев