本地化

• 介绍
  • 发布语言文件
  • 配置区域设置
  • 复数语言
• 定义翻译字符串
  • 使用短键
  • 使用翻译字符串作为键
• 检索翻译字符串
  • 替换翻译字符串中的参数
  • 复数
• 覆盖包语言文件

介绍

Laravel 的本地化功能提供了一种方便的方式来检索各种语言的字符串，使你可以在你的应用程序中轻松支持多种语言。

Laravel 提供了两种管理翻译字符串的方式。首先，语言字符串可以存储在应用程序 lang 目录中的文件中。在此目录中，可能存在应用程序支持的每种语言的子目录。这是 Laravel 用于管理内置 Laravel 功能（例如验证错误消息）的翻译字符串的方法。

/lang
    /en
        messages.php
    /es
        messages.php

或者，翻译字符串可以定义在位于 lang 目录中的 JSON 文件中。使用这种方法时，你的应用程序支持的每种语言都将在此目录中有一个对应的 JSON 文件。对于有大量可翻译字符串的应用程序，建议使用这种方法。

/lang
    en.json
    es.json

我们将在本文档中讨论每种管理翻译字符串的方法。

发布语言文件

默认情况下，Laravel 应用程序骨架不包含 lang 目录。如果你想自定义 Laravel 的语言文件或创建你自己的语言文件，你应该通过 lang:publish Artisan 命令构建 lang 目录。lang:publish 命令将在你的应用程序中创建 lang 目录并发布 Laravel 使用的默认语言文件集。

php artisan lang:publish

配置区域设置

你的应用程序的默认语言存储在 config/app.php 配置文件的 locale 配置选项中，通常使用 APP_LOCALE 环境变量进行设置。你可以随意修改此值以满足你的应用程序的需求。

你还可以配置一个“备用语言”，当默认语言不包含给定的翻译字符串时将使用该语言。与默认语言一样，备用语言也在 config/app.php 配置文件中配置，其值通常使用 APP_FALLBACK_LOCALE 环境变量进行设置。

你可以在运行时使用 App 外观模式提供的 setLocale 方法修改单个 HTTP 请求的默认语言。

use Illuminate\Support\Facades\App;
 
Route::get('/greeting/{locale}', function (string $locale) {
    if (! in_array($locale, ['en', 'es', 'fr'])) {
        abort(400);
    }
 
    App::setLocale($locale);
 
    // ...
});

确定当前的区域设置

你可以使用 App 外观模式上的 currentLocale 和 isLocale 方法来确定当前的区域设置或检查该区域设置是否为给定的值。

use Illuminate\Support\Facades\App;
 
$locale = App::currentLocale();
 
if (App::isLocale('en')) {
    // ...
}

复数语言

你可以指示 Laravel 的“复数化器”（Eloquent 和框架的其他部分使用它将单数字符串转换为复数字符串）使用英语以外的语言。这可以通过在你的应用程序的服务提供者之一的 boot 方法中调用 useLanguage 方法来实现。复数化器当前支持的语言有：french、norwegian-bokmal、portuguese、spanish 和 turkish。

use Illuminate\Support\Pluralizer;
 
/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Pluralizer::useLanguage('spanish');
 
    // ...
}

定义翻译字符串

使用短键

通常，翻译字符串存储在 lang 目录中的文件中。在此目录中，应该有你的应用程序支持的每种语言的子目录。这是 Laravel 用于管理内置 Laravel 功能（例如验证错误消息）的翻译字符串的方法。

/lang
    /en
        messages.php
    /es
        messages.php

所有语言文件都返回一个键值对字符串数组。例如

<?php
 
// lang/en/messages.php
 
return [
    'welcome' => 'Welcome to our application!',
];

使用翻译字符串作为键

对于有大量可翻译字符串的应用程序，当在你的视图中引用键时，使用“短键”定义每个字符串可能会变得混乱，并且为你的应用程序支持的每个翻译字符串不断发明键也很麻烦。

因此，Laravel 还支持使用字符串的“默认”翻译作为键来定义翻译字符串。使用翻译字符串作为键的语言文件以 JSON 文件形式存储在 lang 目录中。例如，如果你的应用程序有西班牙语翻译，你应该创建一个 lang/es.json 文件。

{
    "I love programming.": "Me encanta programar."
}

键 / 文件冲突

