system system.base system.caching system.caching.dependencies system.collections system.console system.db system.db.ar system.db.schema system.db.schema.mssql system.db.schema.mysql system.db.schema.oci system.db.schema.pgsql system.db.schema.sqlite system.i18n system.i18n.gettext system.logging system.utils system.validators system.web system.web.actions system.web.auth system.web.filters system.web.helpers system.web.renderers system.web.services system.web.widgets system.web.widgets.captcha system.web.widgets.pagers

CMessageSource

system.i18n
继承 abstract class CMessageSource » CApplicationComponent » CComponent
实现 IApplicationComponent
子类 CDbMessageSource, CGettextMessageSource, CPhpMessageSource
可用自 1.0
版本 $Id$
CMessageSource is the base class for message translation repository classes.

A message source is an application component that provides message internationalization (i18n). It stores messages translated in different languages and provides these translated versions when requested.

A concrete class must implement loadMessages or override translateMessage.

公共属性

隐藏继承的属性

属性类型描述被定义在
behaviors array the behaviors that should be attached to this component. CApplicationComponent
isInitialized boolean whether this application component has been initialized (i. CApplicationComponent
language string the language that the source messages are written in. CMessageSource

公共方法

隐藏继承的方法

方法描述被定义在
__call() Calls the named method which is not a class method. CComponent
__get() Returns a property value, an event handler list or a behavior based on its name. CComponent
__isset() Checks if a property value is null. CComponent
__set() Sets value of a component property. CComponent
__unset() Sets a component property to be null. CComponent
asa() Returns the named behavior object. CComponent
attachBehavior() Attaches a behavior to this component. CComponent
attachBehaviors() Attaches a list of behaviors to the component. CComponent
attachEventHandler() Attaches an event handler to an event. CComponent
canGetProperty() Determines whether a property can be read. CComponent
canSetProperty() Determines whether a property can be set. CComponent
detachBehavior() Detaches a behavior from the component. CComponent
detachBehaviors() Detaches all behaviors from the component. CComponent
detachEventHandler() Detaches an existing event handler. CComponent
disableBehavior() Disables an attached behavior. CComponent
disableBehaviors() Disables all behaviors attached to this component. CComponent
enableBehavior() Enables an attached behavior. CComponent
enableBehaviors() Enables all behaviors attached to this component. CComponent
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
getIsInitialized() CApplicationComponent
getLanguage() CMessageSource
hasEvent() Determines whether an event is defined. CComponent
hasEventHandler() Checks whether the named event has attached handlers. CComponent
hasProperty() Determines whether a property is defined. CComponent
init() Initializes the application component. CApplicationComponent
onMissingTranslation() Raised when a message cannot be translated. CMessageSource
raiseEvent() Raises an event. CComponent
setLanguage() CMessageSource
translate() Translates a message to the specified language. CMessageSource

受保护的方法

隐藏继承的方法

方法描述被定义在
loadMessages() Loads the message translation for the specified language and category. CMessageSource
translateMessage() Translates the specified message. CMessageSource

事件

隐藏继承的事件

事件描述被定义在
onMissingTranslation Raised when a message cannot be translated. CMessageSource

属性详情

language 属性
public string getLanguage()
public void setLanguage(string $language)

the language that the source messages are written in. Defaults to application language.

方法详情

getLanguage() 方法
public string getLanguage()
{return} string the language that the source messages are written in. Defaults to application language.

loadMessages() 方法
abstract protected array loadMessages(string $category, string $language)
$category string the message category
$language string the target language
{return} array the loaded messages

Loads the message translation for the specified language and category.

onMissingTranslation() 方法
public void onMissingTranslation(CMissingTranslationEvent $event)
$event CMissingTranslationEvent the event parameter

Raised when a message cannot be translated. Handlers may log this message or do some default handling. The CMissingTranslationEvent::message property will be returned by translateMessage.

setLanguage() 方法
public void setLanguage(string $language)
$language string the language that the source messages are written in.

translate() 方法
public string translate(string $category, string $message, string $language=NULL)
$category string the message category
$message string the message to be translated
$language string the target language. If null (default), the application language will be used. This parameter has been available since version 1.0.3.
{return} string the translated message (or the original message if translation is not needed)

Translates a message to the specified language.

Note, if the specified language is the same as the source message language, messages will NOT be translated.

If the message is not found in the translations, an onMissingTranslation event will be raised. Handlers can mark this message or do some default handling. The CMissingTranslationEvent::message property of the event parameter will be returned.

translateMessage() 方法
protected string translateMessage(string $category, string $message, string $language)
$category string the category that the message belongs to
$message string the message to be translated
$language string the target language
{return} string the translated message

Translates the specified message. If the message is not found, an onMissingTranslation event will be raised.