fomvasss/laravel-translatable

A package to manage SEO (meta-tags, xml-fields, etc.)

1.1.0 2020-12-29 19:52 UTC

Requires

• php: ^7.3|^7.4|^8.0
• illuminate/database: ^6.0|^7.0|^8.0
• illuminate/support: ^6.0|^7.0.5|^8.0

MIT

• Vasyl Fomin

• translation
• language
• laravel
• localization
• multilingual
• laravel-translatable

README

This is a Laravel package for creating translations content of Eloquent-models. For translation, created models in different languages, between which relations is established through additional fields. The main advantage is that there is no need to create additional tables, models or specific JSON-fields, all operations occur without changes. The functionality is very easy to integrate into an existing / running project. All you need to do is add two fields to the desired table / model by connecting one PHP-Trait.

Installation

To install the package, in terminal:

composer require fomvasss/laravel-translatable

Publish

Run in terminal:

php artisan vendor:publish --provider="Fomvasss\LaravelTranslatable\ServiceProvider"

A configuration file will be published to config/translatable.php.

Usage

1. Add columns (langcode & translation_uuid in translatable DB-table:

Example:

Schema::create('articles', function (Blueprint $table) {
    ...
    $table->translatable();
});

// To drop columns
Schema::table('articles', function (Blueprint $table) {
    $table->dropTranslatable();
});

1. Your model should use Fomvasss\LaravelTranslatable\Traits\HasTranslations trait to enable translations:

Example: app/Models/Article.php

use Fomvasss\LaravelTranslatable\Traits\HasTranslations;

class Article extends Model
{
    use HasTranslations;
    //...
}

1. Get and Save article translations in your controller:

Example controller: app/Http/Controllers/ArticleController.php

class ArticleController extends Controller 
{
    public function index(Request $request)
    {
        // Select by config('app.locale'):
        $articles = \App\Model\Article::byLang()->paginate();
        // OR by request
        $articles = \App\Model\Article::byLang($request->lang)->paginate();
        // ...
    }
    
    public function store(Request $request)
    {
    	// Let's create an article in English (en)
        $article1 = \App\Model\Article::create([
            'name' => 'Article 1, for EN language',
            'langcode' => 'en',
        ]);
        
        // For the saved article ($article1)  will be auto-generated UUID
        // Example: 70cf3963-cf41-464c-9d81-411d3a524789

        // We will create a translation into Ukrainian (uk) for the article ($article1)
        $article2 = \App\Model\Article::create([
            'name' => 'Стаття 1, для UK мови',
            'langcode' => 'uk',
            'translation_uuid' => $article1->uuid,
        ]);
        // OR
        $article2 = \App\Model\Article::create(['name' => 'Стаття 1, для UK мови']);
        $article2->saveTranslatable('uk', $article1->uuid);
  
        // A couple langcode & translation_uuid must be unique
        // ...
    }

    public function show($id)
    {
        $article = \App\Model\Article::findOrFail($id);
        
        // Get related translations list for article 
        $translation = $article->getTranslationList();
        
        return view('stow', compact('article', 'translation'));
    }
}

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Fomin Vasyl
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Happy coding!