Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/spatie/laravel-translatable

Making Eloquent models translatable
https://github.com/spatie/laravel-translatable

eloquent i18n laravel php translated-attributes

Last synced: 3 months ago
JSON representation

Making Eloquent models translatable

Lists

README 

        
# A trait to make Eloquent models translatable



[![Latest Version on Packagist](https://img.shields.io/packagist/v/spatie/laravel-translatable.svg?style=flat-square)](https://packagist.org/packages/spatie/laravel-translatable)

[![MIT Licensed](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/spatie/laravel-translatable/run-tests.yml)

[![Total Downloads](https://img.shields.io/packagist/dt/spatie/laravel-translatable.svg?style=flat-square)](https://packagist.org/packages/spatie/laravel-translatable)



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.



```php

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:



```php

$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

```



## Support us



[](https://spatie.be/github-ad-click/laravel-translatable)



We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).



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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).



## Documentation



All documentation is available [on our documentation site](https://spatie.be/docs/laravel-translatable).



## Testing



```bash

composer test

```



## Contributing



Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.



## Security



If you've found a bug regarding security please mail [[email protected]](mailto:[email protected]) instead of using the issue tracker.



## 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.



Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.



We publish all received postcards [on our company website](https://spatie.be/en/opensource/postcards).



## Credits



- [Freek Van der Herten](https://github.com/freekmurze)

- [Sebastian De Deyne](https://github.com/sebastiandedeyne)

- [All Contributors](../../contributors)



We got the idea to store translations as json in a column from [Mohamed Said](https://github.com/themsaid). Parts of the readme of [his multilingual package](https://github.com/themsaid/laravel-multilingual) were used in this readme.



## License



The MIT License (MIT). Please see [License File](LICENSE.md) for more information.