i18n.md 11 KB
Newer Older
1 2 3 4 5 6 7
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.

8 9
Locale and Language
-------------------
10

11 12
There are two languages defined in Yii application: [[\yii\base\Application::$sourceLanguage|source language]] and
[[\yii\base\Application::$language|target language]].
13

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

16 17 18 19 20 21 22 23 24 25 26
```php
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:

```php
// ...
Alexander Makarov committed
27
return [
28 29
	'id' => 'applicationID',
	'basePath' => dirname(__DIR__),
ff committed
30
	'language' => 'ru-RU' // ← here!
31 32 33 34 35
```

Later you can easily change it in runtime:

```php
ff committed
36
\Yii::$app->language = 'zh-CN';
37 38
```

39 40 41 42
Format is `ll-CC` where `ll` is  two- or three-letter lowercase code for a language according to
[ISO-639](http://www.loc.gov/standards/iso639-2/) and `CC` is country code according to
[ISO-3166](http://www.iso.org/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html).

Alexander Makarov committed
43 44
If there's no translation for `ru-RU` Yii will try `ru` as well before failing.

45 46
> **Note**: you can further customize details specifying language
> [as documented in ICU project](http://userguide.icu-project.org/locale#TOC-The-Locale-Concept).
47

48 49 50
Basic message translation
-------------------------

51
Yii basic message translation in its basic variant works without additional PHP extension. What it does is finding a
Alexander Makarov committed
52
translation of the message from source language into target language. Message itself is specified as the second
53
`\Yii::t` method parameter:
Alexander Makarov committed
54 55 56 57

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

Qiang Xue committed
59
Yii tries to load appropriate translation from one of the message sources defined via `i18n` component configuration:
60

61
```php
Alexander Makarov committed
62
'components' => [
63
	// ...
Alexander Makarov committed
64 65 66
	'i18n' => [
		'translations' => [
			'app*' => [
67 68
				'class' => 'yii\i18n\PhpMessageSource',
				//'basePath' => '@app/messages',
Alexander Makarov committed
69
				//'sourceLanguage' => 'en',
Alexander Makarov committed
70
				'fileMap' => [
71 72
					'app' => 'app.php',
					'app/error' => 'error.php',
Alexander Makarov committed
73 74 75 76 77
				],
			],
		],
	],
],
78 79 80 81 82
```

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`.

Alexander Makarov committed
83
`class` defines which message source is used. The following message sources are available:
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98

- 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`.
99 100 101

### Named placeholders

102 103 104
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:

105 106
```php
$username = 'Alexander';
Alexander Makarov committed
107
echo \Yii::t('app', 'Hello, {username}!', [
108
	'username' => $username,
Alexander Makarov committed
109
]);
110 111
```

112 113
Note that the parameter assignment is without the brackets.

114 115 116 117 118 119 120
### Positional placeholders

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

Alexander Makarov committed
121 122
> **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.
123 124 125 126 127 128 129 130 131 132

Advanced placeholder formatting
-------------------------------

In order to use advanced features you need to install and enable [intl](http://www.php.net/manual/en/intro.intl.php) 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](http://icu-project.org/apiref/icu4c/classMessageFormat.html) but since it's
Alexander Mohorev committed
133
a bit cryptic we have our own reference below.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201

### Numbers

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

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

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

Or specify custom pattern:

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

[Formatting reference](http://icu-project.org/apiref/icu4c/classicu_1_1DecimalFormat.html).

### Dates

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

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

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

Custom pattern:

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

[Formatting reference](http://icu-project.org/apiref/icu4c/classicu_1_1SimpleDateFormat.html).

### Time

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

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

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

Custom pattern:

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

[Formatting reference](http://icu-project.org/apiref/icu4c/classicu_1_1SimpleDateFormat.html).


### Spellout

```php
Alexander Makarov committed
202
echo \Yii::t('app', '{n,number} is spelled as {n, spellout}', ['n' => 42]);
203 204 205 206 207
```

### Ordinal

```php
Alexander Makarov committed
208
echo \Yii::t('app', 'You are {n, ordinal} visitor here!', ['n' => 42]);
209 210 211 212 213 214 215 216
```

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

### Duration


```php
Alexander Makarov committed
217
echo \Yii::t('app', 'You are here for {n, duration} already!', ['n' => 47]);
218 219 220 221 222 223 224 225 226 227 228
```

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.

```php
Alexander Makarov committed
229
echo \Yii::t('app', 'There {n, plural, =0{are no cats} =1{is one cat} other{are # cats}}!', ['n' => 0]);
230 231 232 233 234 235 236 237 238 239 240 241 242 243
```

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`.

244 245 246 247 248 249 250
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}}.
```

Qiang Xue committed
251
To learn which inflection forms you should specify for your language you can referrer to
252 253 254 255 256 257 258 259
[rules reference at unicode.org](http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html).

### 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.

```php
Alexander Makarov committed
260
echo \Yii::t('app', '{name} is {gender} and {gender, select, female{she} male{he} other{it}} loves Yii!', [
261 262
	'name' => 'Snoopy',
	'gender' => 'dog',
Alexander Makarov committed
263
]);
264 265 266 267 268 269 270
```

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.

Mark committed
271 272 273 274 275
Views
-----

You can use i18n in your views to provide support for different languages. For example, if you have view `views/site/index.php` and
you want to create special case for russian language, you create `ru-RU` folder under the view path of current controller/widget and
Mark committed
276
put there file for russian language as follows `views/site/ru-RU/index.php`.
Mark committed
277

Alexander Makarov committed
278 279
> **Note**: If language is specified as `en-US` and there are no corresponding views, Yii will try views under `en`
> before using original ones.
Mark committed
280

281 282
Formatters
----------
283

284 285
In order to use formatters you need to install and enable [intl](http://www.php.net/manual/en/intro.intl.php) PHP
extension.
286

Mark committed
287 288 289 290 291
Examples
--------

###Translating module messages

Mark committed
292
If you want to translate messages for a module and avoid using a single translation file for all messages, you can make it like the following:
Mark committed
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312

```php
<?php

