Versions
Look up a class, method, property or event

CDbMessageSource

Package system.i18n
Inheritance class CDbMessageSource » CMessageSource » CApplicationComponent » CComponent
Implements IApplicationComponent
Since 1.0
Source Code framework/i18n/CDbMessageSource.php
CDbMessageSource represents a message source that stores translated messages in database.

The database must contain the following two tables:
CREATE TABLE SourceMessage
(
    id INTEGER PRIMARY KEY,
    category VARCHAR(32),
    message TEXT
);
CREATE TABLE Message
(
    id INTEGER,
    language VARCHAR(16),
    translation TEXT,
    PRIMARY KEY (id, language),
    CONSTRAINT FK_Message_SourceMessage FOREIGN KEY (id)
         REFERENCES SourceMessage (id) ON DELETE CASCADE ON UPDATE RESTRICT
);
The 'SourceMessage' table stores the messages to be translated, and the 'Message' table stores the translated messages. The name of these two tables can be customized by setting sourceMessageTable and translatedMessageTable, respectively.

When cachingDuration is set as a positive number, message translations will be cached.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
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. CDbMessageSource
cachingDuration integer the time in seconds that the messages can remain valid in cache. CDbMessageSource
connectionID string the ID of the database connection application component. CDbMessageSource
dbConnection CDbConnection Returns the DB connection used for the message source. CDbMessageSource
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
sourceMessageTable string the name of the source message table. CDbMessageSource
translatedMessageTable string the name of the translated message table. CDbMessageSource

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
evaluateExpression() Evaluates a PHP expression or callback under the context of this component. CComponent
getDbConnection() Returns the DB connection used for the message source. CDbMessageSource
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. CApplicationComponent
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
loadMessages() Loads the message translation for the specified language and category. CDbMessageSource
loadMessagesFromDb() Loads the messages from database. CDbMessageSource
translateMessage() Translates the specified message. CMessageSource

Events

Hide inherited events

EventDescriptionDefined By
onMissingTranslation Raised when a message cannot be translated. CMessageSource

Property Details

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.

connectionID property
public string $connectionID;

the ID of the database connection application component. Defaults to 'db'.

dbConnection property read-only (available since v1.1.5)

Returns the DB connection used for the message source.

sourceMessageTable property
public string $sourceMessageTable;

the name of the source message table. Defaults to 'SourceMessage'.

translatedMessageTable property
public string $translatedMessageTable;

the name of the translated message table. Defaults to 'Message'.

Method Details

getDbConnection() method (available since v1.1.5)
public CDbConnection getDbConnection()
{return} CDbConnection the DB connection used for the message source.
Source Code: framework/i18n/CDbMessageSource.php#102 (show)
public function getDbConnection()
{
    if(
$this->_db===null)
    {
        
$this->_db=Yii::app()->getComponent($this->connectionID);
        if(!
$this->_db instanceof CDbConnection)
            throw new 
CException(Yii::t('yii','CDbMessageSource.connectionID is invalid. Please make sure "{id}" refers to a valid database application component.',
                array(
'{id}'=>$this->connectionID)));
    }
    return 
$this->_db;
}

Returns the DB connection used for the message source.

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/CDbMessageSource.php#77 (show)
protected function loadMessages($category,$language)
{
    if(
$this->cachingDuration>&& $this->cacheID!==false && ($cache=Yii::app()->getComponent($this->cacheID))!==null)
    {
        
$key=self::CACHE_KEY_PREFIX.'.messages.'.$category.'.'.$language;
        if((
$data=$cache->get($key))!==false)
            return 
unserialize($data);
    }

    
$messages=$this->loadMessagesFromDb($category,$language);

    if(isset(
$cache))
        
$cache->set($key,serialize($messages),$this->cachingDuration);

    return 
$messages;
}

Loads the message translation for the specified language and category.

loadMessagesFromDb() method (available since v1.1.5)
protected array loadMessagesFromDb(string $category, string $language)
$category string the message category
$language string the target language
{return} array the messages loaded from database
Source Code: framework/i18n/CDbMessageSource.php#122 (show)
protected function loadMessagesFromDb($category,$language)
{
    
$sql=<<<EOD
SELECT t1.message AS message, t2.translation AS translation
FROM 
{$this->sourceMessageTable} t1, {$this->translatedMessageTable} t2
WHERE t1.id=t2.id AND t1.category=:category AND t2.language=:language
EOD;
    
$command=$this->getDbConnection()->createCommand($sql);
    
$command->bindValue(':category',$category);
    
$command->bindValue(':language',$language);
    
$messages=array();
    foreach(
$command->queryAll() as $row)
        
$messages[$row['message']]=$row['translation'];

    return 
$messages;
}

Loads the messages from database. You may override this method to customize the message storage in the database.

Total 3 comments

#14896 report it
Blizz at 2013/09/19 05:58am
DDL is not transactionable

There is absolutely no use in creating a table in the safeUp method instead of up. DDL statements do not fall under things that can be rolled back.

#13630 report it
MrJ at 2013/06/12 02:14pm
Structure as a Migration

I instructions to make this into a migration.

  1. Create a new Migration Open a prompt and navigate to your protected folder:
cd ./protected/
yiic migrate create "translatedMessageTable"
yes
  1. Open the newly created file in _./protected/migrations/m________translatedMessageTable.php

  2. create the tables in safeUp()

<?php
 
class m________translatedMessageTable extends CDbMigration
{
  public function safeUp()
  {
    $this->createTable(
      'SourceMessage', 
      array(
        'id' => 'INTEGER PRIMARY KEY',
        'category' => 'VARCHAR(32)',
        'message' => 'TEXT',
      )
    );
 
    $this->createTable(
      'Message', 
      array(
        'id' => 'INTEGER',
        'language' => 'VARCHAR(16)',
        'translation' => 'TEXT',
      )
    );
 
    $this->addPrimaryKey('PK_Message','Message','id, language');
 
    $this->addForeignKey(
      'FK_Message_SourceMessage',
      'Message',
      'id',
      'SourceMessage',
      'id',
      'CASCADE',
      'RESTRICT'
    );
 
  public function safeDown()
  {
    $this->dropForeignKey('FK_Message_SourceMessage','Message');
    $this->dropTable('SourceMessage');
    $this->dropTable('Message');
  }
}
  1. Run your migration again in the command window
cd ./protected/
yiic migrate up 1
yes
#4398 report it
twisted1919 at 2011/07/05 11:06am
MySql database structure
CREATE TABLE IF NOT EXISTS `SourceMessage` (
  `id` int(11) NOT NULL auto_increment,
  `category` varchar(32) default NULL,
  `message` text,
  PRIMARY KEY  (`id`)
) ENGINE=InnoDB  DEFAULT CHARSET=utf8 AUTO_INCREMENT=1 ;
CREATE TABLE IF NOT EXISTS `Message` (
  `id` int(11) NOT NULL,
  `language` varchar(16) NOT NULL default '',
  `translation` text,
  PRIMARY KEY  (`id`,`language`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
ALTER TABLE `Message`
  ADD CONSTRAINT `message_ibfk_1` FOREIGN KEY (`id`) REFERENCES `SourceMessage` (`id`) ON DELETE CASCADE

Leave a comment

Please to leave your comment.