Spec-Zone.ru › CakePHP 4.4

Класс TranslatorRegistry

Создаёт и хранит экземпляры переводчиков, которые можно получить по имени и локали.

Пространство имён: Cake\I18n

Константы

  • string
    FALLBACK_LOADER 
    '_fallback'

    Имя загрузчика по умолчанию.

Краткое описание свойств

  • $_cacher protected
    Psr\SimpleCache\CacheInterfaceCake\Cache\CacheEngineInterface)|null

    Объект CacheEngine, используемый для запоминания переводчиков между запросами.

  • $_defaultFormatter protected
    string

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

  • $_loaders protected
    array<callable>

    Список функций загрузки, индексированных по имени домена. Загрузчики — вызываемые функции, используемые по умолчанию для построения пакетов переводов, когда ни один из них не найден для сочетания имени переводчика и локали.

  • $_useFallback protected
    bool

    Использовать домен по умолчанию для загрузчиков переводов.

  • $formatters protected
    Cake\I18n\FormatterLocator

    Локатор форматера.

  • $locale protected
    string

    Текущий код локали.

  • $packages protected
    Cake\I18n\PackageLocator

    Локатор пакетов.

  • $registry protected
    array<string, array<string,Cake\I18n\Translator>>

    Регистр для хранения объектов переводчиков.

Краткое описание методов

  • __construct() public

    Конструктор.

  • _getTranslator() protected

    Получает переводчик из реестра по пакету для локали.

  • createInstance() protected

    Создать экземпляр переводчика.

  • defaultFormatter() public

    Устанавливает имя форматера сообщений по умолчанию, который будет использоваться для будущих экземпляров переводчика.

  • get() public

    Получает переводчик из реестра по пакету для локали.

  • getFormatters() public

    Объект типа FormatterLocator

  • getLocale() public

    Возвращает код локали по умолчанию.

  • getPackages() public

    Возвращает пакеты переводчиков

  • registerLoader() public

    Регистрирует функцию загрузчика для имени пакета, которая будет использоваться в качестве резервной, если пакет с таким именем не может быть найден.

  • setCacher() public

    Устанавливает экземпляр CacheEngine, используемый для запоминания переводчиков между запросами.

  • setFallbackPackage() public

    Установить резервный домен для пакета.

  • setLoaderFallback() public

    Установить резервный домен для загрузчика.

  • setLocale() public

    Устанавливает код локали по умолчанию.

  • useFallback() public

    Установить, используется ли резервный домен по умолчанию.

Подробное описание методов

__construct() public 

__construct(Cake\I18n\PackageLocator $packages, Cake\I18n\FormatterLocator $formatters, string $locale)

Конструктор.

Parameters

Cake\I18n\PackageLocator $packages

Локатор пакета.

Cake\I18n\FormatterLocator $formatters

Локатор форматера.

string $locale

Код локали по умолчанию.

_getTranslator() protected 

_getTranslator(string $name, string $locale): Cake\I18n\Translator

Получает переводчик из реестра по пакету для локали.

Parameters

string $name

Пакет переводчика для получения.

string $locale

Локаль для использования; если пусто, используется локаль по умолчанию.

Returns

Cake\I18n\Translator

createInstance() protected 

createInstance(string $name, string $locale): Cake\I18n\Translator

Создать экземпляр переводчика.

Parameters

string $name

Пакет переводчика для получения.

string $locale

Локаль для использования; если пусто, используется локаль по умолчанию.

Returns

Cake\I18n\Translator

defaultFormatter() public 

defaultFormatter(string|null $name = null): string

Устанавливает имя форматера сообщений по умолчанию, который будет использоваться для будущих экземпляров переводчика.

Если вызывается без аргументов, вернет текущее настроенное значение.

Parameters

string|null $name optional

Имя форматера для использования.

Returns

string

get() public 

get(string $name, string|null $locale = null): Cake\I18n\Translator|null

Получает переводчик из реестра по пакету для локали.

Parameters

string $name

Пакет переводчика для получения.

string|null $locale optional

Локаль для использования; если пусто, используется локаль по умолчанию.

Returns

Cake\I18n\Translator|null

Throws

Cake\I18n\Exception\I18nException
Если переводчик с таким именем не может быть найден для данной локали.

getFormatters() public 

getFormatters(): Cake\I18n\FormatterLocator

Объект типа FormatterLocator

Returns

Cake\I18n\FormatterLocator

getLocale() public 

getLocale(): string

Возвращает код локали по умолчанию.

Returns

string

getPackages() public 

getPackages(): Cake\I18n\PackageLocator

Возвращает пакеты переводчиков

Returns

Cake\I18n\PackageLocator

registerLoader() public 

registerLoader(string $name, callable $loader): void

Регистрирует функцию загрузчика для имени пакета, которая будет использоваться в качестве резервной, если пакет с таким именем не может быть найден.

Обратные вызовы загрузчика получат в качестве первого аргумента имя пакета и локаль во втором аргументе.

Parameters

string $name

Имя пакета переводчика, для которого нужно зарегистрировать загрузчик

callable $loader

Вызываемый объект, который должен возвращать Package

Returns

void

setCacher() public 

setCacher(Psr\SimpleCache\CacheInterfaceCake\Cache\CacheEngineInterface $cacher): void

Устанавливает экземпляр CacheEngine, используемый для запоминания переводчиков между запросами.

Parameters

Psr\SimpleCache\CacheInterfaceCake\Cache\CacheEngineInterface $cacher

Экземпляр кэшера.

Returns

void

setFallbackPackage() public 

setFallbackPackage(string $name, Cake\I18n\Package $package): Cake\I18n\Package

Установить резервный домен для пакета.

Parameters

string $name

Имя пакета.

Cake\I18n\Package $package

Экземпляр пакета

Returns

Cake\I18n\Package

setLoaderFallback() public 

setLoaderFallback(string $name, callable $loader): callable

Установить резервный домен для загрузчика.

Parameters

string $name

Имя домена загрузчика

callable $loader

Вызываемый загрузчик

Returns

callable

setLocale() public 

setLocale(string $locale): void

Устанавливает код локали по умолчанию.

Parameters

string $locale

Новый код локали.

Returns

void

useFallback() public 

useFallback(bool $enable = true): void

Установить, используется ли резервный домен по умолчанию.

Parameters

bool $enable optional

Флаг для включения или отключения резервного варианта

Returns

void

Подробное описание свойства

$_cacher защищенное

Объект CacheEngine, используемый для запоминания переводчика между запросами.

Тип

Psr\SimpleCache\CacheInterfaceCake\Cache\CacheEngineInterface)|null

$_defaultFormatter защищенное

Имя используемого по умолчанию форматера для вновь созданных переводчиков из резервного загрузчика.

Тип

string

$_loaders защищенное

Список функций-загрузчиков, индексированных по имени домена. Загрузчики — вызываемые объекты, используемые по умолчанию для создания пакетов переводов, когда для сочетания имени переводчика и языка нет подходящих.

Тип

array<callable>

$_useFallback защищенное

Использовать резервный домен для загрузчиков переводов.

Тип

bool

$formatters защищенное

Локатор форматера.

Тип

Cake\I18n\FormatterLocator

$locale защищенное

Текущий код языка.

Тип

string

$packages защищенное

Локатор пакета.

Тип

Cake\I18n\PackageLocator

$registry защищенное

Регистр для сохранения объектов переводчика.

Тип

array<string, array<string,Cake\I18n\Translator>>

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.I18n.TranslatorRegistry.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API