namespace app\modules\users;

use Yii;

class Module extends \yii\base\Module
{
	public $controllerNamespace = 'app\modules\users\controllers';

	public function init()
	{
		parent::init();
		$this->registerTranslations();
	}

	public function registerTranslations()
	{
Mark committed
313
		Yii::$app->i18n->translations['modules/users/*'] = [
Mark committed
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
			'class' => 'yii\i18n\PhpMessageSource',
			'sourceLanguage' => 'en',
			'basePath' => '@app/modules/users/messages',
			'fileMap' => [
				'modules/users/validation' => 'validation.php',
				'modules/users/form' => 'form.php',
				...
			],
		];
	}

	public static function t($category, $message, $params = [], $language = null)
	{
		return Yii::t('modules/users/' . $category, $message, $params, $language);
	}

}
```

In the example above we are using wildcard for matching and then filtering each category per needed file.

###Translating widgets messages

Same rules can be applied for widgets too, for example:

```php
<?php

namespace app\widgets\menu;

use yii\base\Widget;
use Yii;

class Menu extends Widget
{

	public function init()
	{
		parent::init();
		$this->registerTranslations();
	}

	public function registerTranslations()
	{
		$i18n = Yii::$app->i18n;
		$i18n->translations['widgets/menu/*'] = [
			'class' => 'yii\i18n\PhpMessageSource',
			'sourceLanguage' => 'en',
			'basePath' => '@app/widgets/menu/messages',
			'fileMap' => [
				'widgets/menu/messages' => 'messages.php',
			],
		];
	}

	public function run()
	{
		echo $this->render('index');
	}

	public static function t($category, $message, $params = [], $language = null)
	{
		return Yii::t('widgets/menu/' . $category, $message, $params, $language);
	}

}
```

> **Note**: For widgets you also can use i18n views, same rules as for controllers are applied to them too.

Qiang Xue committed
384
TBD: provided classes overview.