carloscgo/laravel-translation-manager

v1 2018-11-04 01:01 UTC

This package is not auto-updated.

Last update: 2024-09-30 07:14:18 UTC


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历史中,并且在生产环境中不会引入额外的开销。

Screenshot

安装

在composer.json中添加此包并运行composer update(或直接运行composer require carloscgo/laravel-translation-manager

"carloscgo/laravel-translation-manager": "0.4.x-dev"

更新composer后,将ServiceProvider添加到config/app.php中的providers数组中

'CarlosCGO\TranslationManager\ManagerServiceProvider',

您需要为此包运行迁移。

$ php artisan vendor:publish --provider="CarlosCGO\TranslationManager\ManagerServiceProvider" --tag=migrations
$ php artisan migrate

您需要发布此包的配置文件。这将添加config/translation-manager.php文件,您可以在其中配置此包。

$ php artisan vendor:publish --provider="CarlosCGO\TranslationManager\ManagerServiceProvider" --tag=config

为了编辑默认模板,还必须发布视图。视图将放置在resources/views/vendor/translation-manager

$ php artisan vendor:publish --provider="CarlosCGO\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组。

注意:默认情况下,仅添加新字符串。DB中已有的翻译保持不变。如果您想用文件中的值替换所有值,请添加--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.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',
'CarlosCGO\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 :)