README

A package to register multilingual routes for your application.

Versioning

Installation

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,
        // ...
    ]
];

Configuration

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.

Example

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.

Usage

Quick Usage

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:

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'
];

Important for Resource Routes: When using multilingualResource, don't forget to add translations for all resource route segments that contain parameters:

Route::multilingualResource('test', 'TestController');

<?php

// resources/lang/fr/routes.php

return [
   'test' => 'teste',
   'test/{test}' => 'teste/{test}'
];

This will generate the following:

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

To check if the current route matches a specific route name (without locale prefix), you can use the current_route_is(string $name) helper:

current_route_is('home'); // Returns true if current route is 'en.home', 'fr.home', etc.
current_route_is('photos.show'); // Returns true if current route is 'en.photos.show', 'fr.photos.show', etc.

Renaming the routes

Route::multilingual('test', 'TestController')->name('foo');

Renaming a route based on the locale

Route::multilingual('test', 'TestController')->names([
  'en' => 'foo',
  'fr' => 'bar',
]);

Skipping a locale

Route::multilingual('test', 'TestController')->except(['fr']);

Restricting to a list of locales

Route::multilingual('test', 'TestController')->only(['fr']);

Changing the method of the request

Route::multilingual('test', 'TestController')->method('post');

Registering a view route

// Loads test.blade.php
Route::multilingual('test');

Registering a view route with a different key for the route and view

// Loads welcome.blade.php instead of test.blade.php
Route::multilingual('test')->view('welcome');

Passing data to the view

Route::multilingual('test')->data(['name' => 'Taylor']);
Route::multilingual('test')->view('welcome', ['name' => 'Taylor']);

Redirect localized route

Route::multilingual('support');
Route::multilingual('contact')->redirect('support');

Check localized route

Request::localizedRouteIs('home');

Signing localized routes

URL::signedLocalizedRoute('unsubscribe', ['user' => 1]);
URL::temporarySignedLocalizedRoute('unsubscribe', now()->addMinutes(30), ['user' => 1]);

Multilingual Resource Routes

You can also register multilingual resource routes using the multilingualResource method:

Route::multilingualResource('photos', 'PhotoController');

This will generate all the standard resource routes for each configured locale:

Limiting resource routes to specific actions

Route::multilingualResource('photos', 'PhotoController')->only(['index', 'show']);

Excluding specific actions

Route::multilingualResource('photos', 'PhotoController')->except(['create', 'edit']);

Custom parameter names

Route::multilingualResource('photos', 'PhotoController')->parameters([
    'photos' => 'photo_id'
]);

Limiting to specific locales

Route::multilingualResource('photos', 'PhotoController')->onlyLocales(['fr']);
Route::multilingualResource('photos', 'PhotoController')->exceptLocales(['en']);

Laravel 12.x Resource Features

All Laravel 12.x resource route features are supported:

// Customize missing model behavior
Route::multilingualResource('photos', 'PhotoController')
    ->missing(function (Request $request) {
        return Redirect::route('photos.index');
    });

// Include soft deleted models
Route::multilingualResource('photos', 'PhotoController')->withTrashed(['show']);

// Apply constraints to specific parameters
Route::multilingualResource('photos', 'PhotoController')->whereParam('photos', '[0-9]+');

Using chainable methods

Like regular multilingual routes, you can chain all the same methods:

// Set custom name
Route::multilingualResource('photos', 'PhotoController')->name('gallery');

// Add middleware
Route::multilingualResource('photos', 'PhotoController')->middleware(['auth', 'verified']);

// Add route constraints
Route::multilingualResource('photos', 'PhotoController')->where('photos', '[0-9]+');

// Set default parameters
Route::multilingualResource('photos', 'PhotoController')->defaults(['format' => 'json']);

// Exclude specific locales
Route::multilingualResource('photos', 'PhotoController')->exceptLocales(['en']);

// Set different names per locale
Route::multilingualResource('photos', 'PhotoController')->names([
    'en' => 'pictures',
    'fr' => 'images'
]);

// Chain multiple methods together
Route::multilingualResource('photos', 'PhotoController')
    ->only(['index', 'show', 'edit'])
    ->exceptLocales(['en'])
    ->name('gallery')
    ->middleware('auth')
    ->parameters(['photos' => 'photo_id'])
    ->withTrashed(['show'])
    ->missing(function (Request $request) {
        return redirect()->route('gallery.index');
    });

Upgrading from 1.x to 2.x

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.

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email hello@chinleung.com instead of using the issue tracker.

Credits

• Chin Leung
• All Contributors

License

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

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.