imtigger/laravel-translation-manager

管理Laravel翻译

0.8.0 2020-03-24 05:52 UTC

README

轻松管理Laravel中的翻译。

安装

将以下行添加到Laravel webapp的composer.json文件中的require部分:

    "require": {
        "Imtigger/laravel-translation-manager": "^0.7"
    }

运行composer update以安装包。

然后,通过添加服务提供者条目来更新config/app.php

'providers' => [
    // ...
    Imtigger\TranslationManager\ManagerServiceProvider::class,
];

接下来,发布所有包资源

    php artisan vendor:publish --provider="Imtigger\TranslationManager\ManagerServiceProvider"

这将添加到您的项目

- migration - database table for storing translations
- configuration - package configurations
- views - configurable views for translation management
- translations - translations for webinterface

请记住启动迁移

    php artisan migrate

工作流程

此包不会替换翻译系统,仅将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
- Optionally: Mark not-translated records as not-translated (suffix command)
- Translate all keys through the webinterface
- Export: Write all translations back to the translation files.

用法

在默认配置中,您可以通过http://yourdomain.com/translations访问包。您可以根据需要更改它。

配置

命令

导入命令

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

    php artisan translations:import

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

在源代码中查找翻译

查找命令/按钮将在app目录中的所有php/twig文件中搜索,查看是否包含翻译函数,并尝试提取组/项名称。找到的键将添加到数据库中,以便它们可以轻松翻译。这可以通过Web界面或Artisan命令完成。

    php artisan translations:find

导出命令

导出命令将数据库的内容写回到resources/lang php文件中。这将覆盖现有翻译并删除所有注释,因此在使用之前请确保备份您的数据。提供组名以定义您想要发布的组。如果您要导出所有组,请提供组名为*

    php artisan translations:export <group>

例如,当您有2个区域设置(en/pl)时,php artisan translations:export reminders将写入resources/lang/en/reminders.phpresources/lang/pl/reminders.php

清理命令

清理命令将搜索所有为NULL的翻译并删除它们,以便您的界面更加整洁。注意:空翻译永远不会导出。

    php artisan translations:clean

重置命令

重置命令简单地将数据库中的所有翻译清除,以便您可以重新开始(通过新的导入)。在执行此操作之前,请确保导出您的工作(如果需要的话)。

    php artisan translations:reset

克隆命令

克隆命令将基本语言(langFrom参数)的目录复制并保存为新语言(langTo参数)。在此操作之后,您将需要启动导入命令。

    php artisan translations:clone langFrom langTo

后缀命令

后缀命令分析新区域设置(langNew参数)中的所有翻译,如果值与原始语言(langOriginal参数)中的值相同,则将后缀添加到新区域设置翻译值的末尾以标记此翻译需要翻译。后缀是区域代码(例如EN)的大写形式。

    php artisan translations:sufix langOriginal langNew

生成命令

生成命令查找数据库中指定区域设置(默认为en)的空值,并使用翻译键的最后一部分生成值。最好与“检测缺失的翻译”一起使用。

示例

  • "backend.label.order_number" 变为 "订单号"
  • "backend.action-button.submit-form" 变为 "提交表单"
    php artisan translations:generate [--import] [--export] [--group=backend] [--locale=en]

选项

  • --import 在生成前导入翻译
  • --export 立即导出翻译
  • --locale[=LOCALE] 翻译区域 [默认: "en"]
  • --group[=GROUP] 翻译组 [默认: "backend"]

检测缺失的翻译

大多数翻译可以通过使用查找命令(见上方)找到,但在您有动态密钥(变量/自动表单等)的情况下,监听缺失的翻译可能会有所帮助。为了检测缺失的翻译,我们可以用自定义提供者替换 Laravel TranslationServiceProvider。在您的 config/app.php 中,注释掉原始的 TranslationServiceProvider 并添加此包中的一个

    //'Illuminate\Translation\TranslationServiceProvider',
    'Imtigger\TranslationManager\TranslationServiceProvider',

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

实时编辑

