Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s-shiryaev/laravel-translatable
Trait for implementing model localization
https://github.com/s-shiryaev/laravel-translatable
eloquent laravel laravel-package localization lumen model php translate
Last synced: about 1 month ago
JSON representation
Trait for implementing model localization
- Host: GitHub
- URL: https://github.com/s-shiryaev/laravel-translatable
- Owner: s-shiryaev
- License: mit
- Created: 2021-07-14T18:30:04.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-06-30T16:29:17.000Z (over 1 year ago)
- Last Synced: 2023-08-06T20:04:28.013Z (over 1 year ago)
- Topics: eloquent, laravel, laravel-package, localization, lumen, model, php, translate
- Language: PHP
- Homepage:
- Size: 41 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Trait for implementing model localization
[](https://packagist.org/packages/s-shiryaev/laravel-translatable)
[](https://github.com/s-shiryaev/laravel-translatable/actions/workflows/run-tests.yml)
[](https://github.com/s-shiryaev/laravel-translatable/actions/workflows/php-cs-fixer.yml)
[](https://packagist.org/packages/s-shiryaev/laravel-translatable)
This package contains a trait to make it easier to work with translating Eloquent models.
## Installation
You can install the package via composer:
```bash
composer require s-shiryaev/laravel-translatable
```
## Version Compatibility
| Laravel/Lumen | Package |
|:-------------:|:-------:|
| 7.x | 1.x |
| 8.x | 1.x |
| 9.x | 1.x |
| 10.x | 2.x |
## Usage
Just add the `SShiryaev\LaravelTranslatable\Translatable` trait to the model and create a property `translatable`, which holds an array with all the names of attributes you wish to make translatable:
```php
'Доллар', 'name_en' => 'Dollar']);
echo $currency->name; //Доллар
```
Also, when converting a model and their eloquent collection to an array (for example, in presenters), field values will be returned according to the application locale:
```php
App::setLocale('ru');
$currency = Currency::find(1);
$currency->toArray(); //['name' => 'Доллар', 'name_en' => 'Dollar']
$currencies = Currency::all();
$currencies->toArray(); //[0 => ['name' => 'Доллар', 'name_en' => 'Dollar']]
```
Sometimes, when converting to an array, you need to get the original fields of the model without translation. This can be done by passing an optional parameter in the `toArray()` method:
```php
$currency = Currency::find(1);
$currency->toArray(false); //['name_ru' => 'Доллар', 'name_en' => 'Dollar']
$currencies = Currency::all();
$currencies->toArray(false); //[0 => ['name_ru' => 'Доллар', 'name_en' => 'Dollar']]
```
Translation also works with relationships.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Sergey Shiryaev](https://github.com/s-shiryaev)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.