CGettextMessageSource

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

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 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()

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)

protected function loadMessages($category, $language)
{
    $messageFile=$this->basePath . DIRECTORY_SEPARATOR . $language . DIRECTORY_SEPARATOR . $this->catalog;
    if($this->useMoFile)
        $messageFile.=self::MO_FILE_EXT;
    else
        $messageFile.=self::PO_FILE_EXT;

    if ($this->cachingDuration > 0 && $this->cacheID!==false && ($cache=Yii::app()->getComponent($this->cacheID))!==null)
    {
        $key = self::CACHE_KEY_PREFIX . $messageFile . "." . $category;
        if (($data=$cache->get($key)) !== false)
            return unserialize($data);
    }

    if (is_file($messageFile))
    {
        if($this->useMoFile)
            $file=new CGettextMoFile($this->useBigEndian);
        else
            $file=new CGettextPoFile();
        $messages=$file->load($messageFile,$category);
        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.