https://github.com/davesweb/laravel-translatable
Add translations to Eloquent models
https://github.com/davesweb/laravel-translatable
eloquent laravel translations
Last synced: 6 months ago
JSON representation
Add translations to Eloquent models
- Host: GitHub
- URL: https://github.com/davesweb/laravel-translatable
- Owner: davesweb
- License: mit
- Created: 2021-10-21T18:44:44.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-03T19:56:55.000Z (over 4 years ago)
- Last Synced: 2025-05-24T00:50:25.357Z (about 1 year ago)
- Topics: eloquent, laravel, translations
- Language: PHP
- Homepage:
- Size: 76.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# Laravel Translatable
Add translation to Laravel Models by adding a translation model and a translation database table.
## Installation
Via composer
```shell
composer require davesweb/laravel-translatable
```
## Configuration
- Add the `Davesweb\LaravelTranslatable\Traits\HasTranslations` trait to the model you want to translate.
- Create a translation model which holds the translatable attributes, but instead of extending the Laravel `Model`
class, extend the `Davesweb\LaravelTranslatable\Models\TranslationModel` class.
- Create a migration to create the database table for your translation model.
There are also commands available for generating these models and migrations for you.
As long as the names of the translation model and the foreign key column follow the naming conventions, the
package will automatically find the correct models and set the correct relations.
The name of the translation model should be the same as the model that is being translated with the suffix
`Translation`, for example `App\Page` and `App\PageTranslation`.
The name of the foreign key column should be the name of the model that is being translated in snake case,
suffixed with the name of the primary key. For instance `page_id`.
If your model names differ from te naming convention you can specify them yourself on the models. For the
model to be translated, add a `$translation` property.
```php
findOrFail(1);
$translations = $page->getTranslations();
```
In order to optimize your database calls you should eager-load your translations:
```php
with('translations')->findOrFail(1);
$translations = $page->getTranslations();
```
Or load only the translation in the locale you want:
```php
whereHas('translations', function(Builder $query) use ($locale) {
$query->where('locale', '=', $locale);
})->findOrFail(1);
$translations = $page->getTranslations();
```
You can fetch a single translation by calling `getTranslation('locale')`.
```php
with('translations')->findOrFail(1);
$englishTranslation = $page->getTranslation('en');
$dutchTranslation = $page->getTranslation('nl');
```
To get the translation in the current locale the app is in you can call `translation()`.
```php
setLocale('en');
$page = App\Page::query()->with('translations')->findOrFail(1);
$englishTranslation = $page->translation();
```
To get the value of a translated attribute in the current locale the app is in you can call `translate('attribute')`.
```php
setLocale('en');
$page = App\Page::query()->with('translations')->findOrFail(1);
$englishTitle = $page->translate('title');
```
To get the value of a translated attribute in a different locale then the current app locale is in you can call
`translate('attribute', 'locale')` with the desired locale.
```php
setLocale('en');
$page = App\Page::query()->with('translations')->findOrFail(1);
$dutchTitle = $page->translate('title', 'nl');
```
### Saving translations
Saving a translation is done just like any other Laravel Model. Set the attributes on the TranslationModel in your
preferred way, then save it to the model by calling `$page->translations()->save($pageTranslation);`
## Artisan commands
There are three command available for this package:
```shell
php artisan make:translatable {name}
```
This command creates a new Model class with the given {name} and the `HasTranslations` trait already set.
This command has a few options as well:
- `-t` or `--translation`: Adding this will also make a TranslationModel class for the model.
- `-m` or `--migration`: Adding this will also make a migration for both the model and the TranslationModel
- `-a` or `-all`: Use all available options.
```shell
php artisan make:translation {name}
```
This command creates a new TranslationModel class with the given {name}.
```shell
php artisan make:translatable-migration {name}
```
This command creates a new migration with both the model and translation model migrations for the given {name}. The
{name} should be the classname of the model, for instance `App\Page`.
## Testing
To run the testsuite, simply run
```shell
docker-compose exec app composer test
```
## Code style
This package uses PHP CS Fixer to enforce code style. To run it, run
```shell
docker-compose exec app composer cs-fixer
```
## License
This package is licensed under the MIT license, which basically means you can do whatever your want with this package.
However, if you found this package useful, please consider buying me a beer or subscribing to premium email support
over on [Patreon](https://www.patreon.com/davesweb), it's really appreciated!