README

为 Laravel 提供简单的国际化本地化，是一个与 Laravel 本地化类结合的有用工具。

该包提供以下功能：

从浏览器检测语言
智能重定向（将区域设置保存在会话/cookie 中）
智能路由（只需定义一次路由，无论使用多少种语言）
可翻译的路由
支持缓存和测试
可选隐藏默认语言在 URL 中
许多片段和辅助工具（如语言选择器）

Laravel 兼容性

安装

通过 composer 安装包：composer require mcamara/laravel-localization

对于 Laravel 5.4 及以下版本，需要注册服务提供者。

配置文件

要编辑默认配置，您可以执行以下操作：

php artisan vendor:publish --provider="Mcamara\LaravelLocalization\LaravelLocalizationServiceProvider"

之后，将创建 config/laravellocalization.php 文件。

配置选项包括：

supportedLocales 您的应用程序语言（默认：英语和西班牙语）。
useAcceptLanguageHeader 如果为 true，则自动从浏览器检测语言。
hideDefaultLocaleInURL 如果为 true，则不在 URL 中显示默认语言。
localesOrder 以自定义顺序排序语言。
localesMapping 重命名 URL 区域设置。
utf8suffix 允许更改适用于 CentOS 等的 utf8suffix。
urlsIgnored 忽略特定 URL。

注册中间件

您可以在 app/Http/Kernel.php 文件中注册包的中间件

<?php namespace App\Http;

use Illuminate\Foundation\Http\Kernel as HttpKernel;

class Kernel extends HttpKernel {
    /**
    * The application's route middleware.
    *
    * @var array
    */
    protected $routeMiddleware = [
        /**** OTHER MIDDLEWARE ****/
        'localize'                => \Mcamara\LaravelLocalization\Middleware\LaravelLocalizationRoutes::class,
        'localizationRedirect'    => \Mcamara\LaravelLocalization\Middleware\LaravelLocalizationRedirectFilter::class,
        'localeSessionRedirect'   => \Mcamara\LaravelLocalization\Middleware\LocaleSessionRedirect::class,
        'localeCookieRedirect'    => \Mcamara\LaravelLocalization\Middleware\LocaleCookieRedirect::class,
        'localeViewPath'          => \Mcamara\LaravelLocalization\Middleware\LaravelLocalizationViewPath::class
    ];
}

使用方法

将以下内容添加到您的路由文件中

// routes/web.php

Route::group(['prefix' => LaravelLocalization::setLocale()], function()
{
	/** ADD ALL LOCALIZED ROUTES INSIDE THIS GROUP **/
	Route::get('/', function()
	{
		return View::make('hello');
	});

	Route::get('test',function(){
		return View::make('test');
	});
});

/** OTHER PAGES THAT SHOULD NOT BE LOCALIZED **/

一旦将此路由组添加到路由文件中，用户就可以访问在 supportedLocales 中添加的所有区域（默认为 en 和 es）。例如，上面的路由文件创建了以下地址

// Set application language to English
http://url-to-laravel/en
http://url-to-laravel/en/test

// Set application language to Spanish
http://url-to-laravel/es
http://url-to-laravel/es/test

// Set application language to English or Spanish (depending on browsers default locales)
// if nothing found set to default locale
http://url-to-laravel
http://url-to-laravel/test

该包根据您的 URL 设置您的应用程序区域 App::getLocale()。然后可以使用它来使用 Laravel 的本地化功能。

您可以将中间件添加到组中，如下所示

Route::group(
[
	'prefix' => LaravelLocalization::setLocale(),
	'middleware' => [ 'localeSessionRedirect', 'localizationRedirect', 'localeViewPath' ]
], function(){ //...
});

建议

1.：强烈建议使用重定向中间件。不带区域的 URL 应仅用于确定浏览器/默认区域，并将其重定向到本地化 URL。否则，当搜索引擎机器人爬取例如 http://url-to-laravel/test 时，它们可能会在每次访问时获取不同的语言内容。另外，对于相同的内容拥有多个 URL 也会创建一个 SEO 重复内容问题。

