Локализация темы

WS 0.971

Локализация темы хранится в PHP-файлах внутри папки lang. CMS загружает общий файл переводов и дополнительный файл, соответствующий текущему шаблону.

Для получения строк в шаблонах используется статический класс SiteLang.

Структура папок

Языковые файлы хранятся внутри активной темы:

text

example/
  lang/
    ru/
      common.php
      index.php
      404.php
      page/
        default.php
      post/
        news.php
    en/
      common.php
      index.php
      404.php
      page/
        default.php
      post/
        news.php

Название языковой папки должно совпадать с URL-префиксом языка.

Например:

text

prefix: ru -> lang/ru
prefix: en -> lang/en

Код языка и его URL-префикс могут отличаться. Для названия папки используется именно префикс.

Префикс записывается строчными латинскими буквами и может содержать цифры или -.

Общие переводы

Файл common.php загружается на всех обычных страницах сайта:

text

lang/ru/common.php

Пример:

php

<?php
return [
    'main' => 'Главная',
    'contacts' => 'Контакты',
    'copyright' => 'Все права защищены.',
];

Получение значения:

php

$title = SiteLang::get('main');

Общие переводы подходят для:

header и footer
главного меню
общих кнопок
контактных данных
повторяющихся подписей
сообщений, используемых в разных шаблонах

Вложенные ключи

Переводы можно объединять во вложенные массивы:

php

<?php
return [
    'navigation' => [
        'main' => 'Главная',
        'catalog' => 'Каталог',
        'contacts' => 'Контакты',
    ],
    'buttons' => [
        'send' => 'Отправить',
        'read-more' => 'Читать далее',
    ],
];

Путь к значению записывается через точку:

php

$catalog = SiteLang::get('navigation.catalog');
$send = SiteLang::get('buttons.send');

SiteLang::get() возвращает только скалярное значение. Если путь указывает на массив, используется резервное значение.

Контекстные переводы

Кроме common.php, CMS загружает файл текущего контекста.

Контекст	Файл
Главная страница	`lang/{prefix}/index.php`
Страница ошибки	`lang/{prefix}/404.php`
Шаблон страницы	`lang/{prefix}/page/{template}.php`
Шаблон записи	`lang/{prefix}/post/{template}.php`

Контекстный файл дополняет общие переводы и может переопределять их.

Главная страница

Для главной страницы используется:

text

lang/ru/index.php

Пример:

php

<?php
return [
    'hero' => [
        'title' => 'Добро пожаловать',
        'description' => 'Описание главной страницы.',
    ],
];

Использование в index.php темы:

php

<section class="hero">
    <h1><?php echo SiteLang::html('hero.title'); ?></h1>
    <p><?php echo SiteLang::html('hero.description'); ?></p>
</section>

Шаблон страницы

Для файла шаблона:

text

template/page/default.php

используется файл переводов:

text

lang/ru/page/default.php

Пример:

php

<?php
return [
    'title' => 'О странице',
    'back' => 'Вернуться назад',
];

Использование в шаблоне:

php

<h1><?php echo SiteLang::html('title'); ?></h1>

<a href="<?php echo CurrentLanguage::url('/'); ?>">
    <?php echo SiteLang::html('back'); ?>
</a>

Имя языкового файла определяется именем шаблона, а не URL страницы.

Несколько страниц с шаблоном default используют один контекстный файл переводов.

Шаблон записи

Для файла:

text

template/post/news.php

используется:

text

lang/ru/post/news.php

Пример:

php

<?php
return [
    'published' => 'Опубликовано',
    'back-to-list' => 'Вернуться к новостям',
];

Использование:

php

<p><?php echo SiteLang::html('published'); ?></p>

<a href="<?php echo CurrentLanguage::url('/news'); ?>">
    <?php echo SiteLang::html('back-to-list'); ?>
</a>

Страница ошибки

Переводы страницы ошибки хранятся в:

text

lang/ru/404.php

Пример:

php

