dyanakiev/laravel-translation-manager

v10.0.1 2022-01-25 00:20 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 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中添加。您可以在配置中设置路由的group参数。您可以更改路由的前缀或过滤器/中间件。如果您想要完全自定义,可以扩展ServiceProvider并覆盖map()函数。

以下示例将使翻译管理器在http://yourdomain.com/translations上可用

如果您想使用Google Translate API进行自动翻译

php artisan vendor:publish --provider=Tanmuhittin\LaravelGoogleTranslate\LaravelGoogleTranslateServiceProvider

编辑config/laravel_google_translate.php并添加您的Google Translate API密钥。

php artisan config:cache

现在您可以使用自动翻译特性

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.phpapp/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界面中,可以编辑并在以后导出。您不应该在生产环境中使用此功能,而只是在开发中翻译视图,然后只需切换回。

待办事项

此包仍处于非常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 :)