yiisoft/translator-message-db

Yii Translator DB Message Storage

1.0.0 2023-05-09 18:37 UTC

README

68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667

Yii Translator DB Message Storage


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

Latest Stable Version Total Downloads codecov Mutation testing badge static analysis type-coverage

Supported databases

Packages PHP Versions CI-Actions
[db-mssql] 8.0 - 8.2 2017 - 2022 mssql
[db-mysql/mariadb] 8.0 - 8.2 5.7-8.0/10.4-10.10 mysql
[db-oracle] 8.0 - 8.2 11C - 21C oracle
[db-pgsql] 8.0 - 8.2 9.0 - 15.0 pgsql
[db-sqlite] 8.0 - 8.2 3:latest sqlite

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.

  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

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack

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.