README

If you want the faster way to translate your model and store it in a single table, this package is built for you.

This is a Laravel package for translatable models. Its goal is to remove the complexity in retrieving and storing multilingual model instances. With this package you write less code, as the translations are being fetched/saved when you fetch/save your instance.

Maybe out there there's so many package that work the same way, and has more performance, but the purpose this package is make your development time faster.

This package is still in alpha version, so the update may broke your application.

Installation

composer require konnco/laravel-transeloquent

php artisan vendor:publish

php artisan migrate

Configuration

you can find transeloquent configuration here. config/transeloquent.php

return [
    // default locale
    'locale' => 'en',
    
    // transeloquent model
    'model' => Konnco\Transeloquent\models\Transeloquent::class
];

Add transeloquent traits into your model

namespace App;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class News extends Model {
    use \Konnco\Transeloquent\Transeloquent;
}

and the default excluded field is id, created_at, updated_at, deleted_at these fields will not saved into database.

if you want to add only some fields to be translated, you may have to add $translateOnly into your model.

namespace App;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
use Konnco\Transeloquent\Transeloquent;

class News extends Model {
    use Transeloquent;
    
    protected $translateOnly = ['translate-field-1', 'translate-field-2'];
}

if you want to add more excluded field from translated, you may have to add $translateExcept into your model.

namespace App;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
use Konnco\Transeloquent\Transeloquent;

class News extends Model {
    use Transeloquent;
    
    protected $translateExcept = ['dont-translate-1', 'dont-translate-2'];
}

Note : If you have set $translateOnly variable, it will be executed first. Make sure you don't use $translateOnly variable in your model if you want to use $translateExcept variable.

Quick Example

Getting translated attributes

Original Attributes In English or based on configuration in app.transeloquent.default_locale

//in the original language
$post = Post::first();
echo $post->title; // My first post

Translated attributes

App::setLocale('id');
$post = Post::first();
echo $post->title; // Post Pertama Saya

Saving translated attributes

To save translation you must have the initial data.

for example you want to save indonesian translation.

App::setLocale('id');
$post = Post::first();
$post->title = "Post Pertama Saya";
$post->save();

// or set locale for specific model

$post = Post::first();
$post->setLocale('id')
$post->title = "Post Pertama Saya";
$post->save();

Checking if Translation Available

$post = Post::first();
$post->translationExist('id'); //return boolean

Authors

Franky So - Initial work - Konnco
Rizal Nasution - Initial work - Konnco

konnco / laravel-transeloquent

Maintainers

Details