Class yii\mongodb\i18n\MongoDbMessageSource

All Classes | Properties | Methods | Events

Inheritance	yii\mongodb\i18n\MongoDbMessageSource » yii\i18n\MessageSource » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable
Available since version	2.0.5
Source Code	https://github.com/yiisoft/yii2-mongodb/blob/master/i18n/MongoDbMessageSource.php

MongoDbMessageSource extends yii\i18n\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
$forceTranslation	boolean	Whether to force message translation when the source and target languages are the same.	yii\i18n\MessageSource
$sourceLanguage	string	The language that the original messages are in.	yii\i18n\MessageSource

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()	Initializes the DbMessageSource component.	yii\mongodb\i18n\MongoDbMessageSource
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
translate()	Translates a message to the specified language.	yii\i18n\MessageSource
trigger()	Triggers an event.	yii\base\Component

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
translateMessage()	Translates the specified message.	yii\i18n\MessageSource

Events

Hide inherited events

Event	Type	Description	Defined By
EVENT_MISSING_TRANSLATION	yii\i18n\MissingTranslationEvent	An event that is triggered when a message translation is not found.	yii\i18n\MessageSource

Property Details

$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

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.

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.

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.