spatie/laravel-translatable

A trait to make an Eloquent model hold translations

A trait to make Eloquent models translatable

, _(*1)

This package contains a trait HasTranslations to make Eloquent models translatable. Translations are stored as json. There is no extra table needed to hold them., _(*2)

use Illuminate\Database\Eloquent\Model;
use Spatie\Translatable\HasTranslations;

class NewsItem extends Model
{
    use HasTranslations;

    // ...
}

After the trait is applied on the model you can do these things:, _(*3)

$newsItem = new NewsItem;
$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'

// If you want to query records based on locales, you can use the `whereLocale` and `whereLocales` methods.

NewsItem::whereLocale('name', 'en')->get(); // Returns all news items with a name in English

NewsItem::whereLocales('name', ['en', 'nl'])->get(); // Returns all news items with a name in English or Dutch

// Returns all news items that has name in English with value `Name in English` 
NewsItem::query()->whereJsonContainsLocale('name', 'en', 'Name in English')->get();

// Returns all news items that has name in English or Dutch with value `Name in English` 
NewsItem::query()->whereJsonContainsLocales('name', ['en', 'nl'], 'Name in English')->get();

// The last argument is the "operand" which you can tweak to achieve something like this:

// Returns all news items that has name in English with value like `Name in...` 
NewsItem::query()->whereJsonContainsLocale('name', 'en', 'Name in%', 'like')->get();

// Returns all news items that has name in English or Dutch with value like `Name in...` 
NewsItem::query()->whereJsonContainsLocales('name', ['en', 'nl'], 'Name in%', 'like')->get();

Support us

, _(*4)

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products., _(*5)

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall., _(*6)

Documentation

All documentation is available on our documentation site., _(*7)

Testing

composer test

Contributing

Please see CONTRIBUTING for details., _(*8)

Security

If you've found a bug regarding security please mail security@spatie.be instead of using the issue tracker., _(*9)

Postcardware

You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using., _(*10)

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium., _(*11)

We publish all received postcards on our company website., _(*12)

Credits

• Freek Van der Herten
• Sebastian De Deyne
• All Contributors

We got the idea to store translations as json in a column from Mohamed Said. Parts of the readme of his multilingual package were used in this readme., _(*13)

License

The MIT License (MIT). Please see License File for more information., _(*14)