README

简介

保持项目翻译的及时更新是一项繁琐的工作。通常翻译人员无法访问代码库，即使他们可以访问，也很难跟踪哪些翻译缺失以及何时需要更新原始文本。

此包允许开发人员利用数据库和缓存来管理多语言网站，同时在开发过程中仍可以处理语言文件，并从Laravel翻译包的所有功能中受益，例如复数或替换。

WAAVI是一家位于西班牙马德里的网络开发工作室。您可以在waavi.com了解更多关于我们的信息。

Laravel兼容性

功能概述

允许动态更改网站的文本和翻译。
缓存您的本地化条目。
将您的翻译文件加载到数据库中。
强制将URL本地化（例如：/home -> /es/home）并自动通过浏览器的配置设置区域设置。
本地化模型属性。

安装

通过composer要求

composer require waavi/translation 2.3.x

或手动编辑您的composer.json文件

"require": {
	"waavi/translation": "2.3.x"
}

安装后，在您项目的config/app.php文件中，将提供者数组中的以下条目替换为

Illuminate\Translation\TranslationServiceProvider::class

为

Waavi\Translation\TranslationServiceProvider::class

删除您的配置缓存

php artisan config:clear

发布配置文件和迁移

php artisan vendor:publish --provider="Waavi\Translation\TranslationServiceProvider"

执行数据库迁移

php artisan migrate

您可以在以下位置查看包的配置文件

config/translator.php

翻译源

此包允许您从常规的Laravel本地化文件（在/resources/lang中）、从数据库、从缓存或以前混合方式加载翻译，用于开发。您可以通过translator.php配置文件和/或TRANSLATION_SOURCE环境变量配置所需的操作模式。接受的值包括

'files' 从Laravel的语言文件（默认）加载翻译
'database' 从数据库加载翻译
'mixed' 从文件系统和数据库中加载翻译，文件系统具有优先级。
'mixed_db' 从文件系统和数据库中加载翻译，数据库具有优先级。[v2.1.5.3]

注意：将包添加到现有的Laravel项目时，必须使用'files'，直到执行迁移。

有关缓存配置，请参阅缓存配置

从文件加载翻译

如果您不想利用数据库进行翻译，可以选择仅通过语言文件加载语言行。此模式与Laravel不同之处在于，如果指定的区域设置中找不到行，我们首先检查默认语言中的条目，而不是立即返回键。如果您希望完全使用此模式，则需要设置'available_locales'配置文件

config/translator.php
	'available_locales' => ['en', 'es', 'fr'],

示例

默认区域设置为'en'的en/validations.php中的内容是

		[
			'missing_name'			=>	'Name is missing',
			'missing_surname'		=>	'Surname is missing',
		];

es/validations.php中的内容是

		[
			'missing_name'			=>	'Falta el nombre',
		];

使用 'es' 本地化的不同键输出

		trans('validations.missing_name'); 		// 		'Falta el nombre'
		trans('validations.missing_surname'); 	// 		'Surname is missing'
		trans('validations.missing_email'); 	// 		'validations.missing_email'

从数据库加载翻译

您可以选择仅从数据库加载翻译。如果您打算允许用户或管理员实时编辑网站文本和翻译，这将非常有用。在生产环境中，您通常希望启用翻译的缓存来激活此源模式。有关使用此源模式所需的步骤的详细信息，请参阅将您的文件加载到数据库中。

示例

语言表中的内容是

	| id | locale | name    |
	-------------------------
	| 1  | en     | english |
	| 2  | es     | spanish |

语言_entries 表中的相关内容是

	| id | locale | namespace | group       | item	          | text                    |
	-------------------------------------------------------------------------------------
	| 1  | en     | *         | validations | missing.name    | Name is missing         |
	| 2  | en     | *         | validations | missing.surname | Surname is missing      |
	| 3  | en     | *         | validations | min_number      | Number is too small     |
	| 4  | es     | *         | validations | missing.name    | Falta nombre   			|
	| 5  | es     | *         | validations | missing.surname | Falta apellido 			|

使用 es 本地化的不同键输出

		trans('validations.missing.name');   //    'Falta nombre'
		trans('validations.min_number');     //    'Number is too small'
		trans('validations.missing.email');  //    'missing_email'

混合模式

