Add multilingual

[marktopper]

Progress:

• Add translations migration
• Add Translatable trait
• Add method to get translated value
• Add method to translate the whole model
• Enable saving directly to the translator
• Enable checking if a model is translatable
• Create view to input translated values (Feature/multilangual #873)
• Make method to get original model from translator
• Make method to create translation
• Make method to update translation
• Make method to delete translation
• Make method to get meta data for translation
• ~Make method to get rows that have translations~~ (can come later as a PR)
• ~Make method to get rows that does not have translations~~ (can come later as a PR)
• Make tests
• Turn this into a plugin for Voyager (Cancelled)

Setup:

In order to use this multilingual, you must set some extra languages in the configuration. It will not work where there are only the default language.

Then you must ensure that the models you wish to use the multilingual support for have the TCG\Voyager\Translatable trait.
Along with that you must define the translatable attributes in the model as so

class Page extends Model
{
    protected $translatable = ['title', 'body'];
}

Usage:

Eager load translations

// Loads all translations
$posts = Post::with('translations')->get();

// Loads all translations
$posts = Post::all();
$posts->load('translations');

// Loads all translations
$posts = Post::withTranslations()->get();

// Loads specific locales translations
$posts = Post::withTranslations(['en', 'da'])->get();

// Loads specific locale translations
$posts = Post::withTranslation('da')->get();

// Loads current locale translations
$posts = Post::withTranslation('da')->get();

Get default language value

echo $post->title;

Get translated value

echo $post->getTranslatedAttribute('title', 'locale', 'fallbackLocale');

If you do not define locale, the current application locale will be used. You can pass in your own locale as a string.
If you do not define fallbackLocale, the current application fallback locale will be used. You can pass in your own locale as a string. If you want to turn the fallback locale off, pass false.
If no values are found, null is returned.

Translate the whole model

$post = $post->translate('locale', 'fallbackLocale');
echo $post->title;
echo $post->body;

// You can also run the `translate` method on the Eloquent collection
// to translate all models in the collection.
$posts = $posts->translate('locale', 'fallbackLocale');
echo $posts[0]->title;

If you do not define locale, the current application locale will be used. You can pass in your own locale as a string.
If you do not define fallbackLocale, the current application fallback locale will be used. You can pass in your own locale as a string. If you want to turn the fallback locale off, pass false.
If no values are found for the model for a specific attribute, either for the locale or the fallback, it will set that attribute to null.

Check if model is translatable

// with string
if (Voyager::translatable(Post::class)) {
    // it's translatable
}

// with object of Model or Collection
if (Voyager::translatable($post)) {
    // it's translatable
}

Save changes

$post = $post->translate('da');
$post->title = 'foobar';
$post->save();

This will update or create the translation for title the post with the locale da.
Please note that if a modified attribute is not translatable, then it will make the changes directly to the model itself. Meaning that it will overwrite the attribute in the language set as default.

Feedback, questions and pull requests are more than welcome.

[marktopper]

UPDATE: Added new ways to eager load translations.

[marktopper]

UPDATE: You can now translate a Eloquent Collection like this.

$posts = Post::all()->translate('locale');
echo $posts[0]->title; // is now translated

You can also make modifications to the translated models and save them as translations like this.

$post = Post::first()->translate('locale');
$post->title = 'test';
$post->save();

Please note that if a modified attribute is not translatable, then it will make the changes directly to the model itself. Meaning that it will overwrite the attribute in the language set as default.

[marktopper]

UPDATE: You can now use the Voyager facade to check if a object or classname is translatable.

// with string
if (Voyager::translatable(Post::class)) {
    // it's translatable
}

// with object of Model or Collection
if (Voyager::translatable($post)) {
    // it's translatable
}

[akazorg]

Hi @Steve-sy, have you setup the config voyager.php and followed the instructions from docs?
If you can't sort that out, please open a new issue and we will help you.
Thanks.

[coppee]

Hello there,
Just to be clear, the final translation system choice is to use a specific table, no the json solution ?
And btw, thanks for all your great work !

[marktopper]

@coppee We use the database for the BREAD translations but will use PHP files for the views-translations.

[coppee]

Hi @marktopper , thanks for your reply. Sorry, I was not clear enough in my question. I was talking about the other translation eloquent solution (use json in fields) proposed by @akazorg like : https://github.com/spatie/laravel-translatable

[akazorg]

Hi @coppee Voyager is using the extra table approach, not the JSON one.
It works great this way.

[vitorbrussi]

Hello, I am new not Voyager, not understood how to translate to pt_br.
They could pass me one step at a time. Thank you.

[akazorg]

Hi @vitorbrussi, check this #1364.

[vitormicillo]

It would be very interesting if there was the possibility of having a auto-translator when a locale is defined, and return the translated data In fields that have translation

[akazorg]

That's a nice idea @vitormicillo, we should work on that.

[vitormicillo]

I created a not very elegant method but it works to auto translate the specific words

private function translatedCollectionToArray(\TCG\Voyager\Translator\Collection $translatedCollection) {
        $dateFields = [ 'created_at', 'updated_at', 'deleted_at' ];
        $collectionArray = array();
        foreach($translatedCollection as $collectionElement)
        {
            $collectionArray[] = array_map(function($rawAttributeData) { return $rawAttributeData['value']; }, $collectionElement->getRawAttributes());
        }
        foreach($collectionArray as $i => $collectionElement)
        {
            foreach($collectionElement as $elementKey => $elementValue)
            {
                if(!in_array($elementKey, $dateFields) || $elementValue == null) { continue; }
                $collectionArray[$i][$elementKey] = strtotime($elementValue);
            }
        }
        return $collectionArray;
    }

[vitormicillo]

This method recycles the use of the '\TCG\Voyager\Translator\Collection'
And stamps the dates in timestamp
I hope to help a little, to run it just send in the header your locale
and to call this methodo:
I'm using: 'Sections' => $this->translatedCollectionToArray(Section::all()->translate($language, 'fallbackLocale')),

$language = $request->header('locale');
Section::all() You can modify to Post::all() to try or Category::all()

[DODMax]

Really great work on this multilingual feature!

I'm trying to think of a way to use it to store my Laravel translations (like in https://github.com/Waavi/translation but I'd like to avoid using a different package/ UI)

