本土化
- Introduction
- Defining Translation Strings
- Retrieving Translation Strings
- Overriding Package Language Files
介绍
默认情况下,Laravel 应用程序骨架不包含该lang
目录。如果您想自定义 Laravel 的语言文件,可以通过lang:publish
Artisan 命令发布它们。
Laravel 的本地化功能提供了一种检索各种语言字符串的便捷方法,使您可以轻松地在应用程序中支持多种语言。
Laravel 提供了两种管理翻译字符串的方法。第一种,语言字符串可以存储在应用程序lang
目录中的文件中。在此目录中,可以针对应用程序支持的每种语言创建子目录。Laravel 使用这种方法来管理内置 Laravel 功能(例如验证错误消息)的翻译字符串:
1/lang2 /en3 messages.php4 /es5 messages.php
或者,也可以将翻译字符串定义在目录中的 JSON 文件中lang
。采用这种方法时,应用程序支持的每种语言都会在此目录中有一个对应的 JSON 文件。对于包含大量可翻译字符串的应用程序,建议使用此方法:
1/lang2 en.json3 es.json
我们将在本文档中讨论管理翻译字符串的每种方法。
发布语言文件
默认情况下,Laravel 应用程序骨架不包含该lang
目录。如果您想自定义 Laravel 的语言文件或创建自己的语言文件,则应该lang
使用lang:publish
Artisan 命令搭建该目录。该lang:publish
命令将在您的应用程序中创建该lang
目录,并发布 Laravel 使用的默认语言文件集:
1php artisan lang:publish
配置区域设置
应用程序的默认语言存储在config/app.php
配置文件的locale
配置选项中,该选项通常使用环境变量设置APP_LOCALE
。您可以根据应用程序的需求随意修改此值。
您还可以配置“备用语言”,当默认语言不包含指定的翻译字符串时,将使用该语言。与默认语言一样,备用语言也在config/app.php
配置文件中配置,其值通常使用环境变量设置APP_FALLBACK_LOCALE
。
setLocale
您可以使用外观提供的方法在运行时修改单个 HTTP 请求的默认语言App
:
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});
确定当前区域设置
您可以使用外观上的currentLocale
和方法来确定当前语言环境或检查语言环境是否为给定值:isLocale
App
1use Illuminate\Support\Facades\App;2 3$locale = App::currentLocale();4 5if (App::isLocale('en')) {6 // ...7}
多元化语言
您可以指示 Laravel 的“复数器”(Eloquent 和框架的其他部分使用它来将单数字符串转换为复数字符串)使用英语以外的语言。这可以通过在应用程序的某个服务提供商的方法useLanguage
中调用该方法来实现boot
。复数器当前支持的语言包括: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 用来管理内置 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}
密钥/文件冲突
您不应定义与其他翻译文件名冲突的翻译字符串键。例如,__('Action')
如果某个nl/action.php
文件存在,而另一个nl.json
文件不存在,则翻译器会返回 的全部内容nl/action.php
。
检索翻译字符串
您可以使用辅助函数从语言文件中检索翻译字符串__
。如果您使用“短键”来定义翻译字符串,则应使用“点”语法将包含该键的文件及其本身传递给该__
函数。例如,让我们welcome
从语言文件中检索翻译字符串lang/en/messages.php
:
1echo __('messages.welcome');
如果指定的翻译字符串不存在,__
函数将返回翻译字符串的键。因此,使用上面的示例,如果翻译字符串不存在,__
函数将返回。messages.welcome
如果您使用默认翻译字符串作为翻译键,则应将字符串的默认翻译传递给函数__
;
1echo __('I love programming.');
同样,如果翻译字符串不存在,该__
函数将返回给定的翻译字符串键。
如果您使用的是Blade 模板引擎,则可以使用{{ }}
echo 语法来显示翻译字符串:
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
方法接受一个闭包,闭包应该类型Prompts它负责格式化的对象类型。通常,该stringable
方法应该在boot
应用程序AppServiceProvider
类的方法中调用:
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”的行。在此示例中,由于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}
目录中即可覆盖它们。
例如,如果您需要覆盖messages.php
名为 的软件包中的英语翻译字符串skyrim/hearthfire
,则应将语言文件放置在lang/vendor/hearthfire/en/messages.php
。在此文件中,您应该仅定义要覆盖的翻译字符串。任何未覆盖的翻译字符串仍将从软件包的原始语言文件中加载。