README

为Laravel提供简单易用的i18n本地化，是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

在生成本地化路由时，考虑了路由模型绑定以及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() }}

获取当前地区本地名称

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

{{ LaravelLocalization::getCurrentLocaleNative() }}

获取当前地区方向

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

{{ LaravelLocalization::getCurrentLocaleDirection() }}

获取当前地区脚本

以字符串形式返回当前地区脚本的ISO 15924代码；“Latn”，“Cyrl”，“Arab”等。

{{ LaravelLocalization::getCurrentLocaleScript() }}

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

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

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

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

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

由于您可以修改支持的语言（即使是通过更改它们的键），因此可以使用字符串uk而不是en-GB来提供自定义语言URL段。当然，您需要防止与现有键的任何冲突，并且应尽可能遵循约定。但是，如果您使用此类自定义键，您必须将映射存储到localesMapping数组中。此localesMapping对于启用语言协商器根据HTTP Accept Language Header正确分配所需的语言至关重要。以下是一个快速示例，说明如何将HTTP Accept Language Header '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>

在此，默认语言将强制在getLocalizedURL()中出现在URL中，即使hideDefaultLocaleInURL = true。

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

已翻译的路由

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

必须有至少加载到您的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中的英语slug

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

可以拥有翻译后的slug，例如如下所示

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

但是，为了做到这一点，每篇文章都必须有许多slug（每个区域设置一个）。这取决于您如何实现这种关系。对于可翻译路由参数的唯一要求是，相关的模型实现了接口LocalizedUrlRoutable。

实现LocalizedUrlRoutable

要实现\Mcamara\LaravelLocalization\Interfaces\LocalizedUrlRoutable，必须创建函数getLocalizedRouteKey($locale)，它必须返回给定区域设置的翻译slug。在上面的示例中，在文章模型内部，getLocalizedRouteKey('en')应返回important-change，而getLocalizedRouteKey('es')应返回cambio-importante。

路由模型绑定

要使用路由模型绑定，应覆盖模型中的函数resolveRouteBinding($slug)。该函数应返回属于翻译slug $slug的模型。例如

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

教程视频

您可能想查看这个视频，该视频演示了如何设置可翻译的路由参数。

事件

如果您也想翻译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将无法正确工作！

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

在您的App的RouteServiceProvider中，使用LoadsTranslatedCachedRoutes特性

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

更多详情请见这里。

常见问题

POST不工作

这可能会发生在您没有对Routes::group内的操作路由进行本地化时。这可能会导致重定向，从而将POST请求转换为GET请求。为了防止这种情况，只需使用本地化辅助函数。

例如，如果您使用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不工作。

验证消息仅在默认语言中

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