在混合模式下，当查找一组语言行时，会查询语言文件和数据库。文件系统中的条目优先于数据库。这种源模式在开发时非常有用，因为它会考虑文件系统和用户条目。

示例

When files and database are set like in the previous examples:

		trans('validations.missing_name');     //    'Falta el nombre'
		trans('validations.missing_surname');  //    'Falta apellido'
		trans('validations.min_number');       //    'Number is too small'
		trans('validations.missing_email');    //    'missing_email'

将文件加载到数据库中

当使用数据库或混合翻译源时，您需要首先将翻译加载到数据库中。为此，请按照以下步骤操作

运行安装说明中详细说明的迁移。
将您选择的语言添加到数据库中（请参阅管理数据库语言）
使用提供的 Artisan 命令将语言文件加载到数据库中

php artisan translator:load

当执行 artisan 命令时，将发生以下情况

将创建不存在的条目。
现有条目将被更新（除非它们被锁定）。当允许用户实时编辑翻译时，建议您通过翻译存储库中提供的 updateAndLock 方法进行操作。这可以防止在重新加载翻译文件时覆盖条目。
当编辑默认语言的条目时，所有翻译将被标记为待审核。这给翻译者提供了机会来审查可能不正确的翻译，但不会删除它们，以避免源文本中的微小错误更改删除所有翻译。有关如何处理不稳定翻译的详细信息，请参阅管理翻译。

支持供应商文件和子目录。请注意，当加载子目录中的条目时，Laravel 5 已经更改了语法为

	trans('subdir/file.entry')
	trans('package::subdir/file.entry')

缓存翻译

由于每次加载语言组时都查询数据库效率极低，您可以选择利用 Laravel 的缓存系统。此模块将使用您在 app/config/cache.php 中定义的相同缓存配置。

您可以通过 translator.php 配置文件或 'TRANSLATION_CACHE_ENABLED' 环境变量启用或禁用缓存。配置选项是

缓存标签

自版本 2.1.3.8 以来可用。如果使用的缓存存储支持标签，则 TRANSLATION_CACHE_SUFFIX 将用作所有缓存条目的通用标签。这建议用于能够仅使翻译缓存无效，甚至只是给定的语言、命名空间和组配置。

清除缓存

自版本 2.1.3.8 以来可用，您可以通过 Artisan 命令和 Facade 清除翻译缓存。如果使用缓存标签，则仅清除翻译缓存。如果没有缓存标签，则将清除您应用程序的所有缓存。

缓存刷新命令

php artisan translator:flush

为了访问翻译缓存，将以下别名添加到您的 config/app.php 文件中

    'aliases'         => [
        /* ... */
        'TranslationCache' => \Waavi\Translation\Facades\TranslationCache::class,
    ]

完成此操作后，您可以通过调用来清除整个翻译缓存

    \TranslationCache::flushAll();

您还可以选择使给定的语言、命名空间和组组合无效。

    \TranslationCache::flush($locale, $group, $namespace);

区域是指您希望清除的语言区域。
命名空间可以是 '*'，用于您的应用程序翻译文件，或 'package'，用于供应商翻译文件。
组变量是要清除的翻译文件的路径。

例如，假设我们在 resources/lang 目录中有一个以下文件：en/auth.php，en/auth/login.php 和 en/vendor/waavi/login.php。要清除每个文件的缓存条目，您将调用

    \TranslationCache::flush('en', 'auth', '*');
    \TranslationCache::flush('en', 'auth/login', '*');
    \TranslationCache::flush('en', 'login', 'waavi');

在数据库中管理语言和翻译

推荐通过提供的存储库来管理语言和翻译。您可以直接通过语言和翻译模型保存更改来规避此操作，但是模型保存时不再自动执行验证，可能导致不稳定和错误。

语言和翻译存储库提供以下方法

管理语言

应该通过 \Waavi\Translation\Repositories\LanguageRepository 来管理语言，以确保在插入和更新之前进行适当的数据验证。建议您通过依赖注入实例化此类。

有效的语言记录需要其名称和区域都是唯一的。建议您使用每种语言的本地名称（例如：英语、西班牙语、法语）

提供的方法是

管理翻译

应该通过 \Waavi\Translation\Repositories\TranslationRepository 来管理翻译，以确保在插入和更新之前进行适当的数据验证。建议您通过依赖注入实例化此类。

有效的翻译条目不能与另一个条目具有相同的区域和语言代码。

