This is a Laravel 4 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.
If you want to store translations of your models into the database, this package is for you.
Getting translated attributes
$country = Country::where('iso', '=', 'gr')->first();
echo $country->translate('en')->name; // Greece
App::setLocale('en');
echo $country->name; // Greece
App::setLocale('de');
echo $country->name; // GriechenlandSaving translated attributes
$country = Country::where('iso', '=', 'gr')->first();
echo $country->translate('en')->name; // Greece
$country->translate('en')->name = 'abc';
$country->save();
$country = Country::where('iso', '=', 'gr')->first();
echo $country->translate('en')->name; // abcFilling multiple translations
$data = array(
'iso' => 'gr',
'en' => array('name' => 'Greece'),
'fr' => array('name' => 'Grèce'),
);
$country = Country::create($data);
echo $country->translate('fr')->name; // GrèceAdd the package in your composer.json file and run composer update.
{
"require": {
"dimsav/laravel-translatable": "4.3.*"
}
}Let's say you have a model Country. To save the translations of countries you need one extra table country_translations.
Create your migrations:
Schema::create('countries', function(Blueprint $table)
{
$table->increments('id');
$table->string('iso');
$table->timestamps();
});
Schema::create('country_translations', function(Blueprint $table)
{
$table->increments('id');
$table->integer('country_id')->unsigned();
$table->string('name');
$table->string('locale')->index();
$table->unique(['country_id','locale']);
$table->foreign('country_id')->references('id')->on('countries')->onDelete('cascade');
});The models:
- The translatable model
Countryshould use the traitDimsav\Translatable\Translatable. - The convention for the translation model is
CountryTranslation.
// models/Country.php
class Country extends Eloquent {
use \Dimsav\Translatable\Translatable;
public $translatedAttributes = array('name');
protected $fillable = ['iso', 'name'];
}
// models/CountryTranslation.php
class CountryTranslation extends Eloquent {
public $timestamps = false;
protected $fillable = ['name'];
}The array $translatedAttributes contains the names of the fields being translated in the "Translation" model.
Optionally, edit the default locale.
// app/config/app.php
return array(
// Just enter this array somewhere near your default locale
'locales' => array('en', 'fr', 'es'),
// The default locale
'locale' => 'en',
// Override the default 'Translation' class suffix
// to use CountryTrans instead of CountryTranslation
'translatable_suffix' => 'Trans'
);Note: There isn't any restriction for the format of the locales. Feel free to use whatever suits you better, like "eng" instead of "en", or "el" instead of "gr". The important is to define your locales and stick to them till the end.
Laravel versions 4.0, 4.1 and 4.2 play nice with the package.
Got any question or suggestion? Feel free to open an Issue.
You are awesome! Watched the repo and reply to the issues. You will help offering a great experience to the users of the package. #communityWorks
Translatable is fully compatible with all kinds of Eloquent extensions, including Ardent. If you need help to implement Translatable with these extensions, see this example.
If you see the following mysql error:
[Illuminate\Database\QueryException]
SQLSTATE[HY000]: General error: 1005 Can't create table 'my_database.#sql-455_63'
(errno: 150) (SQL: alter table `country_translations`
add constraint country_translations_country_id_foreign foreign key (`country_id`)
references `countries` (`id`) on delete cascade)
Then your tables have the MyISAM engine which doesn't allow foreign key constraints. MyISAM was the default engine for mysql versions older than 5.5. Since version 5.5, tables are created using the InnoDB storage engine by default.
For tables already created in production, update your migrations to change the engine of the table before adding the foreign key constraint.
public function up()
{
DB::statement('ALTER TABLE countries ENGINE=InnoDB');
}
public function down()
{
DB::statement('ALTER TABLE countries ENGINE=MyISAM');
}For new tables, a quick solution is to set the storage engine in the migration:
Schema::create('language_translations', function(Blueprint $table){
$table->engine = 'InnoDB';
$table->increments('id');
// ...
});The best solution though would be to update your mysql version. And always make sure you have the same version both in development and production environment!
- The
Translationclass suffix default can be overridden in the app config. See 7ecc0a75d - The
app.fallback_localesetting can be overridden in each model separately. See #33 - Fallback translation is not returned if it is not defined.
- Fallback locale now is taken from
app.fallback_localeconfig key.
- Fixed issue with saving translations, caused by the update of the laravel core.
- Added fallback to default locale if translations is missing.
- Added travis environment for laravel 4.2.
- Removed syntax
$model->en->namebecause conflicts may happen if the model has a property nameden. See #18. - Added method
hasTranslation($locale). See #19.
- Fixed bug #7. Model's Translations were deleted when the model delete failed.
- Translatable is now a trait and can be used as add-on to your models.
- 100% code coverage
- Initial version
- Translatable is a class extending Eloquent
- 96% code coverage