yii2-bootstrap/docs/guide/i18n.md

Internationalization

Internationalization (I18N) refers to the process of designing a software application so that it can be adapted to various languages and regions without engineering changes. For Web applications, this is of particular importance because the potential users may be worldwide.

Locale and Language

There are two languages defined in Yii application: \yii\base\Application::$sourceLanguage and \yii\base\Application::$language.

Source language is the language original application messages are written in such as:

echo \Yii::t('app', 'I am a message!');

Tip: Default is English and it's not recommended to change it. The reason is that it's easier to find people translating from English to any language than from non-English to non-English.

Target language is what's currently used. It's defined in application configuration like the following:

// ...
return [
	'id' => 'applicationID',
	'basePath' => dirname(__DIR__),
	'language' => 'ru_RU' // ← here!

Later you can easily change it in runtime:

\Yii::$app->language = 'zh_CN';

Basic message translation

Yii basic message translation in its basic variant works without additional PHP extension. What it does is finding a translation of the message from source language into target language. Message itself is specified as the second \Yii::t method parameter:

echo \Yii::t('app', 'This is a string to translate!');

Yii tries to load approprite translation from one of the message sources defined via i18n component configuration:

'components' => [
	// ...
	'i18n' => [
		'translations' => [
			'app*' => [
				'class' => 'yii\i18n\PhpMessageSource',
				//'basePath' => '@app/messages',
				//'sourceLanguage' => 'en_US',
				'fileMap' => [
					'app' => 'app.php',
					'app/error' => 'error.php',
				],
			],
		],
	],
],

In the above app* is a pattern that specifies which categories are handled by the message source. In this case we're handling everything that begins with app.

class defines which message source is used. The following message sources are available:

• PhpMessageSource that uses PHP files.
• GettextMessageSource that uses GNU Gettext MO or PO files.
• DbMessageSource that uses database.

basePath defines where to store messages for the currently used message source. In this case it's messages directory in your application directory. In case of using database this option should be skipped.

sourceLanguage defines which language is used in \Yii::t second argument. If not specified, application's source language is used.

fileMap specifies how message categories specified in the first argument of \Yii::t() are mapped to files when PhpMessageSource is used. In the example we're defining two categories app and app/error.

Instead of configuring fileMap you can rely on convention which is messages/BasePath/LanguageID/CategoryName.php.

Named placeholders

You can add parameters to a translation message that will be substituted with the corresponding value after translation. The format for this is to use curly brackets around the parameter name as you can see in the following example:

$username = 'Alexander';
echo \Yii::t('app', 'Hello, {username}!', [
	'username' => $username,
]);

Note that the parameter assignment is without the brackets.

Positional placeholders

$sum = 42;
echo \Yii::t('app', 'Balance: {0}', $sum);

Tip: Try keep message strings meaningful and avoid using too many positional parameters. Remember that translator has source string only so it should be obvious about what will replace each placeholder.

Advanced placeholder formatting

In order to use advanced features you need to install and enable intl PHP extension. After installing and enabling it you will be able to use extended syntax for placeholders. Either short form {placeholderName, argumentType} that means default setting or full form {placeholderName, argumentType, argumentStyle} that allows you to specify formatting style.

Full reference is available at ICU website but since it's a bit cryptic we have our own reference below.

Numbers

$sum = 42;
echo \Yii::t('app', 'Balance: {0, number}', $sum);

You can specify one of the built-in styles (integer, currency, percent):

$sum = 42;
echo \Yii::t('app', 'Balance: {0, number, currency}', $sum);

Or specify custom pattern:

$sum = 42;
echo \Yii::t('app', 'Balance: {0, number, ,000,000000}', $sum);

Formatting reference.

Dates

echo \Yii::t('app', 'Today is {0, date}', time());

Built in formats (short, medium, long, full):

echo \Yii::t('app', 'Today is {0, date, short}', time());

Custom pattern:

echo \Yii::t('app', 'Today is {0, date, YYYY-MM-dd}', time());

Formatting reference.

Time

echo \Yii::t('app', 'It is {0, time}', time());

Built in formats (short, medium, long, full):

echo \Yii::t('app', 'It is {0, time, short}', time());

Custom pattern:

echo \Yii::t('app', 'It is {0, date, HH:mm}', time());

Formatting reference.

Spellout

echo \Yii::t('app', '{n,number} is spelled as {n, spellout}', ['n' => 42]);

Ordinal

echo \Yii::t('app', 'You are {n, ordinal} visitor here!', ['n' => 42]);

Will produce "You are 42nd visitor here!".

Duration

echo \Yii::t('app', 'You are here for {n, duration} already!', ['n' => 47]);

Will produce "You are here for 47 sec. already!".

Plurals

Different languages have different ways to inflect plurals. Some rules are very complex so it's very handy that this functionality is provided without the need to specify inflection rule. Instead it only requires your input of inflected word in certain situations.

echo \Yii::t('app', 'There {n, plural, =0{are no cats} =1{is one cat} other{are # cats}}!', ['n' => 0]);

Will give us "There are no cats!".

In the plural rule arguments above =0 means exactly zero, =1 stands for exactly one other is for any other number. # is replaced with the n argument value. It's not that simple for languages other than English. Here's an example for Russian:

Здесь {n, plural, =0{котов нет} =1{есть один кот} one{# кот} few{# кота} many{# котов} other{# кота}}!

In the above it worth mentioning that =1 matches exactly n = 1 while one matches 21 or 101.

Note that if you are using placeholder twice and one time it's used as plural another one should be used as number else you'll get "Inconsistent types declared for an argument: U_ARGUMENT_TYPE_MISMATCH" error:

Total {count, number} {count, plural, one{item} other{items}}.

To learn which inflection forms you should specify for your language you can referer to rules reference at unicode.org.

Selections

You can select phrases based on keywords. The pattern in this case specifies how to map keywords to phrases and provides a default phrase.

echo \Yii::t('app', '{name} is {gender} and {gender, select, female{she} male{he} other{it}} loves Yii!', [
	'name' => 'Snoopy',
	'gender' => 'dog',
]);

Will produce "Snoopy is dog and it loves Yii!".

In the expression female and male are possible values. other handler values that do not match. Strings inside brackets are sub-expressions so could be just a string or a string with more placeholders.

Formatters

In order to use formatters you need to install and enable intl PHP extension.