Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/konnco/laravel-transeloquent
If you want the faster way to translate your model and store it in a single table, this package is built for you.
https://github.com/konnco/laravel-transeloquent
database laravel laravel-5-package laravel-transeloquent multilanguage translated-attributes translation
Last synced: 6 days ago
JSON representation
If you want the faster way to translate your model and store it in a single table, this package is built for you.
- Host: GitHub
- URL: https://github.com/konnco/laravel-transeloquent
- Owner: konnco
- License: mit
- Created: 2019-11-30T14:52:54.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-03-01T11:46:54.000Z (almost 5 years ago)
- Last Synced: 2024-04-03T23:03:14.805Z (9 months ago)
- Topics: database, laravel, laravel-5-package, laravel-transeloquent, multilanguage, translated-attributes, translation
- Language: PHP
- Homepage: https://konnco.com
- Size: 80.1 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Laravel Transeloquent
**If you want the faster way to translate your model and store it in a single table, this package is built for you.**
[](https://travis-ci.org/Konnco/laravel-transeloquent)
[](https://packagist.org/packages/konnco/laravel-transeloquent)
[](https://packagist.org/packages/konnco/laravel-transeloquent)
[](https://packagist.org/packages/konnco/laravel-transeloquent)
[](https://packagist.org/packages/konnco/laravel-transeloquent)
[](https://github.styleci.io/repos/225027362)
This is a Laravel package for translatable models. Its goal is to remove the complexity in retrieving and storing multilingual model instances. With this package you write less code, as the translations are being fetched/saved when you fetch/save your instance.
Maybe out there there's so many package that work the same way, and has more performance, but the purpose this package is make your development time faster.
***This package is still in alpha version, so the update may broke your application.***
## Installation
```php
composer require konnco/laravel-transeloquent
```
```php
php artisan vendor:publish
```
```php
php artisan migrate
```
## Configuration
you can find transeloquent configuration here. `config/transeloquent.php`
```php
return [
// default locale
'locale' => 'en',
// transeloquent model
'model' => Konnco\Transeloquent\models\Transeloquent::class
];
```
Add transeloquent traits into your model
```php
namespace App;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
class News extends Model {
use \Konnco\Transeloquent\Transeloquent;
}
```
and the default excluded field is `id`, `created_at`, `updated_at`, `deleted_at` these fields will not saved into database.
if you want to add only some fields to be translated, you may have to add `$translateOnly` into your model.
```php
namespace App;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
use Konnco\Transeloquent\Transeloquent;
class News extends Model {
use Transeloquent;
protected $translateOnly = ['translate-field-1', 'translate-field-2'];
}
```
if you want to add more excluded field from translated, you may have to add `$translateExcept` into your model.
```php
namespace App;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
use Konnco\Transeloquent\Transeloquent;
class News extends Model {
use Transeloquent;
protected $translateExcept = ['dont-translate-1', 'dont-translate-2'];
}
```
**Note** : If you have set `$translateOnly` variable, it will be executed first. Make sure you don't use `$translateOnly` variable in your model if you want to use `$translateExcept` variable.
## Quick Example
### Getting translated attributes
Original Attributes In English or based on configuration in `app.transeloquent.default_locale`
```php
//in the original language
$post = Post::first();
echo $post->title; // My first post
```
---
Translated attributes
```php
App::setLocale('id');
$post = Post::first();
echo $post->title; // Post Pertama Saya
```
### Saving translated attributes
To save translation you must have the initial data.
for example you want to save indonesian translation.
```php
App::setLocale('id');
$post = Post::first();
$post->title = "Post Pertama Saya";
$post->save();
// or set locale for specific model
$post = Post::first();
$post->setLocale('id')
$post->title = "Post Pertama Saya";
$post->save();
```
### Checking if Translation Available
```php
$post = Post::first();
$post->translationExist('id'); //return boolean
```
## Authors
* **Franky So** - *Initial work* - [Konnco](https://github.com/konnco)
* **Rizal Nasution** - *Initial work* - [Konnco](https://github.com/konnco)