The package provides message storage backend based on DB to be used
with yiisoft/translator
package.
Packages | PHP | Versions | CI-Actions |
---|---|---|---|
[db-mssql] | 8.0 - 8.2 | 2017 - 2022 | |
[db-mysql/mariadb] | 8.0 - 8.2 | 5.7-8.0/10.4-10.10 | |
[db-oracle] | 8.0 - 8.2 | 11C - 21C | |
[db-pgsql] | 8.0 - 8.2 | 9.0 - 15.0 | |
[db-sqlite] | 8.0 - 8.2 | 3:latest |
- PHP 8.0 or higher.
json
PHP extension.
The package could be installed with composer:
composer require yiisoft/translator-message-db --prefer-dist
For more information see yiisoft/db.
Package provides two way for preparing database:
-
Raw SQL. You can use it with the migration package used in your application.
-
Ensure tables:
-
Ensure no tables:
-
-
DbSchemaManager
forensureTables()
,ensureNoTables()
methods for translator tables (by default{{%yii_source_message}}
and{{%yii_message}}
).
In case you use yiisoft/config
, you will get configuration automatically.
If not, the following DI container configuration is necessary:
<?php
declare(strict_types=1);
use Yiisoft\Translator\MessageReaderInterface;
use Yiisoft\Translator\Message\Db\MessageSource;
return [
MessageReaderInterface::class => [
'class' => MessageSource::class,
],
];
/** @var \Yiisoft\Db\Connection\ConnectionInterface $db */
$messageSource = new \Yiisoft\Translator\Message\Db\MessageSource($db);
/** @var \Yiisoft\Db\Connection\ConnectionInterface $db */
/** @var \Yiisoft\Cache\CacheInterface $cache */
$cacheDuration = 7200; // The TTL of this value. If set to null, default value is used - 3600
$messageSource = new \Yiisoft\Translator\Message\Db\MessageSource($db, $cache, $cacheDuration);
/**
* @var \Yiisoft\Translator\Message\Db\MessageSource $messageSource
* @var ?string $translatedString
*/
$id = 'messageIdentificator';
$category = 'messageCategory';
$language = 'de-DE';
$translatedString = $messageSource->getMessage($id, $category, $language);
/**
* @var \Yiisoft\Translator\Message\Db\MessageSource $messageSource
*/
$category = 'messageCategory';
$language = 'de-DE';
$data = [
'test.id1' => [
'message' => 'Nachricht 1', // translated string
'comment' => 'Comment for message 1', // is optional parameter for save extra metadata
],
'test.id2' => [
'message' => 'Nachricht 2',
],
'test.id3' => [
'message' => 'Nachricht 3',
],
];
$messageSource->write($category, $language, $data);
If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.
Check the testing instructions to learn about testing.
The Yii Translator DB Message Storage is free software. It is released under the terms of the BSD License.
Please see LICENSE
for more information.
Maintained by Yii Software.