野丹/laravel-translation-manager

dev-master / 0.5.x-dev 2021-08-30 12:45 UTC

This package is auto-updated.

Last update: 2024-08-29 05:37:31 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 vildanbina/laravel-translation-manager

composer require vildanbina/laravel-translation-manager

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

'vildanbina\TranslationManager\ManagerServiceProvider',

您需要为此包运行迁移

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

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

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

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

$ php artisan vendor:publish --provider="vildanbina\TranslationManager\ManagerServiceProvider" --tag=views

路由在 ServiceProvider 中添加。您可以在配置中设置路由的组参数。您可以更改前缀或路由的过滤器/中间件。如果您想要完全自定义,您可以扩展 ServiceProvider 并重写 map() 函数。

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

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

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

编辑 config/laravel_google_translate.php 并添加您的 Google 翻译 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(及更高版本)

用法

网页界面

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

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

您还可以使用以下命令。

导入命令

导入命令将搜索 app/lang 并将所有字符串加载到数据库中,以便您轻松管理。

$ php artisan translations:import

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

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

在源代码中查找翻译

查找命令/按钮将在 app 目录中的所有 php/twig 文件中搜索,以查看它们是否包含翻译函数,并尝试提取组/项目名称。找到的键将添加到数据库中,以便它们可以轻松翻译。这可以通过网页界面或 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',
'vildanbina\TranslationManager\TranslationServiceProvider',

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

待办事项

此包仍然处于非常初级的阶段。待办事项列表中有几件事情。

- 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 :)