simplify managing translations for multilingual Eloquent models with power of morph relationships and caching .
Its lightweight design and flexibility make it an excellent choice for applications needing multi-language support with minimal performance overhead.
You can install the package via Composer:
composer require omaralalwi/lexi-translatephp artisan vendor:publish --tag=lexi-translateupdate table name (if you need, before migration) or any thing in config file if you need .
php artisan vendor:publish --tag=lexi-migrationsRun the following command to create the translations table:
php artisan migrateTo use the package, include the LexiTranslatable trait in your Eloquent models, and add translated attributes in $translatableFields array:
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Omaralalwi\LexiTranslate\Traits\LexiTranslatable;
class Post extends Model
{
use LexiTranslatable;
protected $translatableFields = ['title', 'description'];
}You can use setTranslations method to create or update bulk translations for a model in a single step:
$post = Post::find(1);
// must same following format
$post->setTranslations([
'ar' => [
'name' => 'العنوان باللغة العربية',
'description' => 'الوصف باللغة العربية',
],
'en' => [
'name' => 'English language Title',
'description' => 'description in English language',
],
]);OR You can use setTranslation method to create or update one translation for a model in a single step:
$post->setTranslation('title', 'en', 'English Language Title');
$post->setTranslation('description', 'en', 'English Language description');
$post->setTranslation('title', 'ar', 'عنوان باللغة العربية');
$post->setTranslation('description', 'ar', 'وصف باللغة العربية');Note you can add translated name and description for Post model even if Post model did not has (name and description) attributes .
Important Note: To get better performance , Do Not Depend on translations relation directly when return translations, because it did not use cache Never.
it did not use cache to keep it return MorphMany relation , it Return fresh translations from DB , So you can depend on it to create and update translations .
To retrieve translations, simply use transAttr method :
By default it return default app local, else you can specify local.
// get title and description in default app local
$title = $post->transAttr('title');
$title = $post->transAttr('description');
// or get title and description in specific local
$titleInArabic = $post->translate('title', 'ar');
$titleInEnglish = $post->translate('title', 'ar');you can find more detail examples in Examples File .
you can use lexi_locales to get supported locals as array, depend on supported_locales in config file.
Disable Cache:
by default the cache enabled, you can disable it by make use_cache = false , in config/lexi-translate.php file
Cache Management:
Lexi Translate automatically caches translations to boost performance.
Also Cache is cleared automatically when translations are updated or deleted by booted function in Translation model .
Clear Model Cache Manually:
If you need to manually clear the cache, you can do so $model->clearTranslationsCache() for ex :
$post->clearTranslationsCache();Note:
Please note that the supported_locales setting in the configuration file defines the locales that will be handled by the cache by default.
If you add additional locales for translations, make sure to include them in the supported_locales list to ensure proper cache handling. Failing to do so may result in cache issues for locales not added to the list.
- Dynamic Morph Relationships: Manage translations across different models with ease, thanks to its dynamic morph able relationships.
- Automatic Caching: Enjoy enhanced performance as translations are automatically cached and invalidated, ensuring quick access and updates.
- Fallback Mechanism: Never worry about missing translations—Lexi Translate falls back to the default language if a translation is not available.
- Simple, Intuitive API: A clean and consistent API for adding, retrieving, and managing translations.
- Eloquent-Friendly: Seamlessly integrates with Laravel's Eloquent ORM, making it easy to work with translated data while maintaining the power of Laravel’s query builder.
- Feature Tests: supported with Feature Tests .
- Customize table name: in config file you can change
table_nameto any name as you want.
To run the tests for this package:
composer testPlease see CHANGELOG for more information on recent updates.
We welcome contributions! If you'd like to contribute, please check the CONTRIBUTING guide for details.
This project exists thanks to all the people who contribute.
If you discover any security-related issues, please email omaralwi2010@gmail.com instead of using the issue tracker.
The MIT License (MIT). Please see the License File for more information.
-
Gpdf Open Source HTML to PDF converter for PHP & Laravel Applications, supports Arabic content out-of-the-box and other languages.. -
laravel Taxify Laravel Taxify provides a set of helper functions and classes to simplify tax (VAT) calculations within Laravel applications. -
laravel Deployer Streamlined Deployment for Laravel and Node.js apps, with Zero-Downtime and various environments and branches. -
laravel Trash Cleaner clean logs and debug files for debugging packages. -
laravel Time Craft simple trait and helper functions that allow you, Effortlessly manage date and time queries in Laravel apps. -
Laravel Startkit Laravel Admin Dashboard, Admin Template with Frontend Template, for scalable Laravel projects.