API Documentation for Yii 1.1

0 follower

CDbMessageSource

All Packages | Properties | Methods | Events

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

Property	Type	Description	Defined 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

Method	Description	Defined 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

Method	Description	Defined 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

Event	Description	Defined 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)

public CDbConnection getDbConnection()

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>0 && $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)
{
    $command=$this->getDbConnection()->createCommand()
        ->select("t1.message AS message, t2.translation AS translation")
        ->from(array("{$this->sourceMessageTable} t1","{$this->translatedMessageTable} t2"))
        ->where('t1.id=t2.id AND t1.category=:category AND t2.language=:language',array(':category'=>$category,':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.

User Contributed Notes 4

#4398

4 0

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

twisted1919 at Jul 5, 2011, 3:06:47 PM

#13630

0 0

Structure as a Migration

I instructions to make this into a migration.

Create a new Migration
Open a prompt and navigate to your protected folder:

[sh]
cd ./protected/
yiic migrate create "translatedMessageTable"
yes

Open the newly created file in _./protected/migrations/m____translatedMessageTable.php
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');
  }
}

Run your migration again in the command window

[sh]
cd ./protected/
yiic migrate up 1
yes

MrJ at Jun 12, 2013, 6:14:26 PM

#14896

0 0

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.

Blizz at Sep 19, 2013, 9:58:59 AM

#19177

0 0

My version of migration script

Before start the migration add CDbMessageSource component to config php:

'components' => array(
    // ...
    'messages' => array(
        'class'                  => 'CDbMessageSource',
        'cacheID'                => 'cache',
        'cachingDuration'        => 43200, // 12 hours
        'connectionID'           => 'db',
        'sourceMessageTable'     => '{{i18n_source_messages}}',
        'translatedMessageTable' => '{{i18n_translated_messages}}',
    ),
    // ...

Here the migration class

<?php

/**
 * 
 */
class m150405_044444_translatedMessageTable extends CDbMigration
{
    /**
     * @var string - name of CDbMessageSource component in config.php
     */
    public $dbMessageSourceComponent = 'messages';
    /**
     * @var string default table options
     */
    public $_mysqlTableOptions = 'ENGINE=InnoDB CHARSET=utf8 COLLATE=utf8_unicode_ci';
    
    /**
     * @see parent::safeUp()
     */
    public function safeUp()
    {
        //set system language as default for new translated messages
        $language = Yii::app()->language;
        /* @var $msgComponent CDbMessageSource */
        if ( ! $msgComponent = Yii::app()->getComponent($this->dbMessageSourceComponent) )
        {
            throw new CException('Error: CDbMessageSource component with name "'.
                $this->dbMessageSourceComponent.'" not found: check "components" section in your config.php');
        }
        // get table names from config
        $sourceMessageTable = $msgComponent->sourceMessageTable;
        $messageTable       = $msgComponent->translatedMessageTable;
        
        // source messages
        $this->createTable($sourceMessageTable, array(
            'id'           => 'bigpk',
            'category'     => 'string',
            'message'      => 'text',
            'timecreated'  => 'bigint',
            'timemodified' => 'bigint',
        ), $this->_mysqlTableOptions);
        $this->createIndex('idx_category', $sourceMessageTable, 'category');
        $this->createIndex('idx_timecreated', $sourceMessageTable, 'timecreated');
        $this->createIndex('idx_timemodified', $sourceMessageTable, 'timemodified');
        
        // translated messages
        $this->createTable($messageTable, array(
            'id'              => 'bigint',
            'language'        => "varchar(16) NOT NULL DEFAULT '{$language}'",
            'translation'     => 'text',
            'timecreated'     => 'bigint',
            'timemodified'    => 'bigint',
        ), $this->_mysqlTableOptions);
        $this->createIndex('idx_id', $messageTable, 'id');
        $this->createIndex('idx_language', $messageTable, 'language');
        $this->createIndex('idx_timecreated', $messageTable, 'timecreated');
        $this->createIndex('idx_timemodified', $messageTable, 'timemodified');
        
        $this->addForeignKey(
            'FK_message_sourcemessage',
            $messageTable,
            'id',
            $sourceMessageTable,
            'id',
            'CASCADE',
            'RESTRICT'
        );
    }
    
    /**
     * @see parent::safeDown()
     */
    public function safeDown()
    {
        if ( ! $msgComponent = Yii::app()->getComponent($this->dbMessageSourceComponent) )
        {
            throw new CException('Error: CDbMessageSource component with name '.$this->dbMessageSourceComponent.
                ' not found: check your config.php');
        }
        $sourceMessageTable = $msgComponent->sourceMessageTable;
        $messageTable       = $msgComponent->translatedMessageTable;
        
        $this->dropForeignKey('FK_message_sourcemessage', $messageTable);
        $this->dropTable($sourceMessageTable);
        $this->dropTable($messageTable);
    }
}

__construct() at Apr 7, 2015, 11:33:50 AM