Class CGettextMessageSource

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

Each CGettextMessageSource instance represents the message translations 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 CGettextMessageSource::$useMoFile property value.

All translations are saved under the CGettextMessageSource::$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 CGettextMessageSource::$catalog property, which defaults to 'messages'.

CComponent

CApplicationComponent implements IApplicationComponent

CMessageSource

CGettextMessageSource

Package: system\i18n
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/i18n/CGettextMessageSource.php

Methods summary
`public`	# `init( )` Initializes the application component. This method overrides the parent implementation by preprocessing the user request data. Initializes the application component. This method overrides the parent implementation by preprocessing the user request data. Overrides `CApplicationComponent::init()`
`protected array`	# `loadMessages( string $category, string $language )` Loads the message translation for the specified language and category. Loads the message translation for the specified language and category. Parameters `$category` `string` $category the message category `$language` `string` $language the target language Returns `array` the loaded messages

Methods inherited from CMessageSource
`getLanguage(), onMissingTranslation(), setLanguage(), translate(), translateMessage()`

Methods inherited from CApplicationComponent
`getIsInitialized()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Constants summary
`string`	`CACHE_KEY_PREFIX`	`'Yii.CGettextMessageSource.'`	#
`string`	`MO_FILE_EXT`	`'.mo'`	#
`string`	`PO_FILE_EXT`	`'.po'`	#

Properties summary
`public integer`	`$cachingDuration`	`0`	# the time in seconds that the messages can remain valid in cache. Defaults to 0, meaning the caching is disabled. the time in seconds that the messages can remain valid in cache. Defaults to 0, meaning the caching is disabled.
`public string`	`$cacheID`	`'cache'`	# 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. 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.
`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"). the base path for all translated messages. Defaults to null, meaning the "messages" subdirectory of the application directory (e.g. "protected/messages").
`public boolean`	`$useMoFile`	`true`	# whether to load messages from MO files. Defaults to true. If false, messages will be loaded from PO files. whether to load messages from MO files. Defaults to true. If false, messages will be loaded from PO files.
`public boolean`	`$useBigEndian`	`false`	# whether to use Big Endian to read and write MO files. Defaults to false. This property is only used when `CGettextMessageSource::$useMoFile` is true. whether to use Big Endian to read and write MO files. Defaults to false. This property is only used when `CGettextMessageSource::$useMoFile` is true.
`public string`	`$catalog`	`'messages'`	# the message catalog name. This is the name of the message file (without extension) that stores the translated messages. Defaults to 'messages'. the message catalog name. This is the name of the message file (without extension) that stores the translated messages. Defaults to 'messages'.

Properties inherited from CMessageSource
`$forceTranslation`

Properties inherited from CApplicationComponent
`$behaviors`

Magic properties inherited from CMessageSource
`$language`

Magic properties inherited from CApplicationComponent
`$isInitialized`

Packages

Classes

Class CGettextMessageSource

Overrides

Parameters

Returns