Class yii\mongodb\i18n\MongoDbMessageSource

All Classes | Properties | Methods

Inheritance	yii\mongodb\i18n\MongoDbMessageSource » yii\i18n\MessageSource
Available since extension's version	2.0.5
Source Code	https://github.com/yiisoft/yii2-mongodb/blob/master/src/i18n/MongoDbMessageSource.php

MongoDbMessageSource extends MessageSource and represents a message source that stores translated messages in MongoDB collection.

This message source uses single collection for the message translations storage, defined via $collection. Each entry in this collection should have 3 fields:

language: string, translation language
category: string, name translation category
messages: array, list of actual message translations, in each element: the 'message' key is raw message name and 'translation' key - message translation.

For example:

{
    "category": "app",
    "language": "de",
    "messages": {
        {
            "message": "Hello world!",
            "translation": "Hallo Welt!"
        },
        {
            "message": "The dog runs fast.",
            "translation": "Der Hund rennt schnell.",
        },
        ...
    },
}

You also can specify 'messages' using source message as a direct BSON key, while its value holds the translation. For example:

{
    "category": "app",
    "language": "de",
    "messages": {
        "Hello world!": "Hallo Welt!",
        "See more": "Mehr sehen",
        ...
    },
}

However such approach is not recommended as BSON keys can not contain symbols like . or $.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$cache	\yii\caching\Cache\|array\|string	The cache object or the application component ID of the cache object.	yii\mongodb\i18n\MongoDbMessageSource
$cachingDuration	integer	The time in seconds that the messages can remain valid in cache.	yii\mongodb\i18n\MongoDbMessageSource
$collection	string\|array	The name of the MongoDB collection, which stores translated messages.	yii\mongodb\i18n\MongoDbMessageSource
$db	yii\mongodb\Connection\|array\|string	The MongoDB connection object or the application component ID of the MongoDB connection.	yii\mongodb\i18n\MongoDbMessageSource
$enableCaching	boolean	Whether to enable caching translated messages	yii\mongodb\i18n\MongoDbMessageSource

Public Methods

Hide inherited methods

Method	Description	Defined By
init()	Initializes the DbMessageSource component.	yii\mongodb\i18n\MongoDbMessageSource

Protected Methods

Hide inherited methods

Method	Description	Defined By
loadMessages()	Loads the message translation for the specified language and category.	yii\mongodb\i18n\MongoDbMessageSource
loadMessagesFromDb()	Loads the messages from MongoDB.	yii\mongodb\i18n\MongoDbMessageSource

Property Details

Hide inherited properties

$cache public property

The cache object or the application component ID of the cache object. The messages data will be cached using this cache object. Note, that to enable caching you have to set $enableCaching to true, otherwise setting this property has no effect.

After the MongoDbMessageSource object is created, if you want to change this property, you should only assign it with a cache object.

This can also be a configuration array for creating the object.

Method Details

Hide inherited methods

init() public method

Initializes the DbMessageSource component.

This method will initialize the $db property to make sure it refers to a valid DB connection. Configured $cache component would also be initialized.

public void init ( )
throws	\yii\base\InvalidConfigException	if $db is invalid or $cache is invalid.

Source code

                public function init()
{
    parent::init();
    $this->db = Instance::ensure($this->db, Connection::className());
    if ($this->enableCaching) {
        $this->cache = Instance::ensure($this->cache, Cache::className());
    }
}

loadMessages() protected method

Loads the message translation for the specified language and category.

If translation for specific locale code such as en-US isn't found it tries more generic en.

protected array loadMessages ( $category, $language )
$category	string	The message category
$language	string	The target language
return	array	The loaded messages. The keys are original messages, and the values are translated messages.

Source code

                protected function loadMessages($category, $language)
{
    if ($this->enableCaching) {
        $key = [
            __CLASS__,
            $category,
            $language,
        ];
        $messages = $this->cache->get($key);
        if ($messages === false) {
            $messages = $this->loadMessagesFromDb($category, $language);
            $this->cache->set($key, $messages, $this->cachingDuration);
        }
        return $messages;
    }
    return $this->loadMessagesFromDb($category, $language);
}

loadMessagesFromDb() protected method

Loads the messages from MongoDB.

You may override this method to customize the message storage in the MongoDB.

protected array loadMessagesFromDb ( $category, $language )
$category	string	The message category.
$language	string	The target language.
return	array	The messages loaded from database.

Source code

                protected function loadMessagesFromDb($category, $language)
{
    $fallbackLanguage = substr($language, 0, 2);
    $fallbackSourceLanguage = substr($this->sourceLanguage, 0, 2);
    $languages = [
        $language,
        $fallbackLanguage,
        $fallbackSourceLanguage
    ];
    $rows = (new Query())
        ->select(['language', 'messages'])
        ->from($this->collection)
        ->andWhere(['category' => $category])
        ->andWhere(['language' => array_unique($languages)])
        ->all($this->db);
    if (count($rows) > 1) {
        $languagePriorities = [
            $language => 1
        ];
        $languagePriorities[$fallbackLanguage] = 2; // language key may be already taken
        $languagePriorities[$fallbackSourceLanguage] = 3; // language key may be already taken
        usort($rows, function ($a, $b) use ($languagePriorities) {
            $languageA = $a['language'];
            $languageB = $b['language'];
            if ($languageA === $languageB) {
                return 0;
            }
            if ($languagePriorities[$languageA] < $languagePriorities[$languageB]) {
                return +1;
            }
            return -1;
        });
    }
    $messages = [];
    foreach ($rows as $row) {
        foreach ($row['messages'] as $key => $value) {
            // @todo drop message as key specification at 2.2
            if (is_array($value)) {
                $messages[$value['message']] = $value['translation'];
            } else {
                $messages[$key] = $value;
            }
        }
    }
    return $messages;
}