Spec-Zone.ru › CakePHP 3.8

Класс TranslatorRegistry

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

Aura\Intl\TranslatorLocator
Расширяется Cake\I18n\TranslatorRegistry
Пространство имён: Cake\I18n
Расположение: I18n/TranslatorRegistry.php

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

  • $_cacher protected
    Cake\Cache\CacheEngine

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

  • $_defaultFormatter protected
    string

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

  • $_fallbackLoader protected
    string
    Имя кэшируемого загрузчика
  • $_loaders protected
    callable[]

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

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

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

  • __construct() public
    Конструктор.
  • _fallbackLoader() protected

    Возвращает новый экземпляр переводчика для заданного имени и локали, основанного на соглашениях.

  • _getFromLoader() protected

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

  • _getTranslator() protected
    Получает переводчик из реестра по имени пакета для локали.
  • _partialLoader() protected
    Возвращает функцию, которую можно использовать в качестве загрузчика для registerLoaderMethod
  • defaultFormatter() public

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

  • get() public
    Получает переводчик из реестра по имени пакета для локали.
  • registerLoader() public

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

  • setCacher() public

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

  • setLoaderFallback() public
    Устанавливает домен по умолчанию для загрузчика.
  • useFallback() public
    Устанавливает, используется ли резервное значение по умолчанию для домена.

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

__construct()source public

__construct( Aura\Intl\PackageLocator $packages , Aura\Intl\FormatterLocator $formatters , Cake\I18n\TranslatorFactory $factory , string $locale )

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

Параметры

Aura\Intl\PackageLocator $packages
Локатор пакетов.
Aura\Intl\FormatterLocator $formatters
Локатор форматировщиков.
Cake\I18n\TranslatorFactory $factory

Фабрика переводчиков для создания объектов переводчиков для локали и пакета.

string $locale
Код локали по умолчанию для использования.

_fallbackLoader()source protected

_fallbackLoader( string $name , string $locale )

Возвращает новый экземпляр переводчика для заданного имени и локали, основанного на соглашениях.

Параметры

string $name
Имя пакета переводов.
string $locale
Локаль для создания переводчика.

Возвращает

Aura\Intl\Translator

_getFromLoader()source protected

_getFromLoader( string $name , string $locale )

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

Параметры

string $name
Имя пакета переводчика
string $locale
Локаль, для которой должен быть построен пакет

Возвращает

Aura\Intl\TranslatorInterface
Объект переводчика.

_getTranslator()source protected

_getTranslator( string $name , string|null $locale )

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

Параметры

string $name
Пакет переводчика для получения.
string|null $locale

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

Возвращает

Aura\Intl\TranslatorInterface
Объект переводчика.

_partialLoader()source protected

_partialLoader( )

Возвращает функцию, которую можно использовать в качестве загрузчика для registerLoaderMethod

Возвращает

callable

defaultFormatter()source public

defaultFormatter( string|null $name = null )

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

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

Параметры

string|null $name необязательно null
Имя форматировщика для использования.

Возвращает

string
Имя форматировщика.

get()source public

get( string $name , string|null $locale = null )

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

Параметры

string $name
Пакет переводчика для получения.
string|null $locale необязательно null

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

Возвращает

Aura\Intl\TranslatorInterface|null
Объект переводчика.

Выбрасывает

Aura\Intl\Exception

Если переводчик с таким именем не найден для заданной локали.


registerLoader()source public

registerLoader( string $name , callable $loader )

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

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

Параметры

string $name
Имя пакета переводчика для регистрации загрузчика
callable $loader
Вызываемый объект, который должен возвращать пакет

setCacher()source public

setCacher( Cake\Cache\CacheEngine $cacher )

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

Параметры

Cake\Cache\CacheEngine $cacher
Экземпляр кэшера.

setLoaderFallback()source public

setLoaderFallback( string $name , callable $loader )

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

Параметры

string $name
Имя домена загрузчика
callable $loader
Вызываемый загрузчик

Возвращает

callable
загрузчик
END_OF_DOCUMENT_MARKER ```

useFallback()source public

useFallback( boolean $enable = true )

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

Параметры

boolean $enable необязательно true
флаг для включения или отключения падения домена

Подробности свойств

$_cachersource

protected Cake\Cache\CacheEngine

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

$_defaultFormattersource

protected string

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

'default'

$_fallbackLoadersource

protected string

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

'_fallback'

$_loaderssource

protected callable[]

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

[]

$_useFallbacksource

protected boolean

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

true

© 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/3.8/class-Cake.I18n.TranslatorRegistry.html

Spec-Zone.ru

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