Spec-Zone.ru › CakePHP 3.3

Класс MessagesFileLoader

Общий фабричный класс пакета переводов, который загружает файлы переводов на основе расширения файла и имени пакета.

Этот класс является вызываемым, поэтому его можно использовать в качестве аргумента загрузчика пакета.

Пространство имён: Cake\I18n
Расположение: I18n/MessagesFileLoader.php

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

  • $_extension protected
    string
    Имя расширения.
  • $_locale protected
    string
    Локаль для загрузки для данного пакета.
  • $_name protected
    string
    Имя пакета (домен).

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

  • __construct() public

    Создаёт загрузчик файла переводов. Файл для загрузки соответствует следующим правилам:

  • __invoke() public

    Загружает файл перевода и парсит его. Возвращает экземпляр пакета переводов, содержащего сообщения, загруженные из файла.

  • translationsFolders() public

    Возвращает папки, в которых должен быть найден файл в соответствии с локалью и именем пакета.

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

__construct()source public

__construct( string $name , string $locale , string $extension 'po' )

Создаёт загрузчик файла переводов. Файл для загрузки соответствует следующим правилам:

  • Локаль — это папка в каталоге Locale, будет использоваться резервное значение, если папка не найдена.
  • Переменная $name соответствует имени загружаемого файла.
  • Если загружен плагин с нижнее подчеркиванием версии $name, файл перевода будет загружен из этого плагина.

Примеры:

Загрузка и парсинг src/Locale/fr/validation.po

$loader = new MessagesFileLoader('validation', 'fr_FR', 'po');
$package = $loader();

Загрузка и парсинг src/Locale/fr_FR/validation.mo

$loader = new MessagesFileLoader('validation', 'fr_FR', 'mo');
$package = $loader();

Загрузка файла plugins/MyPlugin/src/Locale/fr/my_plugin.po:

$loader = new MessagesFileLoader('my_plugin', 'fr_FR', 'mo');
$package = $loader();

Параметры

string $name
Имя (домен) пакета переводов.
string $locale

Локаль для загрузки, которая будет сопоставлена с папкой в системе.

string $extension необязательно 'po'

Расширение файла для использования. Также будет сопоставлено с классом парсера сообщений.

__invoke()source public

__invoke( )

Загружает файл перевода и парсит его. Возвращает экземпляр пакета переводов, содержащего сообщения, загруженные из файла.

Возвращает

Aura\Intl\Package

Выбрасывает

RuntimeException

если для указанного расширения файла не удалось найти класс парсера.


translationsFolders()source public

translationsFolders( )

Возвращает папки, в которых должен быть найден файл в соответствии с локалью и именем пакета.

Возвращает

array
Список папок, в которых должен быть найден файл перевода

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

$_extensionsource

protected string

Имя расширения.

$_localesource

protected string

Локаль для загрузки для данного пакета.

$_namesource

protected string

Имя пакета (домен).

© 2005–2017 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.3/class-Cake.I18n.MessagesFileLoader.html

Spec-Zone.ru

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