README

A simple package to localize the routes of Laravel. This pakage adds some macros to the Route facade to allow the localization. There are also some helpers.

Installation

composer require dartmoon/laravel-localized-routes

Usage

Group all the routes you want to translate inside a Route::localize(...). This must be put at the topmost group level of your routes.

Route::localize(function () {
    // Put here all the routes you want to localize
});

For each route that you want to localize change the method with the localized one. The localized version has a Localized suffix.

E.g. if this is your route file

Route::localize(function () {
    Route::get('/home', ...);
    Route::post('/update-profile', ...);

    Route::get('/do/not/localize');
});

Route::get('/external');

Then it must become

Route::localize(function () {
    Route::getLocalized('/home', ...);
    Route::postLocalized('/update-profile', ...);

    Route::get('/do/not/translate/but/prefix');
});

Route::get('/external');

You can now translate all your routes using the Laravel translation service. Inside the your lang folder (eg. /lang/it) create a routes.php file.

<?php

return [
    '/home' => '/home-translated',
    '/update-profile' => '/aggiorna-profilo',
];

Customizing the available languages

First you need to publish the config.

php artisan vendor:publish --provider="Dartmoon\LaravelLocalized\LaravelLocalizedServiceProvider"

Then you will find a new locale.php file inside your config.php folder.

<?php
/**
 * Return enabled locales
 */

return [
    'available' => [
        // 'locale' => 'Name of the locale'
        'en' => 'EN',
        'it' => 'IT',
    ],
    'default' => 'en', // Default locale to be used
];

You can now edit the available with the locale you want to enable.

Named routes

This package supports named routes out of the box and adds some useful prefixes.

E.g. Let's suppose these are your routes.

Route::localize(function () {
    Route::getLocalized('/home', ...)->name('home');
});

And this is your translation

<?php

return [
    '/home' => '/home-translated',
];

Then you can simply do as follows:

route('home'); // If you have the "en" locale loaded then '/home', if you have the "it" locale loaded than it will be '/home-translated'
route('it.home'); // Will return '/home-translated'. This route will not be defined if the current locale is "it"!
route('en.home'); // Will return '/home'. This route will not be defined if the current locale is "en"!

Helpers

route_localized($name, $parameters = [], $locale = null, $absolute = true) it behaves exactly as the route helper of Laravel, but it allows you to specify the locale
url_localized($url, $locale = null) it allows you to localize an URL
available_locales() returns the available locales, without their names
is_default_locale($locale) returns true if the specified locale is the default one
is_current_locale_default returns true if the current locale is the default one
locale_name($locale, $default = null) returns the locale name for the specified locale

License

This project is licensed under the MIT License - see the LICENSE.md file for details

dartmoon / laravel-localized-routes

Maintainers

Details