yii2-国际化-i18n组件的完全配置和使用
2016-10-27 本文已影响1407人
playwolf719
写文初衷
- i18n组件的主要作用就是用来转化网站的展示语言的，即网站国际化。鉴于yii2关于i18n组件的配置使用文档讲解不够细致，故整理官方文档和一些博客之后，写此博文。如有不妥，望多多指教。
ps：我的yii版本是2.0.8。
正文
配置i18n到web.php
- 在config/web.php中的config数组加入以下内容。（backend，frontend，common各个模块，可以自己设置自己的i18n.php和message/app.php映射文件）
- 其中，language为项目的全局语言设置，必须进行设置。
- basePath的@app/common/messages等同于，项目目录下common/messages文件夹（这个文件夹需要自行创建，当然大家可以设置自定义目录，代表映射目录）；
- sourceLanguage，即需要被转化的语言，这里选择英语为源语言；
- fileMap，即messages文件夹下的文件映射。
web.php部分内容
//全局语言设置
'language' => 'zh-CN',
'components' => [
// ...
'i18n' => [
'translations' => [
'app*' => [
'class' => 'yii\i18n\PhpMessageSource',
'basePath' => '@common/messages',
'sourceLanguage' => 'en-US',
'fileMap' => [
'app' => 'app.php',
'app/error' => 'error.php',
],
],
],
],
],
使用yii生成i18n插件配置
- 目前@app代表console目录，@backend代表backend目录。。。
- 在项目目录下，使用yii命令生成i18n插件配置文件。（事实上，该配置文件在使用之后，可以删除，因为，它的作用只是在生成映射文件时提供参数。）
./yii message/config @common/config/i18n.php
- 生成的文件为config/i18n.php，里面已经有很多默认参数。在修改参数sourcePath（需要被转化的文件夹路径，这里使用整个项目目录），messagePath（这个需要和web.php中的basePath一致），languages（转化目标语言）之后，内容如下。
i18n.php
return [
'color' => null,
'interactive' => true,
'sourcePath' => '@backend',
'messagePath' => '@common/messages',
'languages' => ['zh-CN'],
'translator' => 'Yii::t',
'sort' => false,
'overwrite' => true,
'removeUnused' => false,
'markUnused' => true,
'except' => [
'.svn',
'.git',
'.gitignore',
'.gitkeep',
'.hgignore',
'.hgkeep',
'/messages',
'/BaseYii.php',
],
'only' => [
'*.php',
],
'format' => 'php',
'db' => 'db',
'sourceMessageTable' => '{{%source_message}}',
'messageTable' => '{{%message}}',
'catalog' => 'messages',
'ignoreCategories' => [],
];
使用yii生成映射目录
./yii message/extract @app/config/i18n.php
- 使用以上命令，实际上就是按照i18n.php中给定的参数，执行扫描操作，将所有形如Yii::t('app', 'xxx')这样语句中的xxx取出，放入映射文件中。
这时，在common/messages中会有zh-CN文件夹生成，里面的app.php即为映射文件。
app.php
return [
'OpenId' => 'OpenId',
'UserId' => '用户id',
'UserName' => '用户名',
'UserPortrait' => '用户头像',
'About' => '关于我们',
'Are you sure you want to delete this item?' => '确定要删除？',
'Contact' => '联系方式',
'Create' => '创建',
'Create Myuser' => '创建用户',
'Delete' => '删除',
'Home' => '首页',
'Login' => '登录',
'My Company' => '我的网站',
'Myusers' => '用户',
'Reset' => '重置',
'Search' => '搜索',
'Update' => '更新',
'Update {modelClass}: ' => '更新用户-',
];
注意
Yii::t('app', 'Myusers');
- 注意，只有如上的写法才能使用该功能。换句话说，在使用yii的gii进行代码生成时，请enable i18n，方便网站国际化。
展示
- 中文版
中文版.jpg
- 英文版
英文版.jpg
