0 follower

CPhpMessageSource

Package system.i18n
Inheritance class CPhpMessageSource » CMessageSource » CApplicationComponent » CComponent
Implements IApplicationComponent
Since 1.0
Version $Id$
Source Code 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.
  • 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',
);
When cachingDuration is set as a positive number, message translations will be cached.

Starting from version 1.0.10, 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, we should use: Yii::t('Xyz.categoryName', 'message to be translated').

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
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
isInitialized boolean whether this application component has been initialized (i.e., init() is invoked. CApplicationComponent
language string the language that the source messages are written in. CMessageSource

Public Methods

Hide inherited methods

MethodDescriptionDefined 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
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
getIsInitialized() Checks whether this application component has been initialized (i.e., init() is invoked.) 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

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
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

Events

Hide inherited events

EventDescriptionDefined 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.

Method Details

getMessageFile() method (available since v1.0.10)
protected string getMessageFile(string $category, string $language)
$category string category name
$language string language ID
{return} string the message file path
Source Code: framework/i18n/CPhpMessageSource.php#91 (show)
protected function getMessageFile($category,$language)
{
    if(!isset($this->_files[$category][$language]))
    {
        if(($pos=strpos($category,'.'))!==false)
        {
            $moduleClass=substr($category,0,$pos);
            $moduleCategory=substr($category,$pos+1);
            $class=new ReflectionClass($moduleClass);
            $this->_files[$category][$language]=dirname($class->getFileName()).DIRECTORY_SEPARATOR.'messages'.DIRECTORY_SEPARATOR.$language.DIRECTORY_SEPARATOR.$moduleCategory.'.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() method
public void init()
Source Code: framework/i18n/CPhpMessageSource.php#73 (show)
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() method
protected array loadMessages(string $category, string $language)
$category string the message category
$language string the target language
{return} array the loaded messages
Source Code: framework/i18n/CPhpMessageSource.php#114 (show)
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.