README

Store translation items in your local database using Eloquent.

Install

First install the latest version of our package.

composer require tingo-gmbh/eloquent-translatable

Next we publish the migration and config files.

php artisan vendor:publish --provider="Tingo\Translatable\TranslatableServiceProvider" --tag="migrations"

Usage

Model

Add the Translatable trait to your Eloquent model and specify all translatable attributes.

<?php

namespace Tingo\Translatable\Tests\Models;

use Illuminate\Database\Eloquent\Model;
use Tingo\Translatable\Translatable;

class Entity extends Model
{
    use Translatable;

    /**
     * The attributes that are mass assignable.
     *
     * @var array<int, string>
     */
    protected $fillable = [
        'name',
        'category',
        'description',
        'unit',
        'price',
    ];

    /**
     * The attributes that are translatable.
     *
     * @var array<string>
     */
    protected array $translatable = [
        'name',
        'category',
        'description',
    ];
}

Create

Create a new translation:

$entity = Entity::create([
    'name' => 'Foo Entity',
    'category' => 'foo',
    'description' => 'This is my awesome entity!',
]);
$entity->createTranslation('name', 'Foo Entität', 'de');
$entity->createTranslation('name', 'L\'entité foo', 'fr');

Update

A locale must always be passed as an argument, otherwise nothing will be updated.

$entity->updateTranslation('name', 'Aktualisierte Foo Entität', 'de');

Get

Finally, can return your translations in your Resources or anywhere else in your code.

echo $entity->getTranslation('name', 'de');
// Foo Entität
echo $entity->getTranslation('name', 'fr');
// L\'entité foo

Get all

If you do not provide a language, the package will use the default locale of your Laravel app. This is especially useful when passing locales as a request header to your API end points.

App::setLocale('it');
$entity->createTranslation('name', 'Entità di Foo');
echo $entity->getTranslation('name');
// Entità di Foo

If you want to get all translations for a specific model, use the getTranslations() method. This will return translations of all attributes defined in the $translatable array.

var_dump($entity->gatTranslations())
//  [
//      'name' =>  [
//          'default' => 'Foo Entity',
//          'de' => 'Foo Entität',
//          'fr' => 'L\'entité foo',
//      ], 
//      ...
//  ]

Delete

A locale must always be passed as an argument, otherwise nothing will be deleted.

$entity->deleteTranslation('name', 'de');

Spatie

There is very similar package made by Spatie. https://github.com/spatie/laravel-translatable

License

The MIT License (MIT). Please see License File for more information.

tingo-gmbh / eloquent-translatable

Maintainers

Details