Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yiisoft/translator-formatter-intl

Yii i18n intl message formatter
https://github.com/yiisoft/translator-formatter-intl

hacktoberfest i18n yii3

Last synced: about 2 months ago
JSON representation

Yii i18n intl message formatter

Host: GitHub
URL: https://github.com/yiisoft/translator-formatter-intl
Owner: yiisoft
License: bsd-3-clause
Archived: true
Created: 2019-04-07T18:47:31.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2022-11-08T06:56:26.000Z (about 2 years ago)
Last Synced: 2024-04-14T04:07:08.783Z (7 months ago)
Topics: hacktoberfest, i18n, yii3
Language: PHP
Homepage: https://www.yiiframework.com/
Size: 82 KB
Stars: 10
Watchers: 16
Forks: 6
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 intl Message Formatter

    


[![Latest Stable Version](https://poser.pugx.org/yiisoft/translator-formatter-intl/v/stable.png)](https://packagist.org/packages/yiisoft/translator-formatter-intl)

[![Total Downloads](https://poser.pugx.org/yiisoft/translator-formatter-intl/downloads.png)](https://packagist.org/packages/yiisoft/translator-formatter-intl)

[![Build status](https://github.com/yiisoft/translator-formatter-intl/workflows/build/badge.svg)](https://github.com/yiisoft/translator-formatter-intl/actions?query=workflow%3Abuild)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/yiisoft/translator-formatter-intl/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/yiisoft/translator-formatter-intl/?branch=master)

[![Code Coverage](https://scrutinizer-ci.com/g/yiisoft/translator-formatter-intl/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/yiisoft/translator-formatter-intl/?branch=master)

[![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Ftranslator-formatter-intl%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/translator-formatter-intl/master)

[![static analysis](https://github.com/yiisoft/translator-formatter-intl/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/translator-formatter-intl/actions?query=workflow%3A%22static+analysis%22)

[![type-coverage](https://shepherd.dev/github/yiisoft/translator-formatter-intl/coverage.svg)](https://shepherd.dev/github/yiisoft/translator-formatter-intl)

The package provides message formatter that utilizes PHP intl extension message formatting capabilities.

## Requirements

- PHP 7.4 or higher.

- `intl` PHP extension 1.0.2 or higher.

- `ICU` library 49.0 or higher.

## Installation

The package could be installed with composer:

```shell

composer require yiisoft/translator-formatter-intl --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

 IntlMessageFormatter::class,

];

```

## General usage

### Example of usage with `yiisoft/translator`

```php

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

$categoryName = 'moduleId';

$pathToModuleTranslations = './module/messages/';

$additionalCategorySource = new Yiisoft\Translator\CategorySource(

    $categoryName, 

    new \Yiisoft\Translator\Message\Php\MessageSource($pathToModuleTranslations),

    new \Yiisoft\Translator\Formatter\Intl\IntlMessageFormatter()

);

$translator->addCategorySource($additionalCategorySource);

$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\Intl\IntlMessageFormatter $formatter */

$pattern = 'Total {count, number} {count, plural, one{item} other{items}}.';

$params = ['count' => 1];

$locale = 'en';

echo $formatter->format($pattern, $params, $locale);

// output: Total 1 item. 

$pattern = '{gender, select, female{Уважаемая} other{Уважаемый}} {firstname}';

$params = ['gender' => null, 'firstname' => 'Vadim'];

echo $formatter->format($pattern, $params, 'ru');

// output: Уважаемый Vadim 

$pattern = '{name} is {gender} and {gender, select, female{she} male{he} other{it}} loves Yii!';

$params = ['name' => 'Alexander', 'gender' => 'male'];

echo $formatter->format($pattern, $params, $locale);

// output: Alexander is male and he loves Yii! 

```

To get a list of options available for locale you're using - see [https://intl.rmcreative.ru/](https://intl.rmcreative.ru/)

## 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 intl 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

[![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft)

## Follow updates

[![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)

[![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter&logoColor=1DA1F2&labelColor=555555?style=flat)](https://twitter.com/yiiframework)

[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)

[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)

[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)