A Trait to handle Translations in Laravel
This is a Laravel package containing a trait for translatable Eloquent models. This package follows
the approach to have only a single table to maintain all the translations., (*1)
This approach may not be perfect for every use case as the table can grow really big. But compared to all the
other packages this approach is the most flexible as it lets you make models and its attributes translatable
without extra configuration., (*2)
Alternatives to this package are following packages:, (*3)
-
Spatie/laravel-translatable saves the translatable
attributes as jsons
-
dimsav/laravel-translatable expects a new table for
every new model that has translatable attributes
Requirements
This package require a minimum Laravel version of 5.7 and PHP in version 7.2, (*4)
Installation
You can install the package via composer:, (*5)
composer require aheenam/laravel-translatable
Now you can use this Trait on any Eloquent Model of your project., (*6)
Usage
To make your Eloquent Model translatable just add the Aheenam\Translatable\Translatable Trait to your model.
Then add a public attribute $translatable as an array containing all the attributes that should be translatable., (*7)
<?php
use Illuminate\Database\Eloquent\Model;
use Aheenam\Translatable\Translatable;
class MyModel extends Model {
use Translatable;
public $translatable = ['place'];
}
Methods
The simplest version of getting an translation is to simply get the property. This will return the value of
the property in the current language, (*8)
// assuming $myModel is an instace of MyModel class defined above
// and the translations are set
echo $myModel->place; // returns 'Germany'
App::setLocale('de');
echo $myModel->place; // returns 'Deutschland'
You can also use, (*9)
$myModel->translate('place', 'de'); // returns 'Deutschland'
Getting the translated model
Sometime you want to keep the model properties untouched but get a translated version of your model. You can reach
this by using, (*10)
$translatedModel = $myModel->in('de');
echo $translatedModel->place; // returns 'Deutschland'
// shorter
echo $myModel->in('de')->place; // returns 'Deutschland'
Translating an Model
You can translate a model using, (*11)
$myModel->translate('no', [
'place' => 'Tyskland'
]);
Note: The method translate() can be used to get a translation and to set a translation. The difference is what
type of parameters are used. If you pass an array as the second argument, then translate() will work as a setter
otherwise as a getter, (*12)
Changelog
Check CHANGELOG for the changelog, (*13)
Testing
To run tests use, (*14)
$ composer test
Contributing
soon, (*15)
Security
If you discover any security related issues, please email rathes@aheenam.com or use the issue tracker of GitHub., (*16)
About Aheenam
Aheenam is a small company from NRW, Germany creating custom digital solutions. Visit
our website to find out more about us., (*17)
License
The MIT License (MIT). Please see License File
for more information., (*18)
Wallogit.com
