yiisoft / translator-message-gettext
Yii Translator gettext Message Storage
Fund package maintenance!
Open Collective
yiisoft
Installs: 696
Dependents: 1
Suggesters: 0
Security: 0
Stars: 10
Watchers: 15
Forks: 7
Open Issues: 1
Requires
- php: ^8.0
- ext-gettext: *
- yiisoft/translator: ^1.0|^2.0
Requires (Dev)
- maglnet/composer-require-checker: ^4.2
- phpunit/phpunit: ^9.5
- rector/rector: ^0.14.3
- roave/infection-static-analysis-plugin: ^1.16
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.18
This package is auto-updated.
Last update: 2023-09-18 07:57:59 UTC
README
Yii Translator gettext Message Storage
The package provides message storage backend based on gettext file format to be used
with yiisoft/translator
package.
Requirements
- PHP 8.0 or higher.
gettext
PHP extension.
Installation
The package could be installed with composer:
composer require yiisoft/translator-message-gettext
Attention
When using gettext, locale
depends on your OS requirement:
- for Windows
'locale' => 'en-US.UTF-8'
- for Linux
'locale' => 'en_US.UTF-8'
General usage
The package is meant to be used with yiisoft/translator
:
use Yiisoft\Translator\CategorySource; use Yiisoft\Translator\Message\Gettext\MessageSource; $categorySource = new CategorySource( 'my-category', new MessageSource('/path/to/messages'), );
The examples below are about using it separately.
Create of instance of MessageSource
/** @var string $path - path to your gettext storage */ $messageSource = new \Yiisoft\Translator\Message\Gettext\MessageSource($path);
Read message without yiisoft/translator
package
/** * @var \Yiisoft\Translator\Message\Gettext\MessageSource $messageSource * @var ?string $translatedString */ $id = 'messageIdentificator'; $category = 'messages'; $language = 'de-DE'; $translatedString = $messageSource->getMessage($id, $category, $language);
You can create your translations in .mo format with use third-party software (for example Poedit)
Recommended structure to your gettext storage:
-- path_to_your_storage
-- de_DE
-- LC_MESSAGES
-- messages.mo
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 gettext Message Storage is free software. It is released under the terms of the BSD License.
Please see LICENSE
for more information.
Maintained by Yii Software.