本地化
简介
默认情况下,Laravel 应用程序骨架不包含 lang 目录。如果您想自定义 Laravel 的语言文件,可以通过 lang:publish Artisan 命令发布它们。
Laravel 的本地化功能提供了一种便捷的方式来获取不同语言的字符串,使您可以轻松地在应用程序中支持多种语言。
Laravel 提供了两种管理翻译字符串的方法。首先,语言字符串可以存储在应用程序的 lang 目录下的文件中。在该目录中,可以为应用程序支持的每种语言设置子目录。这是 Laravel 管理内置功能(例如验证错误消息)翻译字符串所采用的方法。
1/lang2 /en3 messages.php4 /es5 messages.php
或者,翻译字符串也可以定义在放置于 lang 目录中的 JSON 文件内。采用这种方法时,应用程序支持的每种语言在该目录下都将拥有一个对应的 JSON 文件。对于拥有大量可翻译字符串的应用程序,建议使用此方法。
1/lang2 en.json3 es.json
我们将在本文档中讨论这两种管理翻译字符串的方法。
发布语言文件
默认情况下,Laravel 应用程序框架中不包含 lang 目录。如果您想要自定义 Laravel 的语言文件或创建自己的语言文件,应该通过 lang:publish Artisan 命令来生成 lang 目录。lang:publish 命令将在您的应用程序中创建 lang 目录,并发布 Laravel 所使用的默认语言文件集。
1php artisan lang:publish
配置区域设置 (Locale)
应用程序的默认语言存储在 config/app.php 配置文件中的 locale 配置选项中,通常通过 APP_LOCALE 环境变量进行设置。您可以根据应用程序的需要自由修改此值。
您还可以配置“回退语言”,当默认语言不包含给定的翻译字符串时,将使用该语言。与默认语言一样,回退语言也在 config/app.php 配置文件中配置,其值通常通过 APP_FALLBACK_LOCALE 环境变量设置。
您可以使用 App 外观(Facade)提供的 setLocale 方法在运行时修改单个 HTTP 请求的默认语言。
1use Illuminate\Support\Facades\App; 2 3Route::get('/greeting/{locale}', function (string $locale) { 4 if (! in_array($locale, ['en', 'es', 'fr'])) { 5 abort(400); 6 } 7 8 App::setLocale($locale); 9 10 // ...11});
确定当前区域设置
您可以使用 App 外观上的 currentLocale 和 isLocale 方法来确定当前区域设置,或检查区域设置是否为给定值。
1use Illuminate\Support\Facades\App;2 3$locale = App::currentLocale();4 5if (App::isLocale('en')) {6 // ...7}
复数语言
您可以指示 Laravel 的“复数转换器”(被 Eloquent 和框架的其他部分用于将单数字符串转换为复数字符串)使用除英语之外的其他语言。这可以通过在应用程序的服务提供者之一的 boot 方法中调用 useLanguage 方法来实现。复数转换器目前支持的语言有:french(法语)、norwegian-bokmal(挪威博克马尔语)、portuguese(葡萄牙语)、spanish(西班牙语)和 turkish(土耳其语)。
1use Illuminate\Support\Pluralizer; 2 3/** 4 * Bootstrap any application services. 5 */ 6public function boot(): void 7{ 8 Pluralizer::useLanguage('spanish'); 9 10 // ...11}
如果您自定义了复数转换器的语言,则应显式定义 Eloquent 模型的 数据表名称。
定义翻译字符串
使用短键
通常,翻译字符串存储在 lang 目录下的文件中。在该目录中,应为应用程序支持的每种语言创建一个子目录。这是 Laravel 管理内置功能(如验证错误消息)的翻译字符串所使用的方法。
1/lang2 /en3 messages.php4 /es5 messages.php
所有的语言文件都会返回一个键值对数组。例如:
1<?php2 3// lang/en/messages.php4 5return [6 'welcome' => 'Welcome to our application!',7];
对于因地区而异的语言,您应该按照 ISO 15897 标准命名语言目录。例如,英式英语应该使用“en_GB”而不是“en-gb”。
使用翻译字符串作为键
对于拥有大量可翻译字符串的应用程序,如果为每个字符串定义一个“短键”,在视图中引用这些键时会变得令人困惑,并且为应用程序支持的每个翻译字符串不断发明新键也很麻烦。
因此,Laravel 还支持使用字符串的“默认”翻译作为键来定义翻译字符串。使用翻译字符串作为键的语言文件作为 JSON 文件存储在 lang 目录中。例如,如果您的应用程序有西班牙语翻译,您应该创建一个 lang/es.json 文件。
1{2 "I love programming.": "Me encanta programar."3}
键 / 文件冲突
您不应定义与其它翻译文件名冲突的翻译字符串键。例如,在存在 nl/action.php 文件但不存在 nl.json 文件的情况下,为“NL”区域设置翻译 __('Action'),会导致翻译器返回 nl/action.php 的全部内容。
获取翻译字符串
您可以使用 __ 辅助函数从语言文件中获取翻译字符串。如果您使用“短键”来定义翻译字符串,则应使用“点”语法将包含该键的文件和键本身传递给 __ 函数。例如,让我们从 lang/en/messages.php 语言文件中获取 welcome 翻译字符串:
1echo __('messages.welcome');
如果指定的翻译字符串不存在,__ 函数将返回翻译字符串的键。因此,在上面的例子中,如果翻译字符串不存在,__ 函数将返回 messages.welcome。
如果您使用的是 默认翻译字符串作为翻译键,则应将字符串的默认翻译传递给 __ 函数:
1echo __('I love programming.');
同样,如果翻译字符串不存在,__ 函数将返回传递给它的翻译字符串键。
如果您使用的是 Blade 模板引擎,可以使用 {{ }} 回显语法来显示翻译字符串:
1{{ __('messages.welcome') }}
替换翻译字符串中的参数
如果您愿意,可以在翻译字符串中定义占位符。所有占位符都以 : 为前缀。例如,您可以定义一个带有名称占位符的欢迎消息:
1'welcome' => 'Welcome, :name',
要在获取翻译字符串时替换占位符,可以将替换数组作为第二个参数传递给 __ 函数:
1echo __('messages.welcome', ['name' => 'dayle']);
如果您的占位符包含所有大写字母,或者只有首字母大写,翻译后的值也将相应地大写:
1'welcome' => 'Welcome, :NAME', // Welcome, DAYLE2'goodbye' => 'Goodbye, :Name', // Goodbye, Dayle
对象替换格式化
如果您尝试提供一个对象作为翻译占位符,该对象的 __toString 方法将被调用。__toString 方法是 PHP 内置的“魔术方法”之一。然而,有时您可能无法控制特定类的 __toString 方法,例如当您交互的类属于第三方库时。
在这种情况下,Laravel 允许您为该特定类型的对象注册自定义格式化处理程序。要实现这一点,您应该调用翻译器的 stringable 方法。stringable 方法接受一个闭包,该闭包应指定它负责格式化的对象类型。通常,stringable 方法应该在应用程序 AppServiceProvider 类的 boot 方法中调用:
1use Illuminate\Support\Facades\Lang; 2use Money\Money; 3 4/** 5 * Bootstrap any application services. 6 */ 7public function boot(): void 8{ 9 Lang::stringable(function (Money $money) {10 return $money->formatTo('en_GB');11 });12}
复数化
复数化是一个复杂的问题,因为不同语言对于复数形式有各种复杂的规则;然而,Laravel 可以根据您定义的复数规则来帮助您以不同的方式翻译字符串。使用 | 字符,您可以区分字符串的单数和复数形式:
1'apples' => 'There is one apple|There are many apples',
当然,在使用 翻译字符串作为键 时,也支持复数化:
1{2 "There is one apple|There are many apples": "Hay una manzana|Hay muchas manzanas"3}
您甚至可以创建更复杂的复数化规则,为多个数值范围指定翻译字符串:
1'apples' => '{0} There are none|[1,19] There are some|[20,*] There are many',
在定义了带有复数化选项的翻译字符串后,您可以使用 trans_choice 函数获取给定“数量 (count)”对应的行。在此示例中,由于数量大于 1,因此返回翻译字符串的复数形式:
1echo trans_choice('messages.apples', 10);
您还可以在复数化字符串中定义占位符属性。这些占位符可以通过将数组作为第三个参数传递给 trans_choice 函数来替换:
1'minutes_ago' => '{1} :value minute ago|[2,*] :value minutes ago',2 3echo trans_choice('time.minutes_ago', 5, ['value' => 5]);
如果您想显示传递给 trans_choice 函数的整数值,可以使用内置的 :count 占位符:
1'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。在此文件中,您只需定义想要覆盖的翻译字符串。任何您未覆盖的翻译字符串仍将从扩展包的原始语言文件中加载。