PHP 클래스 yii\mongodb\i18n\MongoDbMessageSource

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 key is raw message name value - message translation. For example: json { "category": "app", "language": "de", "messages": { "Hello world!": "Hallo Welt!", "The dog runs fast.": "Der Hund rennt schnell.", ... }, }
부터: 2.0.5
저자: Paul Klimov ([email protected])
상속: extends yii\i18n\MessageSource
파일 보기 프로젝트 열기: yiisoft/yii2-mongodb

공개 프로퍼티들

프로퍼티 타입 설명
$cache 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.
$cachingDuration the time in seconds that the messages can remain valid in cache. Use 0 to indicate that the cached data will never expire.
$collection the name of the MongoDB collection, which stores translated messages. This collection is better to be pre-created with fields 'category' and 'language' indexed.
$db the MongoDB connection object or the application component ID of the MongoDB connection. After the MongoDbMessageSource object is created, if you want to change this property, you should only assign it with a MongoDB connection object. This can also be a configuration array for creating the object.
$enableCaching whether to enable caching translated messages

공개 메소드들

메소드 설명
init ( ) Initializes the DbMessageSource component.

보호된 메소드들

메소드 설명
loadMessages ( string $category, string $language ) : array Loads the message translation for the specified language and category.
loadMessagesFromDb ( string $category, string $language ) : array Loads the messages from MongoDB.

메소드 상세

init() 공개 메소드

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 init ( )

loadMessages() 보호된 메소드

If translation for specific locale code such as en-US isn't found it tries more generic en.
protected loadMessages ( string $category, string $language ) : array
$category string the message category
$language string the target language
리턴 array the loaded messages. The keys are original messages, and the values are translated messages.

loadMessagesFromDb() 보호된 메소드

You may override this method to customize the message storage in the MongoDB.
protected loadMessagesFromDb ( string $category, string $language ) : array
$category string the message category.
$language string the target language.
리턴 array the messages loaded from database.

프로퍼티 상세

$cache 공개적으로 프로퍼티

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.
또한 보기: cachingDuration
또한 보기: enableCaching
public $cache

$cachingDuration 공개적으로 프로퍼티

the time in seconds that the messages can remain valid in cache. Use 0 to indicate that the cached data will never expire.
또한 보기: enableCaching
public $cachingDuration

$collection 공개적으로 프로퍼티

the name of the MongoDB collection, which stores translated messages. This collection is better to be pre-created with fields 'category' and 'language' indexed.
public $collection

$db 공개적으로 프로퍼티

the MongoDB connection object or the application component ID of the MongoDB connection. After the MongoDbMessageSource object is created, if you want to change this property, you should only assign it with a MongoDB connection object. This can also be a configuration array for creating the object.
public $db

$enableCaching 공개적으로 프로퍼티

whether to enable caching translated messages
public $enableCaching