tutorial-i18n.md 15.5 KB
Newer Older
1 2 3
Internationalization
====================

4
> Note: This section is under development.
Qiang Xue committed
5

6 7 8 9
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.

10 11
Locale and Language
-------------------
12

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

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

18 19 20 21 22 23 24 25 26 27 28
```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
29
return [
30 31 32
    'id' => 'applicationID',
    'basePath' => dirname(__DIR__),
    'language' => 'ru-RU' // ← here!
33 34 35 36 37
```

Later you can easily change it in runtime:

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

41 42 43 44
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
45 46
If there's no translation for `ru-RU` Yii will try `ru` as well before failing.

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

50 51 52 53
Message translation
-------------------

### Basics
54

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

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

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

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

In the above `app*` is a pattern that specifies which categories are handled by the message source. In this case we're
85
handling everything that begins with `app`. You can also specify default translation, for more info see [this example](i18n.md#examples).
86

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

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

Alexandr committed
102
Instead of configuring `fileMap` you can rely on convention which is `BasePath/messages/LanguageID/CategoryName.php`.
103

104
#### Named placeholders
105

106 107 108
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:

109 110
```php
$username = 'Alexander';
Alexander Makarov committed
111
echo \Yii::t('app', 'Hello, {username}!', [
112
    'username' => $username,
Alexander Makarov committed
113
]);
114 115
```

116 117
Note that the parameter assignment is without the brackets.

118
#### Positional placeholders
119 120 121 122 123 124

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

Alexander Makarov committed
125 126
> **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.
127

128 129
### Advanced placeholder formatting

130 131 132 133 134 135 136

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
137
a bit cryptic we have our own reference below.
138

139
#### Numbers
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161

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

162
#### Dates
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181

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

182
#### Time
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202

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


203
#### Spellout
204 205

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

209
#### Ordinal
210 211

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

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

217
#### Duration
218 219 220


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

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

226
#### Plurals
227 228 229 230 231 232

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
233
echo \Yii::t('app', 'There {n, plural, =0{are no cats} =1{is one cat} other{are # cats}}!', ['n' => 0]);
234 235 236 237 238 239 240 241 242 243 244 245 246 247
```

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

248 249 250 251 252 253 254
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
255
To learn which inflection forms you should specify for your language you can referrer to
256 257
[rules reference at unicode.org](http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html).

258
#### Selections
259 260 261 262 263

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
264
echo \Yii::t('app', '{name} is {gender} and {gender, select, female{she} male{he} other{it}} loves Yii!', [
265 266
    'name' => 'Snoopy',
    'gender' => 'dog',
Alexander Makarov committed
267
]);
268 269 270 271 272 273 274
```

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.

275
### Specifying default translation
276

Mark committed
277 278
You can specify default translation that will be used as a fallback for categories that don't match any other translation.
This translation should be marked with `*`. In order to do it add the following to the config file (for the `yii2-basic` application it will be `web.php`):
279 280 281 282 283

```php
//configure i18n component

'i18n' => [
284 285 286 287 288
    'translations' => [
        '*' => [
            'class' => 'yii\i18n\PhpMessageSource'
        ],
    ],
289 290 291
],
```

Mark committed
292 293
Now you can use categories without configuring each one that is similar to Yii 1.1 behavior.
Messages for the category will be loaded from a file under default translation `basePath` that is `@app/messages`:
Mark committed
294

295
```php
Mark committed
296
echo Yii::t('not_specified_category', 'message from unspecified category');
297 298
```

Mark committed
299
Message will be loaded from `@app/messages/<LanguageCode>/not_specified_category.php`.
300

301
### Translating module messages
Mark committed
302

Mark committed
303
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
304 305 306 307 308 309 310 311 312 313

```php
<?php

namespace app\modules\users;

use Yii;

class Module extends \yii\base\Module
{
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
    public $controllerNamespace = 'app\modules\users\controllers';

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

    public function registerTranslations()
    {
        Yii::$app->i18n->translations['modules/users/*'] = [
            '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);
    }
Mark committed
340 341 342 343

}
```

Mark committed
344
In the example above we are using wildcard for matching and then filtering each category per needed file. Instead of using `fileMap` you can simply
Mark committed
345
use convention of category mapping to the same named file and use `Module::t('validation', 'your custom validation message')` or `Module::t('form', 'some form label')` directly.
Mark committed
346

347
### Translating widgets messages
Mark committed
348 349 350 351 352 353 354 355 356 357 358 359 360 361

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
{

362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
    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);
    }
Mark committed
390 391 392 393

}
```

Mark committed
394
Instead of using `fileMap` you can simply use convention of category mapping to the same named file and use `Menu::t('messages', 'new messages {messages}', ['{messages}' => 10])` directly.
Mark committed
395

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

398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419

### Translating framework messages

Sometimes you want to correct default framework message translation for your application. In order to do so configure
`i18n` component like the following:

```php
'components' => [
    'i18n' => [
        'translations' => [
            'yii' => [
                'class' => 'yii\i18n\PhpMessageSource',
                'sourceLanguage' => 'en',
                'basePath' => '/path/to/my/message/files'
            ],
        ],
    ],
],
```

Now you can place your adjusted translations to `/path/to/my/message/files`.

420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
### Handling missing translations

If the translation is missing at the source, Yii displays the requested message content. Such behavior very convenient
in case your raw message is a valid verbose text. However, sometimes it is not enough.
You may need to perform some custom processing of the situation, when requested translation is missing at the source.
This can be achieved via 'missingTranslation' event of the [[yii\i18n\MessageSource]].

For example: lets mark all missing translations with something notable, so they can be easily found at the page.
First we need to setup event handler, this can be done via configuration:

```php
'components' => [
    // ...
    'i18n' => [
        'translations' => [
            'app*' => [
                'class' => 'yii\i18n\PhpMessageSource',
                'fileMap' => [
                    'app' => 'app.php',
                    'app/error' => 'error.php',
                ],
                'on missingTranslation' => ['TranslationEventHandler', 'handleMissingTranslation']
            ],
        ],
    ],
],
```

Now we need to implement own handler:

```php
use yii\i18n\MissingTranslationEvent;

class TranslationEventHandler
{
    public static function(MissingTranslationEvent $event) {
        $event->translatedMessage = "@MISSING: {$event->category}.{$event->message} FOR LANGUAGE {$event->language} @";
    }
}
```

If [[yii\i18n\MissingTranslationEvent::translatedMessage]] is set by event handler it will be displayed as translation result.

> Attention: each message source handles its missing translations separately. If you are using several message sources
  and wish them treat missing translation in the same way, you should assign corresponding event handler to each of them.

466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
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
put there file for russian language as follows `views/site/ru-RU/index.php`.

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

i18n formatter
--------------

i18n formatter component is the localized version of formatter that supports formatting of date, time and numbers based
on current locale. In order to use it you need to configure formatter application component as follows:

```php
return [
484 485 486 487 488 489
    // ...
    'components' => [
        'formatter' => [
            'class' => 'yii\i18n\Formatter',
        ],
    ],
490 491 492
];
```

493
After configuring the component can be accessed as `Yii::$app->formatter`.
494 495 496 497

Note that in order to use i18n formatter you need to install and enable
[intl](http://www.php.net/manual/en/intro.intl.php) PHP extension.

Alexandr committed
498
In order to learn about formatter methods refer to its API documentation: [[yii\i18n\Formatter]].