Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elaborate-code/php-json-tongue
📦🌐 A Façade for loading localization data from a folder tree of JSON files
https://github.com/elaborate-code/php-json-tongue
agnostic internationalization json languages library locale localization php php8 translation
Last synced: about 1 month ago
JSON representation
📦🌐 A Façade for loading localization data from a folder tree of JSON files
- Host: GitHub
- URL: https://github.com/elaborate-code/php-json-tongue
- Owner: elaborate-code
- License: mit
- Created: 2022-09-21T13:03:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-30T14:52:20.000Z (about 2 years ago)
- Last Synced: 2024-09-18T02:29:27.181Z (4 months ago)
- Topics: agnostic, internationalization, json, languages, library, locale, localization, php, php8, translation
- Language: PHP
- Homepage: https://packagist.org/packages/elaborate-code/php-json-tongue
- Size: 106 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PHP JSON tongue
[](https://packagist.org/packages/elaborate-code/php-json-tongue)
[](https://github.com/elaborate-code/php-json-tongue/actions/workflows/run-tests.yml)
[](https://github.com/elaborate-code/php-json-tongue/actions/workflows/fix-php-code-style-issues.yml)
A Façade for loading localization data from a folder tree of JSON files.
## Get started
Install the package with composer:
```text
composer require elaborate-code/php-json-tongue
```
Requirements:
- PHP 8.0 or higher
## Usage
Set the file structure.
Then use the facade.
```php
use ElaborateCode\JsonTongue\TongueFacade;
$tongue = new TongueFacade('/lang');
$localization = $tongue->transcribe();
```
`$localization` will be set like:
```php
$localization = [
"es" => [
"programmer" => "programador",
"interviewer" => "entrevistador",
"Hello" => "Hola",
"Good morning" => "buenos dias",
//...
],
"fr" => [
"Hello" => "Salut",
"Good morning" => "Bonjour",
//...
]
//...
];
```
## Testing
```bash
vendor/bin/pest
```
### JSON Faker
Just like when testing Laravel apps, we populate the database temporarily and use the `RefreshDatabase` trait to rollback the database to its fresh state.
This package ships with `ElaborateCode\JsonTongue\JsonFaker\JsonFaker` class that helps create a temporary tree of **locale folders** and **JSON files** filled with translations.
Here is an example:
```php
$json_faker = JsonFaker::make()
->addLocale('ar', [
'ar.json' => [],
])
->addLocale('en', [
'en.json' => [
'en' => 'en',
"I know. They're both good. It's hard to decide. McCain is older but he has more experience. Obama seems to have a lot of good ideas, but some people say he wants to raise taxes." => 'Lo sé. Ambos son buenos. Es difícil decidir. McCain es mayor pero tiene más experiencia. Obama parece tener muchas buenas ideas, pero algunas personas dicen que quiere aumentar los impuestos.',
],
'one.json' => [
'one' => 'one',
],
'two.json' => [
'two' => 'two',
],
])
->addLocale('multi', [
'greetings.json' => [
'en' => [
'Hello' => 'Hello',
],
'fr' => [
'Hello' => 'Salut',
],
],
])
->write();
// Assert
$json_faker->rollback(); // Delete the complete file structure created for the test
```
> This class can help make tests when contributing on this package or when using this package.
## Changelog
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.