Skip to content

本地化

介绍

lightbulb

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

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

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

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

或者,翻译字符串可以定义在放置在 lang 目录中的 JSON 文件中。采用这种方法时,应用程序支持的每种语言将在此目录中有一个相应的 JSON 文件。对于具有大量可翻译字符串的应用程序,推荐使用这种方法:

php
/lang
    en.json
    es.json

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

发布语言文件

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

shell
php artisan lang:publish

配置语言环境

应用程序的默认语言存储在 config/app.php 配置文件的 locale 配置选项中。您可以自由修改此值以满足应用程序的需求。

您可以在运行时使用 App facade 提供的 setLocale 方法修改单个 HTTP 请求的默认语言:

php
use Illuminate\Support\Facades\App;

Route::get('/greeting/{locale}', function (string $locale) {
    if (! in_array($locale, ['en', 'es', 'fr'])) {
        abort(400);
    }

    App::setLocale($locale);

    // ...
});

您可以配置一个“回退语言”,当活动语言不包含给定的翻译字符串时将使用该语言。与默认语言一样,回退语言也在 config/app.php 配置文件中配置:

php
'fallback_locale' => 'en',

确定当前语言环境

您可以使用 App facade 上的 currentLocaleisLocale 方法来确定当前语言环境或检查语言环境是否为给定值:

php
use Illuminate\Support\Facades\App;

$locale = App::currentLocale();

if (App::isLocale('en')) {
    // ...
}

复数化语言

您可以指示 Laravel 的“复数化器”,该复数化器由 Eloquent 和框架的其他部分使用,将单数字符串转换为复数字符串,以使用英语以外的语言。这可以通过在应用程序的服务提供者之一的 boot 方法中调用 useLanguage 方法来实现。复数化器当前支持的语言有:frenchnorwegian-bokmalportuguesespanishturkish

php
use Illuminate\Support\Pluralizer;

/**
 * 启动任何应用程序服务。
 */
public function boot(): void
{
    Pluralizer::useLanguage('spanish');

    // ...
}
exclamation

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

定义翻译字符串

使用短键

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

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

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

php
<?php

// lang/en/messages.php

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

对于按地区划分的语言,您应该根据 ISO 15897 命名语言目录。例如,应该使用“en_GB”表示英式英语,而不是“en-gb”。

使用翻译字符串作为键

对于具有大量可翻译字符串的应用程序,使用“短键”定义每个字符串在引用视图中的键时可能会变得混乱,并且不断为应用程序支持的每个翻译字符串发明键是繁琐的。

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

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

键/文件冲突

您不应定义与其他翻译文件名冲突的翻译字符串键。例如,在“NL”语言环境中翻译 __('Action'),而存在 nl/action.php 文件但不存在 nl.json 文件,将导致翻译器返回 nl/action.php 的全部内容。

检索翻译字符串

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

php
echo __('messages.welcome');

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

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

php
echo __('I love programming.');

同样,如果翻译字符串不存在,__ 函数将返回给定的翻译字符串键。

如果您使用 Blade 模板引擎,您可以使用 {{ }} 回显语法显示翻译字符串:

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

替换翻译字符串中的参数

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

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

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

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

如果您的占位符包含所有大写字母,或仅首字母大写,翻译后的值将相应地大写:

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

对象替换格式化

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

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

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

/**
 * 启动任何应用程序服务。
 */
public function boot(): void
{
    Lang::stringable(function (Money $money) {
        return $money->formatTo('en_GB');
    });
}

复数化

复数化是一个复杂的问题,因为不同的语言有各种复杂的复数化规则;然而,Laravel 可以帮助您根据您定义的复数化规则以不同方式翻译字符串。使用 | 字符,您可以区分字符串的单数和复数形式:

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

当然,当使用翻译字符串作为键时,也支持复数化:

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

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

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

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

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

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

php
'minutes_ago' => '{1} :value minute ago|[2,*] :value minutes ago',

echo trans_choice('time.minutes_ago', 5, ['value' => 5]);

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

php
'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。在此文件中,您只需定义要覆盖的翻译字符串。您未覆盖的任何翻译字符串仍将从包的原始语言文件中加载。