README

Introduction

Laralang is a Laravel package that allows you to create localized routes for different languages. By defining routes with language support, you can easily manage multilingual applications.

With Laralang, you can define a route for each language, and the package will automatically generate routes for the specified locales. It provides an efficient way to handle localized URIs and ensures that the URL structure is properly mapped to the language-specific paths.

Features

Define multilingual routes with one simple API.
Automatic locale redirection via usual route helper.
Redirect to any specific locale also via the route helper.
Support for Ziggy

Installation

Execute the following command in your Laravel root project directory:

composer require edulazaro/laralang

Getting started

This will generate routes for /dashboard in English and /es/panel in Spanish:

use EduLazaro\Laralang\LocalizedRoute;

LocalizedRoute::get('dashboard', [
    'en',
    'es' => 'panel'
], fn () => 'ok')->name('dashboard');

You can add any middleware as usual:

use EduLazaro\Laralang\LocalizedRoute;

LocalizedRoute::get('dashboard', [
    'en',
    'es' => 'panel'
], fn () => 'ok')->middleware('auth')->name('dashboard');

Configuration

Publish the Laralang configuration using this command

php artisan vendor:publish  --tag="locales"

If it does not work, then try:

php artisan vendor:publish --provider="EduLazaro\Laralang\LaralangServiceProvider" --tag="locales"

This will generate the locales.php file in the config folder. This configuration file defines the supported locales and other localization-related settings for your Laravel application. It provides the flexibility to define language preferences, URL prefixes, and potential domain mappings for each locale. Below is a breakdown of the different sections of the locales.php configuration file.

Supported Locales

The locales array defines the languages that your application supports. You can list multiple languages here, and the system will handle the routes accordingly.

'locales' => [
    'en',   // English (default)
    'es',   // Spanish
    'fr',   // French
],

Add or remove any locales as per your application's requirements.

Locale Prefixes

The prefixes array allows you to specify custom URL prefixes for each locale. When a locale has a prefix defined, URLs in that locale will have the prefix as part of the path. You do not need to specify all prefixes, as by default the locale name will be used as a prefix except for the default language. However, if you want to customize the prefixes:

'prefixes' => [
    'en' => '',   // No prefix for English (URL: /)
    'es' => 'es', // 'es' prefix for Spanish (URL: /es)
    'fr' => 'fr', // 'fr' prefix for French (URL: /fr)
],

Domain Settings (Future Support)

The domains array allows you to define custom domains for specific locales. If your application requires different domains for different languages (e.g., example.com for English, es.example.com for Spanish), or even totally different tlds, which is a bit challenging in Laravel, you can configure it here:

'domains' => [
    'en' => null,   // No custom domain for English
    'es' => null,   // No custom domain for Spanish
    'fr' => null,   // No custom domain for French
],

How to Register Localized Routes

To register the localized routes, you can use the LocalizedRoute::get(), LocalizedRoute::post(), or any other HTTP verb method like Laravel's regular routes:

use EduLazaro\Laralang\LocalizedRoute;

// Define a localized GET route
LocalizedRoute::get('profile', [
    'en',
    'es' => 'perfil'
], fn () => 'Profile Page')->name('profile');

// Define a localized POST route
LocalizedRoute::post('update-profile', [
    'en',
    'es' => 'actualizar-perfil'
], fn () => 'Update Profile')->name('update-profile');

This is how it works:

The first parameter is the URI (e.g., profile, dashboard).
The second parameter is an associative array with the locale as the key and the localized URI as the value.
The third parameter is the regular closure or controller action.

Routes weill be created like:

/admin/dashboard (for English)
/es/admin/panel (for Spanish)

As you can see, the language prefix will always be added at teh beginning. This will happen even when using groups with prefixes:

Route::prefix('admin')->group(function () {
    $localizedRoute = LocalizedRoute::get('profile', [
        'en',
        'fr'
        'es' => 'perfil'
    ], fn () => 'ok')->name('dashboard');
});

These routes will be created:

/admin/profile (for English)
/fr/admin/profile (for French)
/es/admin/perfil (for Spanish)

How to Use Localized Routes in Views

To generate URLs for your localized routes, you can use the route() helper as usual:

route('en.dashboard') // English
route('es.dashboard') // Spanish

However if you run just route('dashboard') it will also work, and it will redirect to the route named dashboard of the current locale.

License

Larakeep is open-sourced software licensed under the MIT license.

edulazaro / laralang

Maintainers

Details