提供的方法是

注意事项

您可以将翻译锁定，以便只能通过 updateAndLock 来更新。语言文件加载器使用 update 方法，无法覆盖已锁定的翻译。
当更新属于默认区域的文本条目时，所有同级条目都会被标记为待审。
当删除条目时，如果它属于默认区域，其翻译也会被删除。

模型属性翻译

您还可以使用翻译管理系统来管理模型属性翻译。为此，您只需

确保已设置数据库或混合源。
确保您的模型使用 Waavi\Translation\Translatable\Trait
在您的模型中，添加一个 translatableAttributes 数组，其中包含您希望可用于翻译的属性名称。
对于每个您希望翻译的字段，确保数据库中有一个相应的 attributeName_translation 字段。

示例

	\Schema::create('examples', function ($table) {
        $table->increments('id');
        $table->string('slug')->nullable();
        $table->string('title')->nullable();
        $table->string('title_translation')->nullable();
        $table->string('text')->nullable();
        $table->string('text_translation')->nullable();
        $table->timestamps();
    });

    class Example extends Model
	{
	    use \Waavi\Translation\Traits\Translatable;
	    protected $translatableAttributes = ['title', 'text'];
	}

URI本地化

您可以使用 Waavi\Translation\Middleware\TranslationMiddleware 来确保所有 URL 都被适当地本地化。TranslationMiddleware 只会重定向不包含区域的 GET 请求。

例如，如果用户访问 URL /home，以下将发生

中间件将检查是否存在区域。
如果存在有效的区域
- 它将全局设置该区域的语言
- 以下数据将在您的视图中可用
  - currentLanguage：当前选择的 Language 实例。
  - selectableLanguages：访问者可以切换到的所有语言列表（除当前语言外）
  - altLocalizedUrls：当前资源的所有本地化 URL 列表（除了这个之外），格式为 ['locale' => 'en', 'name' => 'English', 'url' => '/en/home']
如果没有区域存在
- 检查浏览器接受的区域 HTTP_ACCEPT_LANGUAGE 的前两个字母（例如 'en-us' => 'en'）
- 如果是有效的区域，将用户重定向到该区域 => /es/home
- 如果不是，则重定向到默认区域 => /en/home
- 重定向将保留 URL 中的输入数据（如果有）

您可以选择通过将中间件添加到您的 App\Http\Kernel 文件来全局激活此中间件

	protected $middleware = [
		/* ... */
        \Waavi\Translation\Middleware\TranslationMiddleware::class,
    ]

或通过 'localize' 路由中间件选择性地应用它，该中间件在通过 ServiceProvider 安装包时已注册。

建议您将以下别名添加到您的 config/app.php 别名中

	'aliases'         => [
		/* ... */
		'UriLocalizer'	=> Waavi\Translation\Facades\UriLocalizer::class,
    ];

每个本地化路由都必须以当前区域为前缀

	// If the middleware is globally applied:
	Route::group(['prefix' => \UriLocalizer::localeFromRequest()], function(){
		/* Your routes here */
	});

	// For selectively chosen routes:
	Route::group(['prefix' => \UriLocalizer::localeFromRequest(), 'middleware' => 'localize')], function () {
	    /* Your routes here */
	});

从v2.1.6版本开始，您也可以在URL中指定本地化段落的自定义位置。例如，如果本地化信息是URL中的第三个段落（/api/v1/es/my_resource），您可以这样做：

    // For selectively chosen routes:
    Route::group(['prefix' => 'api/v1'], function() {
        /** ... Non localized urls here **/

        Route::group(['prefix' => \UriLocalizer::localeFromRequest(2), 'middleware' => 'localize:2')], function () {
            /* Your localized routes here */
        });
    });

在您的视图中，对于启用中间件的路由，您可以使用共享变量为用户提供一个菜单，以便在当前语言和另一种语言之间切换。例如：

<li class="dropdown">
    <a href="#" class="dropdown-toggle" data-toggle="dropdown">{{ $currentLanguage->name }} <b class="caret"></b></a>
    <ul class="dropdown-menu">
        @foreach ($altLocalizedUrls as $alt)
            <li><a href="{{ $alt['url'] }}" hreflang="{{ $alt['locale'] }}">{{ $alt['name'] }}</a></li>
        @endforeach
    </ul>
</li>

provalido / translation

维护者

详细信息