CPhpMessageSource
| 包 | system.i18n |
|---|---|
| 继承 | class CPhpMessageSource » CMessageSource » CApplicationComponent » CComponent |
| 实现 | IApplicationComponent |
| 可用自 | 1.0 |
| 源码 | framework/i18n/CPhpMessageSource.php |
CPhpMessageSource represents a message source that stores translated messages in PHP scripts.
CPhpMessageSource uses PHP files and arrays to keep message translations.
Messages for an extension class (e.g. a widget, a module) can be specially managed and used. In particular, if a message belongs to an extension whose class name is Xyz, then the message category can be specified in the format of 'Xyz.categoryName'. And the corresponding message file is assumed to be 'BasePath/messages/LanguageID/categoryName.php', where 'BasePath' refers to the directory that contains the extension class file. When using Yii::t() to translate an extension message, the category name should be set as 'Xyz.categoryName'.
CPhpMessageSource uses PHP files and arrays to keep message translations.
- All translations are saved under the basePath directory.
- Translations in one language are kept as PHP files under an individual subdirectory whose name is the same as the language ID. Each PHP file contains messages belonging to the same category, and the file name is the same as the category name.
- Within a PHP file, an array of (source, translation) pairs is returned.
For example:
return array( 'original message 1' => 'translated message 1', 'original message 2' => 'translated message 2', );
Messages for an extension class (e.g. a widget, a module) can be specially managed and used. In particular, if a message belongs to an extension whose class name is Xyz, then the message category can be specified in the format of 'Xyz.categoryName'. And the corresponding message file is assumed to be 'BasePath/messages/LanguageID/categoryName.php', where 'BasePath' refers to the directory that contains the extension class file. When using Yii::t() to translate an extension message, the category name should be set as 'Xyz.categoryName'.
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| basePath | string | the base path for all translated messages. | CPhpMessageSource |
| 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. | CPhpMessageSource |
| cachingDuration | integer | the time in seconds that the messages can remain valid in cache. | CPhpMessageSource |
| extensionPaths | array | the message paths for extensions that do not have a base class to use as category prefix. | CPhpMessageSource |
| forceTranslation | boolean | whether to force message translation when the source and target languages are the same. | CMessageSource |
| isInitialized | boolean | Checks if this application component has been initialized. | 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 |
| 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() | Checks if this application component has been initialized. | CApplicationComponent |
| getLanguage() | Returns the language that the source messages are written in. Defaults to application language. | 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. | CPhpMessageSource |
| onMissingTranslation() | Raised when a message cannot be translated. | CMessageSource |
| raiseEvent() | Raises an event. | CComponent |
| setLanguage() | Sets the language that the source messages are written in. | CMessageSource |
| translate() | Translates a message to the specified language. | CMessageSource |
受保护的方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| getMessageFile() | Determines the message file name based on the given category and language. | CPhpMessageSource |
| loadMessages() | Loads the message translation for the specified language and category. | CPhpMessageSource |
| translateMessage() | Translates the specified message. | CMessageSource |
属性详情
basePath
属性
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
属性
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
属性
public integer $cachingDuration;
the time in seconds that the messages can remain valid in cache. Defaults to 0, meaning the caching is disabled.
extensionPaths
属性
（自版本 v1.1.13 可用）
public array $extensionPaths;
the message paths for extensions that do not have a base class to use as category prefix. The format of the array should be:
array(
'ExtensionName' => 'ext.ExtensionName.messages',
)
Where the key is the name of the extension and the value is the alias to the path
of the "messages" subdirectory of the extension.
When using Yii::t() to translate an extension message, the category name should be
set as 'ExtensionName.categoryName'.
Defaults to an empty array, meaning no extensions registered.
方法详情
getMessageFile()
方法
|
protected string getMessageFile(string $category, string $language)
| ||
| $category | string | category name |
| $language | string | language ID |
| {return} | string | the message file path |
源码： framework/i18n/CPhpMessageSource.php#104 (显示)
protected function getMessageFile($category,$language)
{
if(!isset($this->_files[$category][$language]))
{
if(($pos=strpos($category,'.'))!==false)
{
$extensionClass=substr($category,0,$pos);
$extensionCategory=substr($category,$pos+1);
// First check if there's an extension registered for this class.
if(isset($this->extensionPaths[$extensionClass]))
$this->_files[$category][$language]=Yii::getPathOfAlias($this->extensionPaths[$extensionClass]).DIRECTORY_SEPARATOR.$language.DIRECTORY_SEPARATOR.$extensionCategory.'.php';
else
{
// No extension registered, need to find it.
$class=new ReflectionClass($extensionClass);
$this->_files[$category][$language]=dirname($class->getFileName()).DIRECTORY_SEPARATOR.'messages'.DIRECTORY_SEPARATOR.$language.DIRECTORY_SEPARATOR.$extensionCategory.'.php';
}
}
else
$this->_files[$category][$language]=$this->basePath.DIRECTORY_SEPARATOR.$language.DIRECTORY_SEPARATOR.$category.'.php';
}
return $this->_files[$category][$language];
}
Determines the message file name based on the given category and language. If the category name contains a dot, it will be split into the module class name and the category name. In this case, the message file will be assumed to be located within the 'messages' subdirectory of the directory containing the module class file. Otherwise, the message file is assumed to be under the basePath.
init()
方法
|
public void init()
|
源码： framework/i18n/CPhpMessageSource.php#87 (显示)
public function init()
{
parent::init();
if($this->basePath===null)
$this->basePath=Yii::getPathOfAlias('application.messages');
}
Initializes the application component. This method overrides the parent implementation by preprocessing the user request data.
loadMessages()
方法
|
protected array loadMessages(string $category, string $language)
| ||
| $category | string | the message category |
| $language | string | the target language |
| {return} | array | the loaded messages |
源码： framework/i18n/CPhpMessageSource.php#134 (显示)
protected function loadMessages($category,$language)
{
$messageFile=$this->getMessageFile($category,$language);
if($this->cachingDuration>0 && $this->cacheID!==false && ($cache=Yii::app()->getComponent($this->cacheID))!==null)
{
$key=self::CACHE_KEY_PREFIX . $messageFile;
if(($data=$cache->get($key))!==false)
return unserialize($data);
}
if(is_file($messageFile))
{
$messages=include($messageFile);
if(!is_array($messages))
$messages=array();
if(isset($cache))
{
$dependency=new CFileCacheDependency($messageFile);
$cache->set($key,serialize($messages),$this->cachingDuration,$dependency);
}
return $messages;
}
else
return array();
}
Loads the message translation for the specified language and category.