イントロダクション
Laravelの多言語機能は、さまざまな言語の文字列を取得する便利な方法を提供し、アプリケーション内で複数の言語を簡単にサポートできるようにしています。
Laravelは、翻訳文字列を管理する方法を２つ提供します。まず、言語文字列はresources/langディレクトリ内のファイルに保存できます。このディレクトリ内には、アプリケーションがサポートする言語ごとにサブディレクトリを用意する必要があります。これは、バリデーションエラーメッセージなどのLaravel組み込み機能の翻訳文字列を管理するために、Laravelが使用しているアプローチです。
/resources
/lang
/en
messages.php
/es
messages.phpまたは、翻訳文字列は、resources/langディレクトリ内に配置されたJSONファイル内で定義できます。このアプローチを採用する場合、アプリケーションがサポートする言語ごとに、このディレクトリ内に対応するJSONファイルを用意します。このアプローチは、翻訳可能な文字列が多数あるアプリケーションで推奨します。
/resources
/lang
en.json
es.jsonこのドキュメントでは、翻訳文字列を管理する各アプローチについて説明します。
ロケールの設定
アプリケーションのデフォルト言語は、config/app.php設定ファイルのlocale設定オプションに保存します。アプリケーションのニーズに合わせて、この値を自由に変更してください。
Appファサードが提供するsetLocaleメソッドを使用して、単一のHTTPリクエストの間のデフォルト言語を実行時に変更できます。
use Illuminate\Support\Facades\App;
Route::get('/greeting/{locale}', function ($locale) {
if (! in_array($locale, ['en', 'es', 'fr'])) {
abort(400);
}
App::setLocale($locale);
//
});「フォールバック言語」も設定できます。これは、アクティブな言語に対応する特定の翻訳文字列が含まれていない場合に使用されます。デフォルト言語と同様に、フォールバック言語もconfig/app.php設定ファイルで指定します。
'fallback_locale' => 'en',現在のロケールの決定
AppファサードのcurrentLocaleメソッドとisLocaleメソッドを使用して、現在のロケールを判定したり、ロケールが指定する値であるかどうかを確認したりできます。
use Illuminate\Support\Facades\App;
$locale = App::currentLocale();
if (App::isLocale('en')) {
//
}翻訳文字列の定義
短縮キーの使用
通常、翻訳文字列はresources/langディレクトリ内のファイルに保存します。このディレクトリ内には、アプリケーションがサポートする各言語のサブディレクトリが必要です。これは、バリデーションエラーメッセージなどのLaravel組み込み機能の翻訳文字列を管理するためにLaravelが使用しているアプローチです。
/resources
/lang
/en
messages.php
/es
messages.phpすべての言語ファイルは、キー付き文字列の配列を返します。例えば:
<?php
// resources/lang/en/messages.php
return [
'welcome' => 'Welcome to our application!',
];Note: 地域によって異なる言語の場合、ISO15897に従って言語ディレクトリに名前を付ける必要があります。たとえば、「en-gb」ではなく「en_GB」をイギリス英語に使用する必要があります。
翻訳文字列をキーとして使用
翻訳可能な文字列が多数あるアプリケーションの場合、「短縮キー」ですべての文字列を定義すると、ビューでキーを参照するときに混乱する可能性があり、アプリケーションがサポートするすべての翻訳文字列のキーを継続的に作成するのは面倒です。
このため、Laravelは、文字列の「デフォルト」の翻訳をキーとして使用して、翻訳文字列を定義するためのサポートも提供します。翻訳文字列をキーとして使用する翻訳ファイルは、JSONファイルとしてresources/langディレクトリに保存されます。たとえば、アプリケーションにスペイン語の翻訳がある場合は、resources/lang/es.jsonファイルを作成する必要があります。
{
"I love programming.": "Me encanta programar."
}キー／ファイルの競合
他の翻訳ファイル名と競合する翻訳文字列キーを定義しないでください。たとえば、nl/action.phpファイルは存在するがnl.jsonファイルは存在しないときに"NL"ロケールの__('Action')を翻訳すると、トランスレータはnl/action.phpの内容を返します。
翻訳文字列の取得
__ヘルパ関数を使用して、言語ファイルから翻訳文字列を取得できます。「短縮キー」を使用して翻訳文字列を定義している場合は、キーとキー自体を含むファイルを「ドット」構文を使用して__関数に渡す必要があります。たとえば、resources/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複数形
別々の言語には複数形のさまざまな複雑なルールがあるため、複数形化は複雑な問題です。ただし、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関数を使用して、指定する「個数」に合った行を取得できます。以下の例では、個数が１より大きいため、複数形の翻訳文字列が返されます。
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',パッケージ言語ファイルのオーバーライド
一部のパッケージには、独自の言語ファイルが付属している場合があります。パッケージのコアファイルを変更してこれらの行を調整する代わりに、ファイルをresources/lang/vendor/{package}/{locale}ディレクトリに配置することでそれらをオーバーライドできます。
したがって、たとえば、skyrim/hearthfireという名前のパッケージのmessages.phpの英語の翻訳文字列をオーバーライドする必要がある場合は、resources/lang/vendor/hearthfire/en/messages.phpに言語ファイルを配置する必要があります。このファイル内では、オーバーライドする翻訳文字列のみを定義する必要があります。オーバーライドしない翻訳文字列は、パッケージの元の言語ファイルから引き続き読み込まれます。