README

A lightweight Laravel package to handle multi-language translations for model fields using polymorphic relationships.

📦 Installation

Install the package via Composer:

composer require afzaal565/db-fields-translations

⚙️ Publish Config and Migrations

php artisan vendor:publish --provider="Afzaal565\DBFieldsTranslations\DBFieldsTranslationsServiceProvider"
php artisan migrate

🧬 Database Structure

🗂️ languages Table

Stores supported language codes:

Schema::create('languages', function (Blueprint $table) {
    $table->id();
    $table->string('name');
    $table->string('code')->unique(); // e.g., "en", "de"
    $table->timestamps();
});

🗂️ translations Table

Stores translated fields for any model:

Schema::create('translations', function (Blueprint $table) {
    $table->id();
    $table->morphs('model'); // model_type & model_id
    $table->unsignedBigInteger('language_id');
    $table->string('field');
    $table->text('translation');
    $table->timestamps();
});

⚙️ Usage

##🔹 Step 1: Add Trait to Your Model

use FieldTranslations\Traits\Translateable;

class Product extends Model
{
    use Translateable;

    protected $fillable = ['name', 'description'];
}

##🔹 Step 2: Use LocaleTrait in Controller (Optional)

use FieldTranslations\Traits\LocaleTrait;

class ExampleController extends Controller
{
    use LocaleTrait;

    public function currentLanguage()
    {
        return $this->getLanguage(); // Based on App::getLocale()
    }
}

# 📝 Storing Translations
```bash
public function store(Request $request)
{
    $product = Product::create([
        'name' => $request->name,
        'description' => $request->description,
    ]);

    $language = Language::where('code', 'de')->first();

    $product->translationTo($request, $language, ['name', 'description']);
}

🔍 Retrieving Translations

$currentLangId = Language::where('code', app()->getLocale())->value('id');

$product = Product::find($id);

// Get translation for a specific field
$name = $product->tranlationByField($currentLangId, 'name') ?? $product->name;

🔎 Filtering Models Without a Translation

$languageId = Language::where('code', 'de')->value('id');

$productsWithoutGerman = Product::withoutTranslationForLanguage($languageId)->get();

🔧 Available Methods

Method Description

translations()	MorphMany relationship
getTranslatedFields($languageId)	Get all translations for the language
getFirstTranslation($languageId)	Get the first translated value
tranlationByField($languageId, $field)	Get a specific field translation
translationTo($request, $language, $fields)	Save or update translation(s)
scopeWithoutTranslationForLanguage($languageId)	Scope to find records without translation

✅ Example JSON Output

{
  "id": 1,
  "name": "Shoes",
  "translations": [
    {
      "language_id": 2,
      "field": "name",
      "translation": "Schuhe"
    }
  ]
}

📄 License

This package is open-source and licensed under the MIT License.

afzaal565 / field-translations

Maintainers

Details