moravio/barryvdh-laravel-translation-manager

v0.5.0 2018-08-31 13:25 UTC

README

对于 Laravel 4,请使用 0.1 分支

这是一个管理 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 历史中,并且在生产环境中不会引入任何额外开销。

Screenshot

安装

在您的 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(及更高版本)

使用方法

网页界面

当您通过按钮或命令导入翻译后,您可以在网页界面(通过您定义的控制器中的 URL)查看它们。您可以点击翻译,并弹出编辑字段。只需点击保存,它就会被保存 :) 如果在不同区域设置中尚未创建翻译,您也可以直接编辑它来创建它。

您可以通过网页界面的按钮导入/导出翻译。为了发布翻译,请确保您的应用程序可以写入语言目录。

您还可以使用以下命令。

导入命令

导入命令将遍历 app/lang 并将所有字符串加载到数据库中,这样您就可以轻松地管理它们。

$ php artisan translations:import

来自 app/lang/locale.json 文件的翻译字符串将被导入到 _json 组。

注意:默认情况下,只有新字符串被添加。数据库中已存在的翻译保持不变。如果您想用文件中的值替换所有值,请添加 --replace(或 -R)选项:php artisan translations:import --replace

在源代码中查找翻译

查找命令/按钮将在应用程序目录中搜索所有php/twig文件,查看它们是否包含翻译函数,并尝试提取组/项目名称。找到的键将添加到数据库中,以便轻松翻译。这可以通过Web界面或Artisan命令完成。

$ php artisan translations:find

如果你的项目使用翻译字符串作为键,这些将存储在_ json 组中。

导出命令

导出命令将数据库内容写回app/lang php文件。这将覆盖现有翻译并删除所有注释,所以在使用之前请确保备份您的数据。提供组名以定义您想要发布的组。

$ php artisan translations:export <group>

例如,当您有两个地区(en/nl)时,运行php artisan translations:export reminders,将写入app/lang/en/reminders.phpapp/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界面中显示出来,可以编辑并稍后导出。您不应该在生产环境中使用此功能,只在开发过程中翻译视图,然后只需切换回。

待办事项

此包仍然是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 :)