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 文件中，将以下条目从 providers 数组中替换

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/validations.php 中的内容，其中 'en' 是默认区域设置，如下所示

		[
			'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'，用于供应商翻译文件。
组变量是您希望清除的翻译文件的路径。

例如，假设我们在资源目录/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 */
        });
    });

在您的视图中，对于Middleware激活的路线，您可以使用共享变量向用户提供一个菜单，以便从当前语言切换到其他语言。例如

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

anurak-kg / translation

维护者

详细信息