Home » Documentation » Class Reference » CGettextMessageSource

CGettextMessageSource

All Packages | Properties | Methods | Events

Package	system.i18n
Inheritance	class CGettextMessageSource » CMessageSource » CApplicationComponent » CComponent
Implements	IApplicationComponent
Since	1.0
Version	$Id: CGettextMessageSource.php 1678 2010-01-07 21:02:00Z qiang.xue $

CGettextMessageSource represents a message source that is based on GNU Gettext.

Each CGettextMessageSource instance represents the message tranlations for a single domain. And each message category represents a message context in Gettext. Translated messages are stored as either a MO or PO file, depending on the useMoFile property value.

All translations are saved under the basePath directory. Translations in one language are kept as MO or PO files under an individual subdirectory whose name is the language ID. The file name is specified via catalog property, which defaults to 'messages'.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
basePath	string	the base path for all translated messages.	CGettextMessageSource
behaviors	array	the behaviors that should be attached to this component.	CApplicationComponent
cacheID	string	the ID of the cache application component that is used to cache the messages.	CGettextMessageSource
cachingDuration	integer	the time in seconds that the messages can remain valid in cache.	CGettextMessageSource
catalog	string	the message catalog name.	CGettextMessageSource
isInitialized	boolean	whether this application component has been initialized (i.	CApplicationComponent
language	string	the language that the source messages are written in.	CMessageSource
useBigEndian	boolean	whether to use Big Endian to read and write MO files.	CGettextMessageSource
useMoFile	boolean	whether to load messages from MO files.	CGettextMessageSource

Public Methods

Hide inherited methods

Method	Description	Defined By
__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
evaluateExpression()	Evaluates a PHP expression or callback under the context of 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.	CGettextMessageSource
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

Protected Methods

Hide inherited methods

Method	Description	Defined By
loadMessages()	Loads the message translation for the specified language and category.	CGettextMessageSource
translateMessage()	Translates the specified message.	CMessageSource

Events

Hide inherited events

Event	Description	Defined By
onMissingTranslation	Raised when a message cannot be translated.	CMessageSource

Property Details

basePath property

public string $basePath;

the base path for all translated messages. Defaults to null, meaning the "messages" subdirectory of the application directory (e.g. "protected/messages").

cacheID property (available since v1.0.10)

public string $cacheID;

the ID of the cache application component that is used to cache the messages. Defaults to 'cache' which refers to the primary cache application component. Set this property to false if you want to disable caching the messages.

cachingDuration property

public integer $cachingDuration;

the time in seconds that the messages can remain valid in cache. Defaults to 0, meaning the caching is disabled.

catalog property

public string $catalog;

the message catalog name. This is the name of the message file (without extension) that stores the translated messages. Defaults to 'messages'.

useBigEndian property

public boolean $useBigEndian;

whether to use Big Endian to read and write MO files. Defaults to false. This property is only used when useMoFile is true.

useMoFile property

public boolean $useMoFile;

whether to load messages from MO files. Defaults to true. If false, messages will be loaded from PO files.

Method Details

init() method

public void init()

Initializes the application component. This method overrides the parent implementation by preprocessing the user request data.

loadMessages() method

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.