Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/translator-message-php
Yii i18n PHP message storage
https://github.com/yiisoft/translator-message-php
hacktoberfest i18n yii3
Last synced: about 1 month ago
JSON representation
Yii i18n PHP message storage
- Host: GitHub
- URL: https://github.com/yiisoft/translator-message-php
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2019-04-07T18:47:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-04T05:21:30.000Z (8 months ago)
- Last Synced: 2024-04-13T23:52:53.700Z (7 months ago)
- Topics: hacktoberfest, i18n, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 127 KB
- Stars: 13
- Watchers: 16
- Forks: 8
- Open Issues: 1
-
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
Yii Translator PHP Message Storage
[](https://packagist.org/packages/yiisoft/translator-message-php)
[](https://packagist.org/packages/yiisoft/translator-message-php)
[](https://github.com/yiisoft/translator-message-php/actions?query=workflow%3Abuild)
[](https://scrutinizer-ci.com/g/yiisoft/translator-message-php/?branch=master)
[](https://scrutinizer-ci.com/g/yiisoft/translator-message-php/?branch=master)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/translator-message-php/master)
[](https://github.com/yiisoft/translator-message-php/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/translator-message-php)
The package provides message storage backend based on PHP arrays to be used with [`yiisoft/translator`](https://github.com/yiisoft/translator) package.
## Requirements
- PHP 8.0 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/translator-message-php
```
## General usage
The package is meant to be used with [`yiisoft/translator`](https://github.com/yiisoft/translator):
```php
use Yiisoft\Translator\CategorySource;
use Yiisoft\Translator\IntlMessageFormatter;
use Yiisoft\Translator\Message\Php\MessageSource;
$categorySource = new CategorySource(
'my-category',
new MessageSource('/path/to/messages'),
new IntlMessageFormatter(),
);
```
The examples below are about using it separately.
### Create an instance of message source
```php
/** @var string $path - full path to your translations */
$messageSource = new \Yiisoft\Translator\Message\Php\MessageSource($path);
```
### Read a message without `yiisoft/translator` package
```php
/**
* @var \Yiisoft\Translator\Message\Php\MessageSource $messageSource
* @var ?string $translatedString
*/
$id = 'messageIdentifier';
$category = 'messageCategory';
$language = 'de-DE';
$translatedString = $messageSource->getMessage($id, $category, $language);
```
### Write an array of messages to storage
```php
/**
* @var \Yiisoft\Translator\Message\Php\MessageSource $messageSource
*/
$category = 'messageCategory';
$language = 'de-DE';
$data = [
'test.id1' => [
'message' => 'Nachricht 1', // translated string
'comment' => 'Comment for message 1', // is optional parameter for save extra metadata
],
'test.id2' => [
'message' => 'Nachricht 2',
],
'test.id3' => [
'message' => 'Nachricht 3',
],
];
$messageSource->write($category, $language, $data);
```
The following structure will be created after writing:
```
📁 path_to_your_storage
📁 de-DE
🗎 messageCategory.php
```
## Documentation
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii Translator PHP Message Storage 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)