当您在数据库中有翻译时,您可以在适当的情况下使用 transEditable 方法代替 trans。为此,您必须执行几个步骤

更新 config/app.php,添加服务提供者(另一个)的条目

'providers' => [
    // ...
    Imtigger\TranslationManager\TranslationServiceProvider::class,
];

将这两个方法添加到 app\helpers.php 文件中。

if (!function_exists('transEditable')) {
    /**
     * Translate the given message and wraps it in .editable container to allow editing
     *
     * @param  string  $id
     * @param  array   $parameters
     * @param  string  $domain
     * @param  string  $locale
     * @return \Symfony\Component\Translation\TranslatorInterface|string
     */
    function transEditable($id = null, $parameters = [], $domain = 'messages', $locale = null) {
        return app('translator')->transEditable($id, $parameters, $locale);
    }
}

if (!function_exists('isLiveTranslationEnabled')) {
    /**
     * Return true if live translation enabled
     *
     * @return bool
     */
    function isLiveTranslationEnabled() {
        return Request::cookie('live-translation-enabled') || config('translation-manager.live_translation_enabled');
    }
}

在您的布局视图中添加这些脚本和样式(见布局定制部分)

    <link href="//cdnjs.cloudflare.com/ajax/libs/x-editable/1.5.0/bootstrap3-editable/css/bootstrap-editable.css" rel="stylesheet"/>
    <style>
        .editable-click {
            border-bottom-color: red;
            cursor: pointer;
        }

        .editableform .control-group {
            display: block;
        }

        .editable-input {
            display: block;
        }

        .editable-input > textarea {
            width: 100% !important;
        }

        .editable-buttons {
            margin: 10px 0 0;
            text-align: right;
            width: 100%;
        }

        .editable-buttons .editable-submit {
            float: right;
            margin-left: 10px;
        }
    </style>
    // ...
    <script src="//cdnjs.cloudflare.com/ajax/libs/x-editable/1.5.0/bootstrap3-editable/js/bootstrap-editable.min.js"></script>

如果您想将所有链接转换为非链接,请添加此小脚本

<script>
    $('.editable').parent('a').replaceWith(function () {
            return $('<div/>', {
                html: this.innerHTML
            });
        }
    );
</script>

最后一步是添加此 JS 文件

jQuery(document).ready(function($){

    $.ajaxSetup({
        beforeSend: function(xhr, settings) {
            settings.data += "&_token=" + $(':hidden[name="_token"]').val();
        }
    });

    $('.editable').editable().on('hidden', function(e, reason){
        var locale = $(this).data('locale');
        if(reason === 'save'){
            $(this).removeClass('status-0').addClass('status-1');
        }
        if(reason === 'save' || reason === 'nochange') {
            var $next = $(this).closest('tr').next().find('.editable.locale-'+locale);
            setTimeout(function() {
                $next.editable('show');
            }, 300);
        }
    });

    $(document).on('click', 'a', function(event) {
        if (event.target.localName !== 'a' && event.target.className.indexOf('editable-submit') !== -1) {
            event.preventDefault();
            return false;
        }
    });
});

现在您可以使用 transEditable 辅助程序,当实时编辑处于活动状态(通过 isLiveTranslationEnabled 检查)时,用户可以单击文本,会显示弹出窗口,可以更改文本。保存更改将导致将文本保存到数据库,并将其导出到翻译文件。如果实时编辑未激活,则用户将看到标准文本。

您可以使用此辅助程序如下

	<div class="text">{!! transEditable('auth.failed') !!}</div>

不要在不可点击的元素(标题属性、alt 属性等)内部使用此辅助程序。要启动链接内的弹出窗口,请单击边框,而不是文本。

路线图

  • 检测错误的文件。
  • 从密钥自动生成占位符
  • 自动进行简体中文 <=> 简化中文转换
  • 单元测试!

鸣谢

此包最初由 Barry vd. Heuvel 创建,并在此处可用: laravel-translation-manager

然后由 HighSolutions 开发,并在此处可用: laravel-translation-manager

目前由 Imtigger 开发