2.：强烈建议您本地化您的链接，即使您使用了重定向中间件。否则，每次用户点击链接时，至少会导致一次重定向。此外，从表单中获取的任何动作URL都必须进行本地化，以防止它被重定向到GET请求。

重定向中间件

以下重定向中间件依赖于 config/laravellocalization.php 中 hideDefaultLocaleInURL 和 useAcceptLanguageHeader 的设置。

LocaleSessionRedirect

每当URL中存在语言区域时，此中间件都会将其存储在会话中。

如果URL中没有语言区域，则此中间件将检查以下内容：

如果会话中没有保存语言区域且 useAcceptLanguageHeader 设置为 true，则从浏览器中计算语言区域并将用户重定向到带有语言区域的URL。
如果会话中已保存语言区域，则重定向到带有语言区域的URL，除非它是默认语言区域且 hideDefaultLocaleInURL 设置为 true。

例如，如果用户导航到 http://url-to-laravel/test 且当前语言区域为 en，它将自动将其重定向到 http://url-to-laravel/en/test。

LocaleCookieRedirect

类似于 LocaleSessionRedirect，但它将值存储在cookie中而不是会话中。

每当URL中存在语言区域时，此中间件都会将其存储在cookie中。

如果没有语言区域存在于URL中，则此中间件将检查以下内容：

如果cookie中没有保存语言区域且 useAcceptLanguageHeader 设置为 true，则从浏览器中计算语言区域并将用户重定向到带有语言区域的URL。
如果cookie中已保存语言区域，则重定向到带有语言区域的URL，除非它是默认语言区域且 hideDefaultLocaleInURL 设置为 true。

例如，如果用户导航到 http://url-to-laravel/test 且当前语言区域为 de，它将自动将其重定向到 http://url-to-laravel/de/test。

LaravelLocalizationRedirectFilter

当URL中存在默认语言区域且 hideDefaultLocaleInURL 设置为 true 时，则中间件将重定向到不带语言区域的URL。

例如，如果默认语言区域为 es，则 http://url-to-laravel/es/test 将被重定向到 http://url-to-laravel/test，并且 App::getLocale() 将被设置为 es。

辅助工具

此包附带了一系列辅助函数。

本地化URL

在生成本地化路由时，本地化URL会考虑路由模型绑定以及 hideDefaultLocaleInURL 和已翻译的路由设置。

获取本地化URL

    // If current locale is Spanish, it returns `/es/test`
    <a href="{{ LaravelLocalization::localizeUrl('/test') }}">@lang('Follow this link')</a>

获取特定语言区域的本地化URL

获取特定语言区域的当前URL

// Returns current url with English locale.
{{ LaravelLocalization::getLocalizedURL('en') }}

获取干净的路线

返回不带任何本地化的URL。

// Returns /about
{{ LaravelLocalization::getNonLocalizedURL('/es/about') }}

获取特定翻译键的URL

返回指向所需语言区域的路由，本地化。如果给定的语言区域中不存在翻译键，则此函数将返回 false。

// Returns /es/acerca
{{ LaravelLocalization::getURLFromRouteNameTranslated('es', 'routes.about') }}

获取支持的语言区域

以数组形式返回所有支持的语言区域及其属性。

{{ LaravelLocalization::getSupportedLocales() }}

获取支持的语言区域自定义顺序

以配置文件中指定的顺序返回所有支持的语言区域。您可以使用此函数在语言选择器中打印语言区域。

{{ LaravelLocalization::getLocalesOrder() }}

获取支持的语言区域键

返回包含所有支持的语言区域键的数组。

{{ LaravelLocalization::getSupportedLanguagesKeys() }}

获取当前语言区域

返回当前语言区域的键。

{{ LaravelLocalization::getCurrentLocale() }}

