zoomyboy/laravel-translatable

A trait to make an Eloquent model hold translations

A trait to make Eloquent models translatable

, _(*1)

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

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

$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., _(*4)

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium., _(*5)

All postcards are published on our website., _(*6)

Installation

You can install the package via composer:, _(*7)

``` bash composer require spatie/laravel-translatable, <sub>(*8)</sub>

The package will automatically register itself.

If you want to change add fallback_locale, you must publish the config file:

php artisan vendor:publish --provider="Spatie\Translatable\TranslatableServiceProvider", <sub>(*9)</sub>

This is the contents of the published file:
```php
return [
  'fallback_locale' => 'en',
];

Making a model translatable

The required steps to make a model translatable are:, <sub>(*10)</sub>

• 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 supports json-columns, use that.

Here's an example of a prepared model:, <sub>(*11)</sub>

``` php use Illuminate\Database\Eloquent\Model; use Spatie\Translatable\HasTranslations;, <sub>(*12)</sub>

class NewsItem extends Model { use HasTranslations;, <sub>(*13)</sub>

public $translatable = ['name'];

}, <sub>(*14)</sub>

### 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):

```php
$newsItem->name;

You can also use this method:, <sub>(*15)</sub>

public function getTranslation(string $attributeName, string $locale) : string

This function has an alias named translate., <sub>(*16)</sub>

Setting a translation

``` php public function setTranslation(string $attributeName, string $locale, string $value), <sub>(*17)</sub>

To actually save the translation, don't forget to save your model.

```php
$newsItem->setTranslation('name', 'en', 'Updated name in English');

$newsItem->save();

Forgetting a translation

You can forget a translation for a specific field: ``` php public function forgetTranslation(string $attributeName, string $locale), <sub>(*18)</sub>

You can forget all translations for a specific locale:
``` php
public function forgetAllTranslations(string $locale)

Getting all translations in one go

``` php public function getTranslations(string $attributeName): array, <sub>(*19)</sub>

#### Setting translations in one go

``` php
public function setTranslations(string $attributeName, array $translations)

Here's an example:, <sub>(*20)</sub>

``` php $translations = [ 'en' => 'Name in English', 'nl' => 'Naam in het Nederlands' ];, <sub>(*21)</sub>

$newsItem->setTranslations('name', $translations);, <sub>(*22)</sub>

### Events

#### TranslationHasBeenSet
Right after calling `setTranslation` the `Spatie\Translatable\Events\TranslationHasBeenSet`-event will be fired.

It has these properties:
```php
/** @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:, <sub>(*23)</sub>

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:, <sub>(*24)</sub>

NewsItem::where('name->en', 'Name in English')->get();

Using translations in json responses

The easiest way to add translations to json reponse is to override the toArray method on your model., <sub>(*25)</sub>

Here's a quick example:, <sub>(*26)</sub>

``` php // in your model, <sub>(*27)</sub>

/**
 * Convert the model instance to an array.
 *
 * @return array
 */
public function toArray()
{
    $attributes = parent::toArray();

    foreach ($this->getTranslatableAttributes() as $name) {
        $attributes[$name] = $this->getTranslation($name, app()->getLocale());
    }

    return $attributes;
}

}, <sub>(*28)</sub>

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

```bash
$ composer test

Contributing

Please see CONTRIBUTING for details., <sub>(*29)</sub>

Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker., <sub>(*30)</sub>

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 multiligual package were used in this readme., <sub>(*31)</sub>

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., <sub>(*32)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*33)</sub>