systemovich / laravel-translatable
A trait to make an Eloquent model hold translations
Requires
- php: ^5.6|^7.0
- illuminate/database: ~5.2.0|~5.3.0|~5.4.0
- illuminate/support: ~5.2.0|~5.3.0|~5.4.0
Requires (Dev)
- mockery/mockery: ^0.9.4
- orchestra/testbench: ~3.3.0|~3.4.0
- phpunit/phpunit: 5.*
README
Fork: This package was forked from spatie/laravel-translatable in order to make it compatible with PHP 5.6. This excludes the tests code.
A trait to make Eloquent models translatable
This package contains a trait to make Eloquent models translatable. Translations are stored as json. There is no extra table needed to hold them.
Once the trait is installed on the model you can do these things:
$newsItem = new NewsItem; // This is an Eloquent model $newsItem ->setTranslation('name', 'en', 'Name in English') ->setTranslation('name', 'nl', 'Naam in het Nederlands') ->save(); $newsItem->name; // Returns 'Name in English' given that the current app locale is 'en' $newsItem->getTranslation('name', 'nl'); // returns 'Naam in het Nederlands' app()->setLocale('nl'); $newsItem->name; // Returns 'Naam in het Nederlands'
Postcardware
You're free to use this package (it's MIT-licensed), but if it makes it to your production environment we highly appreciate your sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
All postcards are published on our website.
Installation
You can install the package via composer:
composer require spatie/laravel-translatable
Next up, the service provider must be registered:
// config/app.php 'providers' => [ ... Spatie\Translatable\TranslatableServiceProvider::class, ];
If you want to change add fallback_locale, you must publish the config file:
php artisan vendor:publish --provider="Spatie\Translatable\TranslatableServiceProvider"
This is the contents of the published file:
return [ 'fallback_locale' => 'en', ];
Making a model translatable
The required steps to make a model translatable are:
- First you need to add the
Spatie\Translatable\HasTranslations
-trait. - Next you should create a public property
$translatable
which holds an array with all the names of attributes you wish to make translatable. - Finally you should make sure that all translatable attributes are set to the
text
-datatype in your database. If your database supportsjson
-columns, use that.
Here's an example of a prepared model:
use Illuminate\Database\Eloquent\Model; use Spatie\Translatable\HasTranslations; class NewsItem extends Model { use HasTranslations; public $translatable = ['name']; }
Available methods
Getting a translation
The easiest way to get a translation for the current locale is to just get the property for the translated attribute.
For example (given that name
is a translatable attribute):
$newsItem->name;
You can also use this method:
public function getTranslation(string $attributeName, string $locale) : string
This function has an alias named translate
.
Setting a translation
public function setTranslation(string $attributeName, string $locale, string $value)
To actually save the translation, don't forget to save your model.
$newsItem->setTranslation('name', 'en', 'Updated name in English'); $newsItem->save();
Forgetting a translation
public function forgetTranslation(string $attributeName, string $locale)
Getting all translations in one go
public function getTranslations(string $attributeName) : array
Setting translations in one go
public function setTranslations(string $attributeName, array $translations)
Here's an example:
$translations = [ 'en' => 'Name in English', 'nl' => 'Naam in het Nederlands' ]; $newsItem->setTranslations('name', $translations);
Events
TranslationHasBeenSet
Right after calling setTranslation
the Spatie\Translatable\Events\TranslationHasBeenSet
-event will be fired.
It has these properties:
/** @var \Illuminate\Database\Eloquent\Model */ public $model; /** @var string */ public $attributeName; /** @var string */ public $locale; public $oldValue; public $newValue;
Creating models
You can immediately set translations when creating a model. Here's an example:
NewsItem::create([ 'name' => [ 'en' => 'Name in English' 'nl' => 'Naam in het Nederlands' ], ]);
Querying translatable attributes
If you're using MySQL 5.7 or above, it's recommended that you use the json data type for housing translations in the db. This will allow you to query these columns like this:
NewsItem::whereRaw('name->"$.en" = \'Name in English\'')->get();
In laravel 5.2.23 and above you can use the fluent syntax:
NewsItem::where('name->en', 'Name in English')->get();
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.
Credits
We got the idea to store translations as json in a column from Mohamed Said. Parts of the readme of his multiligual package were used in this readme.
About Spatie
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
License
The MIT License (MIT). Please see License File for more information.