获取当前区域名称

以字符串形式返回当前区域的名称（英语/西班牙语/阿拉伯语/等等）。

{{ LaravelLocalization::getCurrentLocaleName() }}

获取当前区域的本地名称

以字符串形式返回当前区域的本地名称（英语/Español/عربى/等等）。

{{ LaravelLocalization::getCurrentLocaleNative() }}

获取当前区域的地域名称

以字符串形式返回当前区域的地域名称（en_GB/en_US/fr_FR/等等）。

{{ LaravelLocalization::getCurrentLocaleRegional() }}

获取当前区域的文字方向

以字符串形式返回当前区域的文字方向（ltr/rtl）。

{{ LaravelLocalization::getCurrentLocaleDirection() }}

获取当前区域的脚本

以字符串形式返回当前区域脚本的国际标准化组织15924代码；“Latn”，“Cyrl”，“Arab”等等。

{{ LaravelLocalization::getCurrentLocaleScript() }}

将视图基本路径设置为当前区域

注册中间件 LaravelLocalizationViewPath 以将当前区域设置为视图基本路径。

现在您可以在基于语言的文件夹中包裹您的视图，就像翻译文件一样。

resources/views/en/，resources/views/fr，...

映射您自己的自定义语言URL段

由于您可以通过重命名键来修改受支持的区域，因此可以使用字符串 uk 而不是 en-GB 来提供自定义语言URL段。当然，您需要防止与已存在的键发生冲突，并且尽可能遵守约定。但是，如果您使用此类自定义键，则必须将您的映射存储到 localesMapping 数组中。此 localesMapping 是必要的，以便使语言协商者能够根据HTTP Accept Language标题正确分配所需的区域。以下是如何将HTTP Accept Language标题 'en-GB' 映射到URL段 'uk' 的快速示例

// config/laravellocalization.php

'localesMapping' => [
	'en-GB' => 'uk'
],

之后，http://url-to-laravel/en-GB/a/b/c 变为 http://url-to-laravel/uk/a/b/c。

LaravelLocalization::getLocalizedURL('en-GB', 'a/b/c'); // http://url-to-laravel/uk/a/b/c
LaravelLocalization::getLocalizedURL('uk', 'a/b/c'); // http://url-to-laravel/uk/a/b/c

创建语言选择器

如果您在项目中支持多个区域，您可能希望提供用户更改语言的方式。以下是您可以用来创建自己的语言选择器的简单blade模板代码示例。

<ul>
    @foreach(LaravelLocalization::getSupportedLocales() as $localeCode => $properties)
        <li>
            <a rel="alternate" hreflang="{{ $localeCode }}" href="{{ LaravelLocalization::getLocalizedURL($localeCode, null, [], true) }}">
                {{ $properties['native'] }}
            </a>
        </li>
    @endforeach
</ul>

请注意，即使 hideDefaultLocaleInURL = true，默认语言也将被强制在getLocalizedURL()中包含在URL中。

请注意，支持路由模型绑定。

已翻译的路由

您可以翻译您的路由。例如，http://url/en/about 和 http://url/es/acerca（acerca是西班牙语中的“关于”）或 http://url/en/article/important-article 和 http://url/es/articulo/important-article（article是西班牙语中的“文章”）将重定向到以下相同的控制器/视图

在您的 Route::group 中至少加载 localize 中间件是必要的（参见安装说明）。

对于每种语言，将 routes.php 添加到 resources/lang/**/routes.php 文件夹中。该文件包含一个包含所有可翻译路由的数组。例如，如下所示

<?php
// resources/lang/en/routes.php
return [
    "about"    =>  "about",
    "article"  =>  "article/{article}",
];

<?php
// resources/lang/es/routes.php
return [
    "about"    =>  "acerca",
    "article"  =>  "articulo/{article}",
];

您可以在 routes/web.php 中添加路由，如下所示