So basically I'm with my translation files that look something like this

'date' => 'Payment date: :date',
'amount' => 'Amount: :amount :currency',
'plan' => 'Plan: :plan',
'from' => 'From: :date',
'to' => 'To: :date',

And I'm thinking of adding a labels table with my key and label columns, making it translatable then having a class a bit like this:

class VoyagerTranslator extends Illuminate\Translation\Translator
{
	private $labels = null;

	public function get($key, array $replace = [], $locale = null, $fallback = true)
	{
		$lang = $this->getLabel($key);

		if ($lang && ($line = $lang->getTranslatedAttribute('label', $locale, false))) {
			return $this->makeReplacements($line, $replace);
		} else {
			return parent::get($key, $replace, $locale, $fallback);
		}
	}

	protected function getLabel($key)
	{
		if ($this->labels == null) {
			$this->labels = \App\Label::with('translations')->get();
		}

		return $this->labels->where('key', $key)->first();
	}
}

Any thoughts? Thanks!

EDIT: Ok after some edits this seems to work well: this will use Voyager's translation from DB if present otherwise fall back to Laravel language files (once registered with the proper service provider of course).

[vitormicillo]

I created a method to use the translations

private function translatedCollectionToArray(\TCG\Voyager\Translator\Collection $translatedCollection) {
    $collectionArray = array();
    foreach($translatedCollection as $collectionElement)
    {
        $collectionArray[] = array_map(function($rawAttributeData) { return $rawAttributeData['value']; }, $collectionElement->getRawAttributes());
    }
    return $collectionArray;
}

and to use:

Ex.

$language = $request->header('locale');
if($language == null || $language !== "it"){$language = "en";}
$section = $this->translatedCollectionToArray(Posts::all()->translate($language, 'fallbackLocale'));

works fine for me to use in translating api, I hope it helps many

[sergbbb]

Please include this guide in Documentation. It is hard to find it. Thank you.

[yarokov]

Hi! How can I hide the not translated posts?

[fadighattas100]

Hi, any video tutorial for how to do this like in the gif's images? how to translate the post's content , thanks in advance.

[PointfullDevelopers]

I tried to implement this, but no luck.

1. When I add ['en' => 'English', 'sv' => 'Swedish'], to the 'locale' on the config it gives error.
2. There is no Model for Posts and Pages so, where do I make those changes?

Please update your documentation

[amrittb]

It seems that I can't translate the entire model and other loaded models using Eloquent relationships using the above methods. Any chance of support on this?

[emptynick]

Certainly. But you have to give more informations.
And please ask questions in our Slack group!

[sten]

Hiu @marktopper, you mentioned about a year ago that you wanted to make the translation library in voyager configurable: "About the extra table, I just wanted to let it be flexible. However I can make it extendable so that people can easily make it into JSON instead and remove the translations table."

Is the current implementation configurable? Could you point me to how you would replace the current translation implementation with for instance the one from Spatie: spatie/laravel-translatable

Thanks!

[AlexanderWM]

@marktopper Any ideas how to fix #3089 ?

[fletch3555]

@AlexanderWM, this PR has been merged. 3089 would be a much better place to ask that question