yellow-three / laravel-translation-manager
管理 Laravel Voyager 翻译
Requires
- php: >=7.2
- illuminate/support: ^9|^10
- illuminate/translation: ^9|^10
- symfony/finder: ^6
Requires (Dev)
- orchestra/testbench: ^7|^8
Suggests
- tanmuhittin/laravel-google-translate: If you want to translate using Google API
This package is not auto-updated.
Last update: 2024-09-24 07:43:56 UTC
README
这是一个用于管理 Laravel 翻译文件的包。它不会替代翻译系统,只会将 php 文件导入到数据库中,并通过网页界面进行编辑。工作流程如下:
- Import translations: Read all translation files and save them in the database
- Find all translations in php/twig sources
- Optionally: Listen to missing translation with the custom Translator
- Translate all keys through the webinterface
- Export: Write all translations back to the translation files.
这样,翻译可以保存在 git 历史记录中,并在生产中不引入任何额外开销。
安装
在 composer.json 中添加此包,并运行 composer update(或直接运行 composer require yellow-three/laravel-translation-manager
)
composer require yellow-three/laravel-translation-manager
您需要为此包运行迁移。
php artisan vendor:publish --provider="Barryvdh\TranslationManager\ManagerServiceProvider" --tag=migrations
php artisan migrate
您需要发布此包的配置文件。这将添加 config/translation-manager.php
文件,您可以在其中配置此包。
php artisan vendor:publish --provider="Barryvdh\TranslationManager\ManagerServiceProvider" --tag=config
为了编辑默认模板,还需要发布视图。视图将被放置在 resources/views/vendor/translation-manager
。
php artisan vendor:publish --provider="Barryvdh\TranslationManager\ManagerServiceProvider" --tag=views
路由已在 ServiceProvider 中添加。您可以在配置中设置路由的组参数。您可以更改前缀或路由的过滤/中间件。如果您想要完全自定义,您可以扩展 ServiceProvider 并覆盖 map()
函数。
此示例将使翻译管理器在 http://yourdomain.com/translations
上可用
如果您想使用 Google 翻译 API 进行自动翻译,请安装 https://github.com/tanmuhittin/laravel-google-translate
composer require tanmuhittin/laravel-google-translate
php artisan vendor:publish --provider=Tanmuhittin\LaravelGoogleTranslate\LaravelGoogleTranslateServiceProvider
中间件 / 认证
默认情况下,配置文件仅包括 auth
中间件,但 Laravel 5.2 的最新更改使得只有在您的路由包含 web
中间件时,会话变量才可访问。为了使此包在 Laravel 5.2 上工作,您必须将路由/中间件设置从默认值更改为
'route' => [
'prefix' => 'translations',
'middleware' => 'admin.user',
],
到
'route' => [
'prefix' => 'translations',
'middleware' => [
'web',
'auth',
],
],
注意: 这仅适用于 Laravel 5.2(及更高版本)
用法
网页界面
当您已通过按钮或命令导入翻译时,您可以在网页界面(通过您定义的控制器中的 URL)中查看它们。您可以通过点击翻译并弹出编辑字段来编辑翻译。只需点击保存即可保存 :) 如果某个翻译在不同区域还没有创建,您也可以直接编辑它以创建它。
通过网页界面的按钮,您可以导入/导出翻译。对于发布翻译,请确保您的应用程序可以写入语言目录。
您还可以使用以下命令。
导入命令
导入命令将遍历 app/lang 并将所有字符串加载到数据库中,以便您可以轻松管理它们。
php artisan translations:import
来自 app/lang/locale.json 文件的翻译字符串将导入到 _json 组。
注意:默认情况下,仅添加新字符串。数据库中已有的翻译保持不变。如果您想用文件中的值替换所有值,请添加 --replace
(或 -R
)选项:php artisan translations:import --replace
在源中查找翻译
查找命令/按钮将在 app 目录中的所有 php/twig 文件中搜索,查看它们是否包含翻译函数,并尝试提取组/项目名称。找到的键将被添加到数据库中,以便可以轻松翻译。这可以通过网页界面或通过 Artisan 命令完成。
php artisan translations:find
如果您的项目使用翻译字符串作为键,这些字符串将存储在 _json 组中。
导出命令
导出命令将数据库内容写回到 app/lang php 文件中。这将覆盖现有的翻译并删除所有注释,所以在使用前请确保备份您的数据。提供组名来定义您想发布的组。
php artisan translations:export <group>
例如,当您有 2 个区域(en/nl)时,使用 php artisan translations:export reminders
将写入到 app/lang/en/reminders.php
和 app/lang/nl/reminders.php
要作为键导出翻译字符串到 JSON 文件,使用 --json
(或 -J
)选项:php artisan translations:export --json
。这将导入来自 _json 组的所有条目。
清理命令
清理命令将搜索所有 NULL 的翻译并将它们删除,这样您的界面就会更整洁。注意:空的翻译永远不会被导出。
php artisan translations:clean
重置命令
重置命令只是简单地清除数据库中的所有翻译,这样您就可以从头开始(通过新的导入)。在进行此操作之前,请确保导出您的工作(如果需要的话)。
php artisan translations:reset
检测缺失的翻译
大多数翻译可以通过使用查找命令(见上文)找到,但如果有动态键(变量/自动表单等),监听缺失的翻译可能会有所帮助。要检测缺失的翻译,我们可以用自定义提供程序替换 Laravel TranslationServiceProvider。在您的 config/app.php
中,注释掉原始的 TranslationServiceProvider 并添加此包中的一个。
//'Illuminate\Translation\TranslationServiceProvider',
'Barryvdh\TranslationManager\TranslationServiceProvider',
这将扩展翻译器,并在找不到键时创建一个新的数据库条目,这样您就需要访问使用它们的页面。这样它就会在 Web 界面中显示出来,可以编辑并在以后导出。您不应该在生产环境中使用此功能,只是在开发中翻译视图,然后切换回。
待办事项
此包仍处于非常初级的阶段。待办事项列表中还有一些事情。
- Add locales/groups via webinterface
- Improve webinterface (more selection/filtering, behavior of popup after save etc)
- Seed existing languages (https://github.com/caouecs/Laravel-lang)
- Suggestions are welcome :)