Route::group(['prefix' => LaravelLocalization::setLocale(),
              'middleware' => [ 'localize' ]], function () {

    Route::get(LaravelLocalization::transRoute('routes.about'), function () {
        return view('about');
    });

    Route::get(LaravelLocalization::transRoute('routes.article'), function (\App\Article $article) {
        return $article;
    });

    //,...
});

保存文件后，您可以无问题地访问 http://url/en/about，http://url/es/acerca，http://url/en/article/important-article 和 http://url/es/articulo/important-article。

可翻译路由参数

您可能在之前的示例中注意到了西班牙语URL中的英语缩写

http://url/es/articulo/important-article

可以拥有翻译过的缩写，例如这样

http://url/en/article/important-change
http://url/es/articulo/cambio-importante

然而，为了实现这一点，每篇文章都必须有许多缩略名（每个地区一个）。如何实现这种关系取决于你。可翻译路由参数的唯一要求是，相关的模型实现了 LocalizedUrlRoutable 接口。

实现 LocalizedUrlRoutable

要实现 \Mcamara\LaravelLocalization\Interfaces\LocalizedUrlRoutable，必须创建一个名为 getLocalizedRouteKey($locale) 的函数，该函数必须返回给定地区的翻译后的缩略名。在上面的例子中，在文章模型内部，getLocalizedRouteKey('en') 应返回 important-change，而 getLocalizedRouteKey('es') 应返回 cambio-importante。

路由模型绑定

要使用 route-model-binding，应该在模型中重写 resolveRouteBinding($slug) 函数。该函数应该返回属于翻译后缩略名 $slug 的模型。例如

public function resolveRouteBinding($slug)
{
        return static::findByLocalizedSlug($slug)->first() ?? abort(404);
}

教程视频

您可以查看这个视频，它演示了如何设置可翻译路由参数。

事件

如果您希望在翻译时也翻译URL参数，可以捕获URL参数。为此，只需创建一个名为 routes.translation 的事件监听器，如下所示

Event::listen('routes.translation', function($locale, $attributes)
{
	// Do your magic

	return $attributes;
});

请确保将地区和属性作为参数传递给闭包。您还可以使用事件订阅者，请参阅：https://laravel.net.cn/docs/events#event-subscribers

缓存路由

要缓存您的路由，请使用

php artisan route:trans:cache

... 而不是常规的 route:cache 命令。使用 artisan route:cache 将无法正常工作！

要使路由缓存解决方案正常工作，需要对应用程序路由配置进行轻微调整。

在您的应用程序的 RouteServiceProvider 中，使用 LoadsTranslatedCachedRoutes 特性

<?php
class RouteServiceProvider extends ServiceProvider
{
    use \Mcamara\LaravelLocalization\Traits\LoadsTranslatedCachedRoutes;

有关更多详细信息，请参阅此处。

常见问题

POST 请求不起作用

如果您的 Routes::group 内部的操作路由没有本地化，可能会发生这种情况。这可能会导致重定向，然后将其转换为GET请求。为了防止这种情况，只需使用 localize 辅助函数。

例如，如果您使用 Auth::routes() 并将其放入您的 Route::group，则

<form action="/logout" method="POST">
<button>Logout</button>
</form>

将不起作用。相反，必须使用

<form action="{{  \LaravelLocalization::localizeURL('/logout') }} " method="POST">
<button>Logout</button>
</form>

另一种解决方案是将HTTP方法添加到配置中 'laravellocalization.httpMethodsIgnored'，以防止处理此类请求

MethodNotAllowedHttpException

如果您没有本地化POST URL并使用重定向中间件，那么POST请求将被重定向为GET请求。如果您没有定义此类GET路由，您将引发此异常。

要本地化您的POST URL，请参阅 POST is not working 中的示例。

验证消息只存在于默认地区

如果您没有本地化POST URL，也会发生这种情况。如果您不本地化POST URL，则在验证时设置默认地区，当使用 back() 返回时，它将显示默认地区的验证消息。