yiisoft / translator-message-db
Yii Translator DB Message Storage
Fund package maintenance!
Opencollective
yiisoft
Installs: 2 002
Dependents: 0
Suggesters: 0
Security: 0
Stars: 9
Watchers: 16
Forks: 6
Open Issues: 0
Requires
- php: ^8.0
- ext-json: *
- yiisoft/arrays: ^2.0|^3.0
- yiisoft/cache: 2.0
- yiisoft/db: ^1.0
- yiisoft/translator: ^2.2
Requires (Dev)
- maglnet/composer-require-checker: ^4.2
- phpunit/phpunit: ^9.6|^10.1
- rector/rector: ^0.16
- roave/infection-static-analysis-plugin: ^1.25|^1.29
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.8|^5.8
This package is auto-updated.
Last update: 2024-10-28 04:43:43 UTC
README
Yii Translator DB Message Storage
The package provides message storage backend based on DB to be used
with yiisoft/translator
package.
Supported databases
Requirements
- PHP 8.0 or higher.
json
PHP extension.
Installation
The package could be installed with Composer:
composer require yiisoft/translator-message-db
Create database connection
For more information see yiisoft/db.
Database Preparing
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}}
).
Configuration
Quick start
In case you use yiisoft/config
, you will get configuration automatically.
If not, the following DI container configuration is necessary:
use Yiisoft\Translator\MessageReaderInterface; use Yiisoft\Translator\Message\Db\MessageSource; return [ MessageReaderInterface::class => [ 'class' => MessageSource::class, ], ];
General usage
Create of instance of MessageSource
/** @var \Yiisoft\Db\Connection\ConnectionInterface $db */ $messageSource = new \Yiisoft\Translator\Message\Db\MessageSource($db);
Create of instance of MessageSource with caching
/** @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);
Read message without yiisoft/translator
package
/** * @var \Yiisoft\Translator\Message\Db\MessageSource $messageSource * @var ?string $translatedString */ $id = 'messageIdentificator'; $category = 'messageCategory'; $language = 'de-DE'; $translatedString = $messageSource->getMessage($id, $category, $language);
Writing messages from array to storage
/** * @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);
Documentation
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.
License
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.