你不应该定义与其它翻译文件名冲突的翻译字符串键。例如，为 “NL” 区域设置翻译 __('Action')，同时存在 nl/action.php 文件，但不存在 nl.json 文件，将导致翻译器返回 nl/action.php 的全部内容。

检索翻译字符串

你可以使用 __ 辅助函数从你的语言文件中检索翻译字符串。如果你使用“短键”来定义你的翻译字符串，你应该使用“点”语法将包含键的文件和键本身传递给 __ 函数。例如，让我们从 lang/en/messages.php 语言文件中检索 welcome 翻译字符串。

echo __('messages.welcome');

如果指定的翻译字符串不存在，__ 函数将返回翻译字符串键。因此，使用上面的例子，如果翻译字符串不存在，__ 函数将返回 messages.welcome。

如果你使用你的默认翻译字符串作为你的翻译键，你应该将你的字符串的默认翻译传递给 __ 函数；

echo __('I love programming.');

同样，如果翻译字符串不存在，__ 函数将返回它收到的翻译字符串键。

如果您正在使用 Blade 模板引擎，您可以使用 {{ }} 回显语法来显示翻译字符串。

{{ __('messages.welcome') }}

替换翻译字符串中的参数

如果您愿意，可以在翻译字符串中定义占位符。所有占位符都以 : 为前缀。例如，您可以定义一个带有占位符名称的欢迎消息。

'welcome' => 'Welcome, :name',

要在检索翻译字符串时替换占位符，您可以将替换数组作为第二个参数传递给 __ 函数。

echo __('messages.welcome', ['name' => 'dayle']);

如果您的占位符包含全部大写字母，或者只有首字母大写，则翻译后的值将相应地大写。

'welcome' => 'Welcome, :NAME', // Welcome, DAYLE
'goodbye' => 'Goodbye, :Name', // Goodbye, Dayle

对象替换格式化

如果您尝试将一个对象作为翻译占位符提供，则会调用该对象的 __toString 方法。__toString 方法是 PHP 内置的“魔术方法”之一。但是，有时您可能无法控制给定类的 __toString 方法，例如当您正在交互的类属于第三方库时。

在这种情况下，Laravel 允许您为该特定类型的对象注册自定义格式化处理程序。为此，您应该调用翻译器的 stringable 方法。stringable 方法接受一个闭包，该闭包应该类型提示其负责格式化的对象类型。通常，stringable 方法应该在应用程序的 AppServiceProvider 类的 boot 方法中调用。

use Illuminate\Support\Facades\Lang;
use Money\Money;
 
/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Lang::stringable(function (Money $money) {
        return $money->formatTo('en_GB');
    });
}

复数

复数形式是一个复杂的问题，因为不同的语言对于复数形式有各种复杂的规则；但是，Laravel 可以帮助您根据您定义的复数规则翻译不同的字符串。使用 | 字符，您可以区分字符串的单数和复数形式。

'apples' => 'There is one apple|There are many apples',

当然，当使用 将翻译字符串作为键时，也支持复数形式。

{
    "There is one apple|There are many apples": "Hay una manzana|Hay muchas manzanas"
}

您甚至可以创建更复杂的复数规则，为多个值范围指定翻译字符串。

'apples' => '{0} There are none|[1,19] There are some|[20,*] There are many',

在定义了具有复数选项的翻译字符串后，您可以使用 trans_choice 函数来检索给定“计数”的行。在本例中，由于计数大于 1，因此返回翻译字符串的复数形式。

echo trans_choice('messages.apples', 10);

您还可以在复数形式字符串中定义占位符属性。这些占位符可以通过将数组作为第三个参数传递给 trans_choice 函数来替换。

'minutes_ago' => '{1} :value minute ago|[2,*] :value minutes ago',
 
echo trans_choice('time.minutes_ago', 5, ['value' => 5]);

如果您想显示传递给 trans_choice 函数的整数值，您可以使用内置的 :count 占位符。

'apples' => '{0} There are none|{1} There is one|[2,*] There are :count',

覆盖包语言文件

某些包可能附带自己的语言文件。您可以通过将文件放置在 lang/vendor/{package}/{locale} 目录中来覆盖它们，而不是更改包的核心文件来调整这些行。

因此，例如，如果您需要覆盖名为 skyrim/hearthfire 的包中的 messages.php 中的英文翻译字符串，则应将语言文件放置在：lang/vendor/hearthfire/en/messages.php。在此文件中，您应该只定义您希望覆盖的翻译字符串。您未覆盖的任何翻译字符串仍将从包的原始语言文件中加载。