barryvdh/laravel-translation-manager

管理Laravel翻译

v0.6.6 2024-03-09 19:36 UTC

README

Tests Packagist License Latest Stable Version Total Downloads Fruitcake

这是一个用于管理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

您需要为此包运行迁移。

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可用

如果您想使用Google Translate API进行自动翻译,请安装https://github.com/tanmuhittin/laravel-google-translate

composer require tanmuhittin/laravel-google-translate
php artisan vendor:publish --provider=Tanmuhittin\LaravelGoogleTranslate\LaravelGoogleTranslateServiceProvider

中间件/认证

默认情况下,配置文件只包括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

在源代码中查找翻译

查找命令/按钮将在应用目录中搜索所有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 :)