Class yii\i18n\GettextMessageSource

继承yii\i18n\GettextMessageSource » yii\i18n\MessageSource » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/i18n/GettextMessageSource.php

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

Each GettextMessageSource 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 $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'.

公共属性

隐藏继承的属性

属性类型描述定义在
$basePath string yii\i18n\GettextMessageSource
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$catalog string yii\i18n\GettextMessageSource
$forceTranslation boolean Whether to force message translation when the source and target languages are the same. yii\i18n\MessageSource
$sourceLanguage string The language that the original messages are in. yii\i18n\MessageSource
$useBigEndian boolean yii\i18n\GettextMessageSource
$useMoFile boolean yii\i18n\GettextMessageSource

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的指定的方法. yii\base\Component
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() 构造函数. yii\base\BaseObject
__get() 返回组件属性的值. yii\base\Component
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\Component
__set() 设置组件属性的值. yii\base\Component
__unset() 将组件属性设置为null. yii\base\Component
attachBehavior() 将行为附加到此组件. yii\base\Component
attachBehaviors() 将行为列表附加到组件. yii\base\Component
behaviors() 返回此组件应该具有的行为列表. yii\base\Component
canGetProperty() 返回一个值, 指示属性是否可读取. yii\base\Component
canSetProperty() 返回一个值, 指示属性是否可设置. yii\base\Component
className() 返回此类的完全限定名称. yii\base\BaseObject
detachBehavior() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. yii\base\Component
getBehavior() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. yii\base\Component
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\Component
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\Component
init() 初始化对象. yii\base\BaseObject
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
translate() Translates a message to the specified language. yii\i18n\MessageSource
trigger() 触发事件. yii\base\Component

受保护的方法

隐藏继承的方法

方法描述定义在
getMessageFilePath() Returns message file path for the specified language and category. yii\i18n\GettextMessageSource
loadFallbackMessages() The method is normally called by loadMessages() to load the fallback messages for the language. yii\i18n\GettextMessageSource
loadMessages() Loads the message translation for the specified $language and $category. yii\i18n\GettextMessageSource
loadMessagesFromFile() Loads the message translation for the specified language and category or returns null if file doesn't exist. yii\i18n\GettextMessageSource
translateMessage() Translates the specified message. yii\i18n\MessageSource

事件

隐藏继承的事件

事件类型描述定义在
EVENT_MISSING_TRANSLATION yii\i18n\MissingTranslationEvent An event that is triggered when a message translation is not found. yii\i18n\MessageSource

常量

隐藏继承的常量

常量描述定义在
MO_FILE_EXT '.mo' yii\i18n\GettextMessageSource
PO_FILE_EXT '.po' yii\i18n\GettextMessageSource

属性详情

$basePath public 属性
public string $basePath '@app/messages'
$catalog public 属性
public string $catalog 'messages'
$useBigEndian public 属性
public boolean $useBigEndian false
$useMoFile public 属性
public boolean $useMoFile true

方法详情

getMessageFilePath() protected 方法

Returns message file path for the specified language and category.

protected string getMessageFilePath ( $language )
$language string

The target language

return string

Path to message file

loadFallbackMessages() protected 方法 (可用自版本: 2.0.7)

The method is normally called by loadMessages() to load the fallback messages for the language.

Method tries to load the $category messages for the $fallbackLanguage and adds them to the $messages array.

protected array loadFallbackMessages ( $category, $fallbackLanguage, $messages, $originalMessageFile )
$category string

The message category

$fallbackLanguage string

The target fallback language

$messages array

The array of previously loaded translation messages. The keys are original messages, and the values are the translated messages.

$originalMessageFile string

The path to the file with messages. Used to log an error message in case when no translations were found.

return array

The loaded messages. The keys are original messages, and the values are the translated messages.

loadMessages() protected 方法

Loads the message translation for the specified $language and $category.

If translation for specific locale code such as en-US isn't found it tries more generic en. When both are present, the en-US messages will be merged over en. See loadFallbackMessages() for details. If the $language is less specific than $sourceLanguage, the method will try to load the messages for $sourceLanguage. For example: $sourceLanguage is en-GB, $language is en. The method will load the messages for en and merge them over en-GB.

参见:

protected array loadMessages ( $category, $language )
$category string

The message category

$language string

The target language

return array

The loaded messages. The keys are original messages, and the values are translated messages.

loadMessagesFromFile() protected 方法

Loads the message translation for the specified language and category or returns null if file doesn't exist.

protected array|null loadMessagesFromFile ( $messageFile, $category )
$messageFile string

Path to message file

$category string

The message category

return array|null

Array of messages or null if file not found