10pearls/laravel-multilingual

Laravel 5 的数据库和缓存支持的翻译包

2.3.5 2017-09-15 07:59 UTC

README

介绍

保持项目翻译的正确更新是繁琐的。通常翻译者没有访问代码库的权限,即使他们有,也很难跟踪每种语言的缺失翻译,或者当原始文本更新需要修改翻译时。

此包允许开发者利用数据库和缓存来管理多语言网站,同时在开发期间仍然可以处理语言文件,并从Laravel的Translation包的所有功能中受益,例如复数或替换。

目录

Laravel 兼容性

功能概述

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

安装

通过composer要求

composer require 10pearls/laravel-multilingual 2.3.x

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

"require": {
	"10pearls/laravel-multilingual": "2.3.x"
}

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

Illuminate\Translation\TranslationServiceProvider::class

Waavi\Translation\TranslationServiceProvider::class

删除您的配置缓存

php artisan config:cache

发布配置文件和迁移

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不同,如果在指定的区域找不到行,我们首先会检查默认语言中的条目。如果您希望仅使用此模式,您需要设置'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\Translatable\Trait;
	    protected $translatableAttributes = ['title', 'text'];
	}

Uri 本地化

您可以使用 Waavi\Translation\Middleware\TranslationMiddleware 确保所有 URL 都正确本地化。TranslationMiddleware 仅将没有区域设置的 GET 请求重定向。

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

  • 中间件将检查是否存在区域设置。
  • 如果存在有效的区域设置
    • 它将为该区域设置全局设置语言
    • 以下数据将在您的视图中可用
      • currentLanguage:当前选定的语言实例。
      • 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>