<?php
return [
    'title' => 'Страница не найдена',
    'description' => 'Проверьте адрес или вернитесь на главную страницу.',
    'home' => 'На главную',
];

Использование в template/404.php:

php

<h1><?php echo SiteLang::html('title'); ?></h1>
<p><?php echo SiteLang::html('description'); ?></p>

<a href="<?php echo CurrentLanguage::url('/'); ?>">
    <?php echo SiteLang::html('home'); ?>
</a>

Язык по умолчанию

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

Допустим, русский язык является языком по умолчанию:

php

<?php
return [
    'main' => 'Главная',
    'contacts' => 'Контакты',
    'catalog' => 'Каталог',
];

А английский файл содержит только часть переводов:

php

<?php
return [
    'main' => 'Home',
    'catalog' => 'Catalog',
];

Для английской версии сайта:

main вернёт Home
catalog вернёт Catalog
contacts вернёт Контакты

Отсутствующий перевод сохраняется из языка по умолчанию.

Порядок объединения

Файлы объединяются в следующем порядке:

common.php языка по умолчанию.
common.php текущего языка.
Контекстный файл языка по умолчанию.
Контекстный файл текущего языка.

Каждый следующий файл дополняет предыдущие данные и переопределяет совпадающие ключи.

Вложенные массивы объединяются рекурсивно.

Это позволяет:

хранить основной набор переводов в языке по умолчанию
переводить только необходимые значения
задавать общие строки в common.php
переопределять строки для конкретного шаблона

Получение строки

get(string $path, string $default = ''): string

Возвращает строку без дополнительной обработки:

php

$title = SiteLang::get('page.title');

Резервное значение передаётся вторым аргументом:

php

$title = SiteLang::get(
    'page.title',
    'Заголовок страницы'
);

Резервное значение возвращается, если:

ключ отсутствует
путь указывает на массив
значение не является скалярным

Вывод текста в HTML

html(string $path, string $default = ''): string

Экранирует специальные HTML-символы:

php

<h1><?php echo SiteLang::html('page.title'); ?></h1>

Резервное значение также экранируется:

php

<p>
    <?php echo SiteLang::html('page.description', 'Описание отсутствует'); ?>
</p>

Используйте html() для обычного текста, который выводится в HTML.

HTML-теги внутри перевода будут показаны как текст:

php

<?php
return [
    'message' => '<strong>Важное сообщение</strong>',
];

При выводе через html() браузер не обработает тег <strong>.

Получение исходного значения

get() не экранирует результат:

php

$value = SiteLang::get('message');

Используйте его, когда значение:

не выводится напрямую в HTML
передаётся в другую функцию
сравнивается в PHP
обрабатывается отдельно перед выводом

Все загруженные переводы

Получить весь объединённый массив можно через:

php

$translations = SiteLang::all();

Массив содержит:

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

Добавление нового языка

Перед созданием файлов язык должен быть настроен и активирован в CMS.

После этого:

Узнайте URL-префикс языка.
Создайте папку lang/{prefix}.
Добавьте common.php.
Добавьте необходимые контекстные файлы.
Откройте страницу с префиксом нового языка.
Проверьте переводы и резервные значения.

Например, для префикса de:

text

lang/de/common.php
lang/de/index.php
lang/de/page/default.php

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

Переводы и URL

SiteLang отвечает только за текстовые значения.

Для формирования внутренних ссылок текущего языка используйте:

php

$url = CurrentLanguage::url('/contacts');

Пример:

php

<a href="<?php echo CurrentLanguage::url('/contacts'); ?>">
    <?php echo SiteLang::html('navigation.contacts', 'Контакты'); ?>
</a>

Важные замечания

каждый языковой файл должен возвращать массив
папка языка называется по URL-префиксу
контекстный файл называется по шаблону
общие строки следует хранить в common.php
контекстные строки следует хранить рядом с соответствующим шаблоном
язык по умолчанию должен содержать основной набор переводов
отсутствующий файл текущего языка не мешает использовать переводы языка по умолчанию
theme-settings.json использует собственные названия полей и не загружается через SiteLang