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
Note
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
{
dump($translator->getCatalogueManager()->getLocales());
}
}
To change the locale, use the setLocale method.
Note
It's recommended to use thesetLocalemethod inside middleware or domain core and then properly reset the original locate.
The framework supplies a default configuration automatically, inside I18nBootloader. To alter the configuration, create the 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' => ['*']
]
];
| Event | Description |
|---|---|
| Spiral\Translator\Event\LocaleUpdated | The Event will be fired after changing the locale. |