API Documentation for Yii 1.0
0 follower
CDbMessageSource
| Package | system.i18n |
|---|---|
| Inheritance | class CDbMessageSource » CMessageSource » CApplicationComponent » CComponent |
| Implements | IApplicationComponent |
| Since | 1.0 |
| Version | $Id$ |
| 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:
When cachingDuration is set as a positive number, message translations will be cached.
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
| 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 |
| 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 |
| sourceMessageTable | string | the name of the source message table. | CDbMessageSource |
| translatedMessageTable | string | the name of the translated message table. | CDbMessageSource |
Public 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 |
| 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. | CDbMessageSource |
| 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
| Method | Description | Defined By |
|---|---|---|
| loadMessages() | Loads the message translation for the specified language and category. | CDbMessageSource |
| translateMessage() | Translates the specified message. | CMessageSource |
Events
| Event | Description | Defined By |
|---|---|---|
| onMissingTranslation | Raised when a message cannot be translated. | CMessageSource |
Property Details
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.
connectionID
property
public string $connectionID;
the ID of the database connection application component. Defaults to 'db'.
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
init()
method
|
public void init()
|
Source Code: framework/i18n/CDbMessageSource.php#78 (show)
public function init()
{
parent::init();
if(($this->_db=Yii::app()->getComponent($this->connectionID)) instanceof CDbConnection)
$this->_db->setActive(true);
else
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)));
}
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/CDbMessageSource.php#94 (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);
}
$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->_db->createCommand($sql);
$command->bindValue(':category',$category);
$command->bindValue(':language',$language);
$rows=$command->queryAll();
$messages=array();
foreach($rows as $row)
$messages[$row['message']]=$row['translation'];
if(isset($cache))
$cache->set($key,serialize($messages),$this->cachingDuration);
return $messages;
}
Loads the message translation for the specified language and category.
Signup or Login in order to comment.