kalimeromk / laravel-translation-manager
管理 Laravel 翻译
Requires
- php: >=7
- illuminate/support: ^5.5|^6|^7|^8|^9|^10|^11
- illuminate/translation: ^5.5|^6|^7|^8|^9|^10|^11
- symfony/finder: ^3|^4|^5|^6|^7
README
这是一个用于管理 Laravel 翻译文件的包。它不会替代翻译系统,只负责将 PHP 文件导入数据库并通过 Web 界面进行编辑。工作流程如下:
- 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 kalimeromk/laravel-translation-manager)
composer require kalimeromk/laravel-translation-manager
更新 composer 后,将 ServiceProvider 添加到 config/app.php 中的 providers 数组
'Barryvdh\TranslationManager\ManagerServiceProvider',
您需要为此包运行迁移。
$ 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 上可用
Laravel >= 5.2
默认情况下,配置文件只包含 auth 中间件,但 Laravel 5.2 的最新更改使得仅在包含 web 中间件的路由中才能访问会话变量。为了使此包在 Laravel 5.2 上正常工作,您必须将路由/中间件的设置从默认的
'route' => [
'prefix' => 'translations',
'middleware' => 'auth',
],
更改为
'route' => [
'prefix' => 'translations',
'middleware' => [
'web',
'auth',
],
],
注意: 这仅适用于 Laravel 5.2(及更高版本)
使用方法
Web 界面
当您已通过按钮或命令导入翻译后,您可以在 Web 界面(在控制器定义的 URL 上)中查看它们。您可以点击翻译并弹出一个编辑字段。只需点击保存,它就会被保存 :) 如果在不同区域中尚未创建翻译,您也可以直接编辑它以创建它。
您可以使用 Web 界面上的按钮导入/导出翻译。为了发布翻译,请确保您的应用程序可以写入语言目录。
您还可以使用以下命令。
导入命令
导入命令将遍历 app/lang 并将所有字符串加载到数据库中,以便您可以轻松管理它们。
$ php artisan translations:import
来自 app/lang/locale.json 文件的翻译字符串将被导入到 _json 组。
注意:默认情况下,只有新字符串会被添加。数据库中已有的翻译保持不变。如果您想用文件中的值替换所有值,请添加 --replace(或 -R)选项:php artisan translations:import --replace
在源中查找翻译
查找命令/按钮将在 app 目录中的所有 php/twig 文件中搜索,以查看是否包含翻译函数,并尝试提取组/项名称。找到的键将被添加到数据库中,以便可以轻松翻译。这可以通过 Web 界面或 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:import --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 :)