README

Модуль Translations для EvolutionCMS CE v3 это редактор для удобной правки языковых файлов, расположенных в /core/custom/lang, с промежуточным хранением в базе.

Установка

Автоматическая (рекомендуется)

Зайти в консоль сервера, перейти в папку core для сайта и там выполнить:

php -d="memory_limit=-1" artisan package:installrequire helgispbru/evocms-translations "*"

php artisan vendor:publish --tag="assets" --force

php artisan migrate --step

Вручную

1. Добавить в /core/custom/composer.json в список репозиториев:

"repositories": [
    {
        "type": "git",
        "url": "https://github.com/helgispbru/evocms-translations"
    }
]

1. Зайти в консоль сервера, перейти в папку core для сайта и там запустить

php -d="memory_limit=-1" artisan package:installrequire helgispbru/evocms-translations "*"

; установка только фронта в assets
php artisan vendor:publish --tag="assets" --force

; или
; php artisan vendor:publish --provider="Helgispbru\EvolutionCMS\Translations\TranslationsServiceProvider" --force

php artisan migrate --step

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

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

При импорте сканируются файлы из /core/custom/lang и в базе создаются языки, группы переводов и строки переводов в соответствии с данными из файлов. Записи в базе обновляются из файлов, но существующие не удаляются.

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

<?php
return [
    'login' => [
        'name' => '...',
        'secondname' => '...'
    ]
]

в базе будет преобразовано в login.name и login.secondname.

Важно! После окончания работы сделать экспорт из базы в языковые файлы.

При экспорте данные из базы записываются в файлы /core/custom/lang, содержимое файлов полностью заменяется (если нужно - делайте резервные копии!). Удалённые в базе группы и языки при экспорте удаляются из файлов.

Модуль

Модуль доступен в админке EvolutionCMS и позволяет работать с переводами.

После запуска модуля, перед началом работы, нужно сделать импорт языковых строк с помощью функции импорта (кнопка доступна в меню справа сверху). При импорте в базе создаются записи для языков, групп и строк переводов. Существующие записи обновляются, данные из файлов имеют приоритет. Данные, которые были в базе, но отсутствовали в файлах, не удаляются.

После окончания работы нужно экспортировать всё в файлы (кнопка доступна справа сверху). Важно делать это каждый раз, так как только файлы являются достоверным источником данных, а таблица в базе нужна лишь для удобной работы и служит для временного хранения строк переводов. При экспорте создаются папки для языков и файлы для групп с переводами. Если язык или группа были удалены из базы, то они также будут удалены из файлов (делайте резервные копии!).

Консоль

Функции импорта, экспорта и очистки таблиц базы также доступны из консоли. Консольные команды запускаются из папке core на сервере.

Импорт данных в базу

При импорте в базе создаются записи для языков, групп и строк переводов. Существующие записи обновляются, данные из файлов имеют приоритет. Данные, которые были в базе, но отсутствовали в файлах, не удаляются.

Команда:

php artisan translations:import

Параметры:

Экспорт данных в файлы

При экспорте создаются папки для языков и файлы для групп с переводами. Если язык или группа были удалены из базы, то они также будут удалены из файлов (делайте резервные копии!).

Команда:

php artisan translations:export

Параметры:

Удаление записей из базы

При удалении происходит как удаление групп переводов из базы, так и соответствующих им языковых строк. Языки в базе при этом остаются без изменений.

Команда:

php artisan translations:nuke

Параметры:

Как устроено и благодарности

Исходный код фронта модуля находится в publishable/module, написан с помощью vuejs v3.

Код для импорта и экспорта частично заимствован у WeDesignIt/laravel-translations-import, спасибо ему!