Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/translator-formatter-simple
https://github.com/yiisoft/translator-formatter-simple
formatter hacktoberfest i18n translator
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/yiisoft/translator-formatter-simple
- Owner: yiisoft
- License: bsd-3-clause
- Archived: true
- Created: 2020-10-15T13:55:30.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-05T21:03:07.000Z (about 2 years ago)
- Last Synced: 2024-04-14T00:22:21.215Z (7 months ago)
- Topics: formatter, hacktoberfest, i18n, translator
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 43.9 KB
- Stars: 5
- Watchers: 16
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
This package is deprecated and is now part of
yiisoft/translator.
❌
---
Yii Translator Simple Message Formatter
[](https://packagist.org/packages/yiisoft/translator-formatter-simple)
[](https://packagist.org/packages/yiisoft/translator-formatter-simple)
[](https://github.com/yiisoft/translator-formatter-simple/actions?query=workflow%3Abuild)
[](https://scrutinizer-ci.com/g/yiisoft/translator-formatter-simple/?branch=master)
[](https://scrutinizer-ci.com/g/yiisoft/translator-formatter-simple/?branch=master)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/translator-formatter-simple/master)
[](https://github.com/yiisoft/translator-formatter-simple/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/translator-formatter-simple)
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`](http://github.com/yiisoft/config), you will get configuration automatically. If not, the following DI container configuration is necessary:
```php
SimpleMessageFormatter::class,
];
```
## General usage
### Example of usage with `yiisoft/translator`
```php
/** @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
```php
/** @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](https://phpunit.de/). To run tests:
```shell
./vendor/bin/phpunit
```
### Mutation testing
The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:
```shell
./vendor/bin/roave-infection-static-analysis-plugin
```
### Static analysis
The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
```shell
./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`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)