tankonyako/laravel-translation-manager

管理 Laravel 翻译

dev-master / 0.6.x-dev 2022-11-19 10:11 UTC

This package is auto-updated.

Last update: 2024-09-19 14:08:19 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 tankonyako/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 翻译 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

在源代码中查找翻译

查找命令/按钮将搜索 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',

这将扩展翻译器,并在找不到键时创建新的数据库条目,这样您就必须访问使用它们的页面。这样,它就会在网页界面中显示出来,可以编辑,然后可以导出。您不应该在生产环境中使用此功能,仅用于开发来翻译视图,然后只需切换回。

待办事项

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