yiisoft / translator-formatter-simple
Yii Translator Simple Message Formatter
Fund package maintenance!
Open Collective
yiisoft
Installs: 2 016
Dependents: 1
Suggesters: 0
Security: 0
Stars: 4
Watchers: 12
Forks: 4
Open Issues: 0
Requires
- php: ^7.4|^8.0
- yiisoft/translator: ^1.0
Requires (Dev)
- phpunit/phpunit: ^9.4
- roave/infection-static-analysis-plugin: ^1.5
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.2
This package is auto-updated.
Last update: 2022-09-05 21:04:05 UTC
README
This package is deprecated and is now part of yiisoft/translator.
❌
Yii Translator Simple Message Formatter
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.
Requirements
- PHP 7.4 or higher.
Installation
The package could be installed with composer:
composer require yiisoft/translator-formatter-simple --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\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( $categoryName, new \Yiisoft\Translator\Message\Php\MessageSource($pathToModuleTranslations), new \Yiisoft\Translator\Formatter\Simple\SimpleMessageFormatter() ); $translator->addCategorySource($additionalCategory); $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
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 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.