krisboblea/laravel-translation-manager

管理 Laravel 翻译

1.0.1 2019-09-04 13:01 UTC

README

简化 Laravel 中翻译的管理。

Laravel-Translation-Manager by HighSolutions

安装

将以下行添加到您的 Laravel 网站应用 composer.json 文件的 require 部分

    "require": {
        "highsolutions/laravel-translation-manager": "^1.0"
    }

运行 composer update 安装此包。

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

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

接下来,发布所有包资源

    php artisan vendor:publish --provider="HighSolutions\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 文件中搜索,以查看它们是否包含翻译函数,并尝试提取组/项目名称。找到的键将被添加到数据库中,以便它们可以轻松翻译。这可以通过网络界面或通过 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

检测缺失的翻译

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

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

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

实时编辑

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

通过添加服务提供者的条目更新config/app.php

'providers' => [
    // ...
    HighSolutions\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>

不要在不可点击的元素(title属性,alt属性等)内部使用此功能。要启动链接内的弹出窗口,请单击边框,而不是文本。

更新日志

1.0.0

  • 支持Laravel 6.0

0.6.0

  • 不再需要STRICT_MODE

0.5.1

  • 修复翻译搜索

0.5.0

  • 更改视图路径

0.4.7

  • 从配置文件中删除闭包

0.4.5

  • Laravel 5.6支持

0.4.4

  • 修复翻译标题弹出窗口

0.4.3

  • 新配置(弹出位置和基本语言)
  • 更新有关必要JS脚本的文档

0.4.0

  • 新命令:clone和suffix
  • 改进导出命令

0.3.7

  • 新配置选项以排除语言

0.3.6

  • 支持自动发现和Laravel 5.5

0.3.0

  • 支持子目录
  • 支持数组翻译
  • 新设计
  • 权限管理
  • 视图翻译
  • 实时编辑

0.2.0

  • Barryvdh版本的包

路线图

  • 将一个地区的翻译复制到另一个地区,带有地区后缀。
  • 检测不正确的文件。
  • 支持供应商翻译文件。
  • 单元测试!

鸣谢

此包最初由Barry vd. Heuvel创建,可在以下位置找到:laravel-feed

目前由HighSolutions开发,这是一家来自波兰的软件公司,热爱Laravel。