codemastersolucoes / laravel-translation-manager
管理 Laravel 翻译
Requires
- php: >=7
- illuminate/support: 5.5.x|5.6.x|5.7.x
- illuminate/translation: 5.5.x|5.6.x|5.7.x
- roave/security-advisories: dev-master
- symfony/finder: ~3.0|~4.0
This package is auto-updated.
Last update: 2024-09-26 13:59:22 UTC
README
对于 Laravel 4,请使用0.1 分支!
这是一个用于管理 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 barryvdh/laravel-translation-manager
)
composer require barryvdh/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',
这将扩展翻译器,并在找不到键时创建一个新的数据库条目,这样您就必须访问使用它们的页面。这样它就会显示在网页界面中,可以被编辑,然后可以导出。您不应该在生产环境中使用此功能,仅用于开发,翻译视图,然后切换回来。
待办事项
此包仍然是 alpha 版。待办事项列表中的一些事项
- 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 :)