MrMallow

# Translatable

# Installation

# Require the package and its dependencies
composer require marshmallow/translatable

# Publish the translateble config file.
php artisan vendor:publish --provider Marshmallow\\Translatable\\ServiceProvider

# Migrate the translations and translatable tables.
php artisan migrate

# Run the package installer
php artisan translatable:install
1
2
3
4
5
6
7
8
9
10
11

WARNING

Because of group by's in queries you probably need to change your database strict to false. If you get database errors during the installation, this is probebly the issue.

config/database.php 
/**
 * Please change strict mode to false in config/database.php
 */
'connections' => [
	// ...
	'mysql' => [
		// ...
	    'strict' => false,
	],
],
1
2
3
4
5
6
7
8
9
10

WARNING

Remember to call translatable:sync-missing when you add a new language so the missing translations for that language will be added to your database.

# Preparing your models

The only thing you need to do to prepare your model to use translations is adding the Translatable trait to all the models you want to be translated.

use Marshmallow\Translatable\Traits\Translatable;

class Page extends Model
{
	use Translatable;
}
1
2
3
4
5
6

# Preparing your Nova resources

The only thing you need to do to prepare your nova resources to use translations is adding the TranslatableFields trait to all the models you want to be translated and change the fields method to translatableFields. The trait you are adding implements the fields method for you. When you are not translating a resource, it will just return the fields from translatableFields to Nova so you can edit all your fields. If you are translating, it will delete all the fields that you didn't include in you translatable columns. Please check the options chapter of this documentation to checkout how you can exclude columns/fields from translations.

use Marshmallow\Translatable\Traits\TranslatableFields;

class Page extends Resource
{
	use TranslatableFields;

	//...

	public function translatableFields(Request $request)
    {
    	//
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# Using Tabs

If you are using the Eminiarts\Tabs\Tabs package you need to do some extra work to make that translatable as well. It will work out of the box, but it will show all the fields instead of only the fields you need to be available for translating. Below you will find an example of you can you make sure the Tabs will only show the fields that need translating.

return [
	TranslatableTabs::make($this, 'Page editor', [
		'Main' => [
			Text::make(__('Name'), 'name')->sortable()->rules(['required']),
			$this->getFlex(__('Layout'), 'layout'),
		],

		// ...
	])->withToolbar(),
];
1
2
3
4
5
6
7
8
9
10

# Routes

We have default routes available to use in your frontend so the user can switch there language. Use the route below to do so.

use Marshmallow\Translatable\Models\Language;
$languages = Language::get();

# In your blade file
@foreach($languages as $language)
	<a href="{{ route('set-locale', $language) }}">
		{{ $language->name }}
	</a>
@endforeach
1
2
3
4
5
6
7
8
9

# Commands

# List and fix duplicates

It could happen that you have duplicate translations in your database. If this happens the translator might show the wrong translation or no translation at all. To check if this is happening you can run de command below. This will let you know if you have duplicates and if you have them, they can be listed in a table and can be fixed.

Please not, we don't remove any duplicates if they are in fact translated. So after fixing them it could happen that there still are duplicates left. The output of this command will let you know where the duplicates are and you can dive into your database and fix them manually.

php artisan translatable:duplicates
1

# Load default translations

We have presets of translations which you can use in your projects. When you run this command, we will only translate existing translation rows in your database. We won't add any new rows. This is done this way so we don't clutter your database with unnecessary data.

# The "nl" in this example is the country code in your database.
# We will check if we have a match for that, if we don't we will
# ask you to select the correct language so we know we import the
# correct data.
php artisan translatable:preset nl

# If you don't want the command to ask you any questions you
# can add the --force option. This will do the import directly.
php artisan translatable:preset nl --force
1
2
3
4
5
6
7
8
9

# Manualy add translations

Manual translations:

$page->setTranslation('nl', 'name', 'Artikelen');

$page->setTranslation('nl', [
	'name' => 'Artikelen',
]);
1
2
3
4
5

# Options

# Excluding from translations

By default we set all columns to translatable except for the columns that are marked as producted by us. You have two options to change this behaviour. You can set the translatable columns manualy or you can keep the default behaviour and exclude more columns.

Display examples 
# In this example, we have a resource with the columns:
# id, name, slug, image, created_at

/**
 * The default behaviour
 * Translatable: name, slug and image. Id and created_at are protected by default
 */

/**
 * Set the translatable columns manualy on your model.
 * Translatable: name and slug
 */
public function translatableColumns(): array
{
    return [
        'name',
		'slug',
    ];
}

/**
 * Use the default settings but exclude columns
 * Translatable: name and image
 */
public function notTranslateColumns(): array
{
    return [
	    'slug',
	];
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# Marked as protected

protected $protected_from_translations = [
	'id',
	'created_at',
	'updated_at',
	'deleted_at',
];
1
2
3
4
5
6
Help us improve this page! 🥰

← Live update →