| 包 | system.i18n |
|---|---|
| 继承 | abstract class CMessageSource » CApplicationComponent » CComponent |
| 实现 | IApplicationComponent |
| 子类 | CDbMessageSource, CGettextMessageSource, CPhpMessageSource |
| 源自 | 1.0 |
| 版本 | $Id: CMessageSource.php 3515 2011-12-28 12:29:24Z mdomba $ |
| 源码 |
CMessageSource是消息翻译类的基类。
信息源是提供信息国际化（i18n）的应用程序组件。 它存储不同的翻译信息结果， 当请求时提供这些翻译信息。
具体类必需实现loadMessages或重写translateMessage。
信息源是提供信息国际化（i18n）的应用程序组件。 它存储不同的翻译信息结果， 当请求时提供这些翻译信息。
具体类必需实现loadMessages或重写translateMessage。
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| behaviors | array | 这个应用组件附加的行为。 这此行为将在应用组件调用init时附加在应用组件上。 请参照CModel::behaviors如何指定此属性值。 | CApplicationComponent |
| forceTranslation | boolean | 当源语言和目标语言相同时，是否强制翻译信息。 默认为false，意思是源语言和目标语言不同时执行。 | CMessageSource |
| isInitialized | boolean | 检查应用组件是否已经初始化。 | CApplicationComponent |
| language | string | 返回源信息的书写语言。 默认为application language。 | CMessageSource |
公共方法
受保护方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| loadMessages() | 加载指定语言和类型的信息翻译。 | CMessageSource |
| translateMessage() | 翻译指定信息。 | CMessageSource |
事件
| 事件 | 描述 | 定义在 |
|---|---|---|
| onMissingTranslation | 当信息不能被翻译时发起。 | CMessageSource |
属性详细
forceTranslation
属性
（可用自 v1.1.4）
public boolean $forceTranslation;
当源语言和目标语言相同时，是否强制翻译信息。 默认为false，意思是源语言和目标语言不同时执行。
language
属性
返回源信息的书写语言。 默认为application language。
方法详细
getLanguage()
方法
|
public string getLanguage()
| ||
| {return} | string | 返回源信息的书写语言。 默认为application language。 |
public function getLanguage()
{
return $this->_language===null ? Yii::app()->sourceLanguage : $this->_language;
}
loadMessages()
方法
|
abstract protected array loadMessages(string $category, string $language)
| ||
| $category | string | 信息类别 |
| $language | string | 目录语言 |
| {return} | array | 返回加载信息 |
abstract protected function loadMessages($category,$language);
加载指定语言和类型的信息翻译。
onMissingTranslation()
方法
|
public void onMissingTranslation(CMissingTranslationEvent $event)
| ||
| $event | CMissingTranslationEvent | the event parameter |
public function onMissingTranslation($event)
{
$this->raiseEvent('onMissingTranslation',$event);
}
当信息不能被翻译时发起。 处理对象将保存信息到日志， 或者做一些默认处理。 将由translateMessage返回CMissingTranslationEvent::message属性。
setLanguage()
方法
|
public void setLanguage(string $language)
| ||
| $language | string | 设置源信息的书写语言。 |
public function setLanguage($language)
{
$this->_language=CLocale::getCanonicalID($language);
}
translate()
方法
|
public string translate(string $category, string $message, string $language=NULL)
| ||
| $category | string | 信息类别 |
| $message | string | 要翻译的信息 |
| $language | string | 目标语言。如果为null（默认），则调用application language。 |
| {return} | string | 返回已经翻译的信息（如果不需要翻译则返回原始信息） |
public function translate($category,$message,$language=null)
{
if($language===null)
$language=Yii::app()->getLanguage();
if($this->forceTranslation || $language!==$this->getLanguage())
return $this->translateMessage($category,$message,$language);
else
return $message;
}
翻译信息到指定语言。
注意：
如果指定语言与source message language相同时则不翻译信息。
如果没有找到对应的翻译信息，
则调用onMissingTranslation事件。
处理对象可以记录这些信息或做一些默认处理，
然后返回CMissingTranslationEvent::message这个事件参数。
translateMessage()
方法
|
protected string translateMessage(string $category, string $message, string $language)
| ||
| $category | string | 信息所属的类别 |
| $message | string | 要翻译的消息 |
| $language | string | 目标语言 |
| {return} | string | 返回已经翻译的信息 |
protected function translateMessage($category,$message,$language)
{
$key=$language.'.'.$category;
if(!isset($this->_messages[$key]))
$this->_messages[$key]=$this->loadMessages($category,$language);
if(isset($this->_messages[$key][$message]) && $this->_messages[$key][$message]!=='')
return $this->_messages[$key][$message];
else if($this->hasEventHandler('onMissingTranslation'))
{
$event=new CMissingTranslationEvent($this,$category,$message,$language);
$this->onMissingTranslation($event);
return $event->message;
}
else
return $message;
}
翻译指定信息。 如果翻译信息没有被找到， 则发起onMissingTranslation事件。