Revision: Thu, 18 Apr 2024 09:24:14 GMT
v2.14 – outdated
This version of the documentation is outdated. Consider upgrading your project to Spiral Framework 3.12
Edit this page

Internationalization - Installation and Configuration

The spiral i18n component is based on the symfony/translator package and provides compatible interfaces. The web bundle includes this extension by default.

To enable the extension in alternative builds:

composer require spiral/translator

Please note that the spiral/framework >= 2.6 already includes this component.

Activate the bootloader Spiral/Bootloader/I18nBootloader in your application.


By default, the translator component will automatically load all locale files located in app/locale/{lang} directories.

To get a list of available locales:

namespace App\Controller;

use Spiral\Translator\TranslatorInterface;

class HomeController
    public function index(TranslatorInterface $translator): void

To change the locale, use the setLocale method.

It's recommended to use the setLocale method inside middleware or domain core and properly reset the original locate after.

Default Configuration

The framework supplies the default configuration automatically, inside the I18nBootloader. To alter the configuration create app/config/translator.php file:

use Symfony\Component\Translation\Dumper;
use Symfony\Component\Translation\Loader;

return [
    'locale'         => env('LOCALE', 'en'),
    'fallbackLocale' => env('LOCALE', 'en'),
    'directory'      => directory('locale'),
    'autoRegister'   => env('DEBUG', true),
    // available locale loaders (the key is extension)
    'loaders'        => [
        'php'  => Loader\PhpFileLoader::class,
        'po'   => Loader\PoFileLoader::class,
        'csv'  => Loader\CsvFileLoader::class,
        'json' => Loader\JsonFileLoader::class
    // export methods
    'dumpers'        => [
        'php'  => Dumper\PhpFileDumper::class,
        'po'   => Dumper\PoFileDumper::class,
        'csv'  => Dumper\CsvFileDumper::class,
        'json' => Dumper\JsonFileDumper::class,
    'domains'        => [
        // by default we can store all messages in one domain
        'messages' => ['*']