This package is abandoned and no longer maintained. The author suggests using the yiisoft/translator package instead.

Yii Translator Simple Message Formatter

1.0.0 2021-05-13 10:46 UTC

This package is auto-updated.

Last update: 2022-09-05 21:04:05 UTC


This package is deprecated and is now part of yiisoft/translator.


Yii Translator Simple Message Formatter

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

This package allow to format messages in simple mode. When translating a message, you can embed some placeholders and have them replaced by dynamic parameter values.


  • PHP 7.4 or higher.


The package could be installed with composer:

composer require yiisoft/translator-formatter-simple --prefer-dist


In case you use yiisoft/config, you will get configuration automatically. If not, the following DI container configuration is necessary:



use Yiisoft\Translator\MessageFormatterInterface;
use Yiisoft\Translator\Formatter\Simple\SimpleMessageFormatter;

return [
    MessageFormatterInterface::class => SimpleMessageFormatter::class,

General usage

Example of usage with yiisoft/translator

/** @var \Yiisoft\Translator\Translator $translator **/

$categoryName = 'moduleId';
$pathToModuleTranslations = './module/messages/';
$additionalCategory = new Yiisoft\Translator\CategorySource(
    new \Yiisoft\Translator\Message\Php\MessageSource($pathToModuleTranslations),
    new \Yiisoft\Translator\Formatter\Simple\SimpleMessageFormatter()

$translator->translate('Test string: {str}', ['str' => 'string data'], 'moduleId', 'en');
// output: Test string: string data

Example of usage without yiisoft/translator package

/** @var \Yiisoft\Translator\Formatter\Simple\SimpleMessageFormatter $formatter */
$pattern = 'Test number: {number}';
$params = ['number' => 5];
$locale = 'en';
echo $formatter->format($pattern, $params, $locale);
// output: Test number: 5

$pattern = 'Test string: {str}';
$params = ['str' => 'string data'];
echo $formatter->format($pattern, $params, $locale);
// output: Test string: string data 


Unit testing

The package is tested with PHPUnit. To run tests:


Mutation testing

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


Static analysis

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



The Yii Translator Simple Message Formatter 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