aegued/laravel-translations

Create translations of the fields of a Model and save them in the database

v1.04 2025-05-19 20:46 UTC

Requires

• php: >=5.6.4

Requires (Dev)

• phpunit/phpunit: ~5.0

MIT

• Alfredo

README

It's a Laravel model columns translation manager

Installation

You can install the package via composer:

composer require aegued/laravel-translations

If you have Laravel 5.5 and up The package will automatically register itself.

else you have to add the service provider to app/config/app.php

Aegued\LaravelTranslations\LaravelTranslationsServiceProvider::class,

If you want to change the default locale, you must publish the config file:

php artisan vendor:publish --provider="Aegued\LaravelTranslations\LaravelTranslationsServiceProvider"

This is the contents of the published file:

return [

   /**
    * Default Locale || Root columns locale
    * We will use this locale if config('app.locale') translation not exist
    */
   'locale' => 'en',

   /**
    * Supported Locales e.g: ['en', 'es', 'fr']
    */
   'locales' => ['es', 'en', 'fr']

];

next migrate translations table

php artisan migrate

Making a model translatable

The required steps to make a model translatable are:

• Just use the Aegued\LaravelTranslations\Translatable trait.

Here's an example of a prepared model:

use Illuminate\Database\Eloquent\Model;
use Aegued\LaravelTranslations\Translatable;

class Item extends Model
{
    use Translatable;

    /**
      * The attributes that are Translatable.
      *
      * @var array
      */
    protected $translatable = [
        'name', 'color'
    ];
}

Available methods

Saving translations

$item = new Item;
$data = array('en' => 'car', 'es' => 'coche');

$item->setTranslations('name', $data); // setTranslations($attribute, array $translations, $save = false)

// or save one translation
$item->setTranslation('name', 'en', 'car', true); // setTranslation($attribute, $locale, $value, $save = false)

// or just do
$item->name = 'car'; // note: this will save automaticaly unless it's the default locale

// This will save if (current locale == default locale OR $save = false)
$item->save();

Get translations

$item = new Item::first();
// get current locale translation
$item->city
OR
$item->getTranslation('city');

// pass translation locales
$item->getTranslation('city', 'es'); // getTranslation($attribute, $language = null, $fallback = true)
$item->getTranslationsOf('name', ['es', 'en']); // getTranslationsOf($attribute, array $languages = null, $fallback = true)

Delete translations

$item = new Item::first();
$item->deleteTranslations(['name', 'color'], ['es', 'en']); // deleteTranslations(array $attributes, $locales = null)