yiisoft/translator-message-gettext

Yii Translator gettext Message Storage

1.0.0 2021-05-13 10:49 UTC

This package is auto-updated.

Last update: 2022-09-22 10:01:57 UTC


README

68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667

Yii Translator gettext Message Storage


Latest Stable Version Total Downloads Build Status Scrutinizer Code Quality Code Coverage Mutation testing badge static analysis type-coverage

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

Requirements

  • PHP 7.4 or higher.
  • gettext PHP extension.

Installation

The package could be installed with composer:

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

Configuration

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\Gettext\MessageSource;
use Yiisoft\Aliases\Aliases;

return [
    MessageReaderInterface::class => [
        'class' => MessageSource::class,
        '__construct()' => [
            DynamicReference::to(fn (Aliases $aliases) => $aliases->get('@message')),
        ],
    ],
];

Note: You can use absolute path to translation files in case you don't want to use yiisoft/aliases

    MessageReaderInterface::class => [
        'class' => MessageSource::class,
        '__construct()' => [
            '/var/www/app/resourse/messages',
        ],
    ],

Attention

When using gettext, locale depends on your OS requirement:

  • for Windows 'locale' => 'en-US.UTF-8'
  • for Linux 'locale' => 'en_US.UTF-8'

General usage

Create of instance of MessageSource

/** @var string $path - path to your gettext storage */
$messageSource = new \Yiisoft\Translator\Message\Gettext\MessageSource($path);

Read message without yiisoft/translator package

/** 
 * @var \Yiisoft\Translator\Message\Gettext\MessageSource $messageSource
 * @var ?string $translatedString
 */
$id = 'messageIdentificator';
$category = 'messages';
$language = 'de-DE';

$translatedString = $messageSource->getMessage($id, $category, $language);

You can create your translations in .mo format with use third-party software (for example Poedit)

Recommended structure to your gettext storage:

-- path_to_your_storage
  -- de_DE
    -- LC_MESSAGES
        -- messages.mo

Testing

Unit testing

The package is tested with PHPUnit. To run tests:

./vendor/bin/phpunit

Mutation testing

The package tests are checked with Infection mutation framework with Infection Static Analysis Plugin. To run it:

./vendor/bin/roave-infection-static-analysis-plugin

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

License

The Yii Translator gettext 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.

Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack