yiisoft/translator-message-db

Yii Translator DB Message Storage

1.0.0 2023-05-09 18:37 UTC

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

BSD-3-Clause

• i18n
• formatting
• internationalization
• message storage

README

Yii Translator DB Message Storage

The package provides message storage backend based on DB to be used with yiisoft/translator package.

Supported databases

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

Requirements

• PHP 8.0 or higher.
• json PHP extension.

Installation

The package could be installed with composer:

composer require yiisoft/translator-message-db --prefer-dist

Create database connection

For more information see yiisoft/db.

Database Preparing

Package provides two way for preparing database:

1. Raw SQL. You can use it with the migration package used in your application.

   • Ensure tables:

     • MSSQL,
     • MySQL / MariaDB,
     • Oracle,
     • PostgreSQL
     • SQLite

   • Ensure no tables:

     • MSSQL,
     • MySQL / MariaDB,
     • Oracle,
     • PostgreSQL
     • SQLite

2. DbSchemaManager for ensureTables(), 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:

<?php

declare(strict_types=1);

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);

Support

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.

Testing

Check the testing instructions to learn about testing.

Support the project

Follow updates

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.