简介

默认情况下,Laravel 应用骨架不包含 lang 目录。如果你想要自定义 Laravel 的语言文件,可以通过 lang:publish Artisan 命令发布它们。

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');

    // ...
}

如果你自定义了复数化器的语言,你应该显式定义 Eloquent 模型的表名。

定义翻译字符串

使用短键

通常,翻译字符串存储在 lang 目录下的文件中。在该目录中,应用支持的每种语言都应有一个对应的子目录。这是 Laravel 用来管理诸如验证错误信息等 Laravel 内置功能翻译字符串的方式:

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

所有语言文件都会返回一个带键的字符串数组。例如:

<?php

// lang/en/messages.php

return [
    'welcome' => 'Welcome to our application!',
];

对于因地区而异的语言,应按照 ISO 15897 为语言目录命名。例如,英式英语应使用 “en_GB”,而非 “en-gb”。

以翻译字符串作为键

对于有大量可翻译字符串的应用,在视图中引用所有字符串的“短键”可能会变得混乱,并且不断为应用支持的每个翻译字符串发明键也会十分繁琐。

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

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

键/文件冲突

不应定义与其他翻译文件名冲突的翻译字符串键。例如,当存在 nl/action.php 文件但不存在 nl.json 文件时,为 “NL” 区域设置翻译 __('Action'),会导致翻译器返回 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 方法接受一个闭包,该闭包应进行类型提示,表明它负责格式化的对象类型。通常,应在应用的 AppServiceProvider 类的 boot 方法中调用 stringable 方法:

use Illuminate\Support\Facades\Lang;
use Money\Money;

/**
 * 启动任何应用程序服务。
 */
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。在该文件中,你只需定义想要覆盖的翻译字符串。任何未被覆盖的翻译字符串,仍会从包的原始语言文件中加载。