ThinkPHP3.2的多语言支持

Published on 2016 - 12 - 05

ThinkPHP内置多语言支持,如果你的应用涉及到国际化的支持,那么可以定义相关的语言包文件。任何字符串形式的输出,都可以定义语言常量。

要启用多语言功能,需要配置开启多语言行为,在应用的配置目录下面的行为定义文件tags.php中,添加:

return array(
    // 添加下面一行定义即可
    'app_begin' => array('Behavior\CheckLangBehavior'),
);

表示在app_begin标签位置执行多语言检测行为。

要开启语言包功能,需要开启

'LANG_SWITCH_ON' => true,   // 开启语言包功能

其他的配置参数包括:

'LANG_AUTO_DETECT' => true, // 自动侦测语言 开启多语言功能后有效
'LANG_LIST'        => 'zh-cn', // 允许切换的语言列表 用逗号分隔
'VAR_LANGUAGE'     => 'l', // 默认语言切换变量

可以为项目定义不同的语言文件,框架的系统语言包目录在系统框架的Lang目录下面,每个语言都对应一个语言包文件,系统默认只有简体中文语言包文件zh-cn.php和英文语言包en-us.php ,如果要增加繁体中文zh-tw或者其他语言支持,只要增加相应的语言定义文件。

语言包的使用由系统自动判断当前用户的浏览器支持语言来定位,如果找不到相关的语言包文件,会使用默认的语言。如果浏览器支持多种语言,那么取第一种支持语言。

ThinkPHP的多语言支持是指的是模板多语言支持,数据的多语言转换(翻译)不在这个范畴之内。ThinkPHP具备语言包定义、自动识别、动态定义语言参数的功能。并且可以自动识别用户浏览器的语言,从而选择相应的语言包(如果有定义)。例如:

throw_exception('新增用户失败!';

我们在语言包里面增加了ADD_USER_ERROR语言配置变量的话,在程序中的写法就要改为:

throw_exception(L('ADD_USER_ERROR');

也就是说,字符串信息要改成L方法和语言定义来表示。

应用语言包文件位于应用公共模块下的Lang目录,并且按照语言类别分子目录存放,在执行的时候系统会自动加载,无需手动加载。

具体的语言包文件命名和位置如下:

语言包 语言文件位置
应用语言包 应用公共目录/Lang/语言文件.php
模块语言包 模块目录/Lang/语言文件.php
控制器语言包 模块目录/Lang/语言目录/控制器名(小写).php

以当前模块为Home、当前语言为zh-cn为例,我们可以读取语言包的顺序如下(如果没有定义则不读取):

ThinkPHP/Lang/zh-cn.php 框架底层语言包
Application/Common/Lang/zh-cn.php 应用公共语言包
Application/Home/Lang/zh-cn.php Home模块语言包
Application/Home/Lang/zh-cn/user.php Home模块的User控制器语言包

语言子目录采用浏览器的语言命名(全部小写)定义,例如English (United States) 可以使用en-us作为目录名。如果项目比较小,整个项目只有一个语言包文件,那可以定义应用的公共语言文件即可,而无需按照模块分开定义。

语言文件定义

ThinkPHP语言文件定义采用返回数组方式:

return array(
     'lan_define'=>'欢迎使用ThinkPHP',
);

也可以在程序里面动态设置语言定义的值,使用下面的方式:

L('define2','语言定义');
$value = L('define2');

通常多语言的使用是在控制器里面,但是模型类的自动验证功能里面会用到提示信息,这个部分也可以使用多语言的特性。例如原来的方式是把提示信息直接写在模型里面定义:

array('title','require','标题必须!',1),

如果使用了多语言功能的话(假设,我们在当前语言包里面定义了' lang_var'=>'标题必须!'),就可以这样定义模型的自动验证

array('title','require','{%lang_var}',1),

如果要在模板中输出语言变量不需要在控制器中赋值,可以直接使用模板引擎特殊标签来直接输出语言定义的值:

{$Think.lang.lang_var}

可以输出当前选择的语言包里面定义的 lang_var语言定义。

变量传入支持

语言包定义的时候支持传入变量,例如:

'FILE_FORMAT'    =>    '文件格式: {$format},文件大小:{$size}',

在模板中输出语言字符串的时候传入变量值即可:

{:L('FILE_FORMAT',array('format' => 'jpeg,png,gif,jpg','maximum' => '2MB'))}

参考文档