A package to register multilingual routes for your application.
Version | Laravel Version |
---|---|
v4 | 10.x, 11.x |
v3 | 9.x |
v2 | Older than 9.x |
You can install the package via composer:
composer require chinleung/laravel-multilingual-routes
To detect and change the locale of the application based on the request automatically, you can add the middleware to your app/Http/Kernel
. It must be the first item in the web
middleware group.
protected $middlewareGroups = [
'web' => [
\ChinLeung\MultilingualRoutes\DetectRequestLocale::class,
// ...
]
];
By default, the application locales are only going to be en
and the default locale is not prefixed. If you want to prefix the default locale, please run the following command to publish the configuration file:
php artisan vendor:publish --provider="ChinLeung\MultilingualRoutes\MultilingualRoutesServiceProvider" --tag="config"
If your application supports different locales, you can either set a app.locales
configuration or follow the configuration instructions from chinleung/laravel-locales.
Instead of doing this:
Route::get('/', 'ShowHomeController')->name('en.home');
Route::get('/fr', 'ShowHomeController')->name('fr.home');
You can accomplish the same result with:
Route::multilingual('/', 'ShowHomeController')->name('home');
A demo repository has been setup to showcase the basic usage of the package.
Once you have configured the locales, you can start adding routes like the following example in your routes/web.php
:
Route::multilingual('test', 'TestController');
This will generate the following:
Method | URI | Name | Action |
---|---|---|---|
GET|HEAD | test | en.test | App\Http\Controllers\TestController |
GET|HEAD | fr/teste | fr.test | App\Http\Controllers\TestController |
Note the URI
column is generated from a translation file located at resources/lang/{locale}/routes.php
which contains the key of the route like the following:
<?php
// resources/lang/fr/routes.php
return [
'test' => 'teste'
];
To retrieve a route, you can use the localized_route(string $name, array $parameters, string $locale = null, bool $absolute = true)
instead of the route
helper:
localized_route('test'); // Returns the url of the current application locale
localized_route('test', [], 'fr'); // Returns https://app.test/fr/teste
localized_route('test', [], 'en'); // Returns https://app.test/test
To retrieve the current route in another locale, you can use the current_route(string $locale = null)
helper:
current_route(); // Returns the current request's route
current_route('fr'); // Returns the current request's route in French version
current_route('fr', route('fallback')); // Returns the fallback route if the current route is not registered in French
Route::multilingual('test', 'TestController')->name('foo');
Method | URI | Name | Action |
---|---|---|---|
GET|HEAD | test | en.foo | App\Http\Controllers\TestController |
GET|HEAD | fr/teste | fr.foo | App\Http\Controllers\TestController |
Route::multilingual('test', 'TestController')->names([
'en' => 'foo',
'fr' => 'bar',
]);
Method | URI | Name | Action |
---|---|---|---|
GET|HEAD | test | en.foo | App\Http\Controllers\TestController |
GET|HEAD | fr/teste | fr.bar | App\Http\Controllers\TestController |
Route::multilingual('test', 'TestController')->except(['fr']);
Method | URI | Name | Action |
---|---|---|---|
GET|HEAD | test | en.test | App\Http\Controllers\TestController |
Route::multilingual('test', 'TestController')->only(['fr']);
Method | URI | Name | Action |
---|---|---|---|
GET|HEAD | fr/teste | fr.test | App\Http\Controllers\TestController |
Route::multilingual('test', 'TestController')->method('post');
Method | URI | Name | Action |
---|---|---|---|
POST | test | en.test | App\Http\Controllers\TestController |
POST | fr/teste | fr.test | App\Http\Controllers\TestController |
// Loads test.blade.php
Route::multilingual('test');
Method | URI | Name | Action |
---|---|---|---|
GET|HEAD | test | en.test | Illuminate\Routing\ViewController |
GET|HEAD | fr/teste | fr.test | Illuminate\Routing\ViewController |
// Loads welcome.blade.php instead of test.blade.php
Route::multilingual('test')->view('welcome');
Method | URI | Name | Action |
---|---|---|---|
GET|HEAD | test | en.test | Illuminate\Routing\ViewController |
GET|HEAD | fr/teste | fr.test | Illuminate\Routing\ViewController |
Route::multilingual('test')->data(['name' => 'Taylor']);
Route::multilingual('test')->view('welcome', ['name' => 'Taylor']);
Route::multilingual('support');
Route::multilingual('contact')->redirect('support');
Request::localizedRouteIs('home');
URL::signedLocalizedRoute('unsubscribe', ['user' => 1]);
URL::temporarySignedLocalizedRoute('unsubscribe', now()->addMinutes(30), ['user' => 1]);
To update from 1.x to 2.x, you simply have to rename the namespace occurrences in your application from LaravelMultilingualRoutes
to MultilingualRoutes
. The most common use case would be the DetectRequestLocale
middleware.
composer test
Please see CONTRIBUTING for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.
This package was generated using the Laravel Package Boilerplate.