Skip to content
A package to handle multilingual routes.
PHP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
src
tests
.editorconfig
.gitattributes
.gitignore
.scrutinizer.yml
.styleci.yml
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE.md
README.md
composer.json
phpunit.xml.dist

README.md

Laravel Multilingual Routes

Latest Version on Packagist Build Status Quality Score Total Downloads

A package to register multilingual routes for your application.

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:

protected $middlewareGroups = [
    'web' => [
        \ChinLeung\LaravelMultilingualRoutes\DetectRequestLocale::class,
        // ...
    ]
];

Configuration

By default, the application locales are going to be en and the app.fallback_locale is not prefixed. If you want to prefix the fallback locale, please run the following command to publish the configuration file:

php artisan vendor:publish --provider="ChinLeung\LaravelMultilingualRoutes\LaravelMultilingualRoutesServiceProvider" --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');

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:

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

Renaming the routes

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

Renaming a route based on the locale

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

Skipping a locale

Route::multilingual('test', 'TestController')->except(['fr']);
Method URI Name Action
GET|HEAD test en.test App\Http\Controllers\TestController

Restricting to a list of locales

Route::multilingual('test', 'TestController')->only(['fr']);
Method URI Name Action
GET|HEAD fr/teste fr.test App\Http\Controllers\TestController

Changing the method of the request

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

Registering a view route

// 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

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');
Method URI Name Action
GET|HEAD test en.test Illuminate\Routing\ViewController
GET|HEAD fr/teste fr.test Illuminate\Routing\ViewController

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

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

License

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

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.

You can’t perform that action at this time.