Download the PHP package esign/laravel-translation-loader without Composer

Load translations from the database or other sources

This package extends Laravel's default translation functionality, allowing you to load translations from different sources. It ships with a database loader that comes with automatic creation of missing keys and built-in caching support.

Installation

You can install the package via composer:

The package will automatically register a service provider.

This package comes with a migration to store translations in the database. You can publish the migration file with the following command:

This will publish the following migration:

Out of the box, it ships with support for the English language and uses our Underscore Translatable package to store these languages in different columns. You may add more languages as you wish.

Next up, you can optionally publish the configuration file:

The config file will be published as config/translation-loader.php with the following contents:

Usage

To create database translations you may use the create method on the Translation model:

For a more automated approach, consider automatic creation of database translations, eliminating the need for manual key creation.

Once created, you can retrieve the translations as usual in Laravel:

For all possibilities, please refer to the Localization docs from Laravel. Be aware that database-defined translations can overwrite file translations that may exist.

Handling missing translation keys

In situations where you request a translation key that doesn't exist, you have the option to provide a callback to the translator. This callback will be triggered when the requested translation key is not found. Please note that this callback will not be invoked if the translation key exists but has an empty or null value.

You can also customize the behavior of the translator by returning a specific value from the callback. This returned value will then be used as the translation for the missing key.

You may provide this callback using the setMissingKeyCallback method on the Esign\TranslationLoader\Facades\Translator facade:

In the provided closure, you can implement any custom logic you need to handle the missing translation keys. This might involve logging, sending notifications, or providing a default translation value based on your application's requirements.

Automatically creating missing translation keys

This package ships with the ability to automatically create database translations in case the key does not yet exist. You may activate this functionality by calling the createMissingTranslations on the Esign\TranslationLoader\Facades\Translator facade. This is typically done from a service provider within your application:

Note that this functionality will create translations under the * group. In case you need to change this behaviour you may do so by defining your own setMissingKeyCallback.

Registering a loader

If you need to gather translations from diverse sources, you can achieve this by creating a custom translation loader that implements the Esign\TranslationLoader\Contracts\TranslationLoaderContract interface:

Integrate your custom loader by including it in the loaders array within the configuration file of this package.

Caching database translations

By default, this package ensures efficient performance by caching your database translations for 24 hours. This caching mechanism uses the default cache driver that you have configured within your Laravel application.

If you wish to modify the cache duration or switch to a different cache store, please refer to the cache settings within the configuration file.

Clearing the translations cache

The translations cache is automatically maintained when you interact with the Esign\TranslationLoader\Models\Translation model. However, if you make changes outside of these operations, you need to manually clear the cache:

Importing file translations to the database

This package ships with an Artisan command that allows you to import file translations into the database. This can be useful when you want to migrate your translations from file-based to database-based storage. You should specify the locales you want to import translations for as a comma-separated list:

You can optionally specify the --overwrite flag to overwrite any existing translations.

FAQ

Testing

License

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