Easy multilingual urls and redirection support for the Laravel framework

Tanel Tammik

Last update: Jul 18, 2022

Related tags

Localization multilingual i18n linguist php laravel translation localization estonia locales

Overview

Linguist - Multilingual urls and redirects for Laravel

This package provides an easy multilingual urls and redirection support for the Laravel framework.

In short Laravel will generate localized urls for links and redirections.

route('people')

http://site.com/people
http://site.com/fr/people

Linguist works perfectly well with https://github.com/tightenco/ziggy named Laravel routes for javascript package!

Installation

Linguist is very easy to use. The locale slug is removed from the REQUEST_URI leaving the developer with the cleanest multilingual environment possible.

Install using Composer:

composer require keevitaja/linguist

There are several options to make Linguist work.

Option 1: Modify the `public/index.php`

Add following line after the vendor autoloading to your projects public/index.php file.

(new Keevitaja\Linguist\UriFixer)->fixit();

End result would be this:

/*
|--------------------------------------------------------------------------
| Register The Auto Loader
|--------------------------------------------------------------------------
|
| Composer provides a convenient, automatically generated class loader for
| our application. We just need to utilize it! We'll simply require it
| into the script here so that we don't have to worry about manual
| loading any of our classes later on. It feels great to relax.
|
*/

require __DIR__.'/../vendor/autoload.php';

(new Keevitaja\Linguist\UriFixer)->fixit();

Option 2: Use LocalizedKernel

Note: This option works only if you have not changed your applications root namespace. Default is App.

In your projects bootstrap/app.php swap the App\Http\Kernel with Keevitaja\Linguist\LocalazedKernel:

/*
|--------------------------------------------------------------------------
| Bind Important Interfaces
|--------------------------------------------------------------------------
|
| Next, we need to bind some important interfaces into the container so
| we will be able to resolve them when needed. The kernels serve the
| incoming requests to this application from both the web and CLI.
|
*/

$app->singleton(
    Illuminate\Contracts\Http\Kernel::class,
    //App\Http\Kernel::class
    Keevitaja\Linguist\LocalizedKernel::class
);

Option 3: modify the `App\Http\Kernel`

Note: This also works with custom root namespace.

<?php

namespace App\Http;

use Illuminate\Contracts\Foundation\Application;
use Illuminate\Foundation\Http\Kernel as HttpKernel;
use Illuminate\Routing\Router;
use Keevitaja\Linguist\UriFixer;

class Kernel extends HttpKernel
{

    public function __construct(Application $app, Router $router)
    {
        (new UriFixer)->fixit();

        parent::__construct($app, $router);
    }

Publish config

Finally you need to publish the Linguist config to set your enabled locales and other relavant configurations.

php artisan vendor:publish --provider="Keevitaja\Linguist\LinguistServiceProvider"

Your personal configuration file will be config/linguist.php.

Usage

You can add the LocalizeUrls middleware your web middleware group as the first item to get the linguist support:

/**
 * The application's route middleware groups.
 *
 * @var array
 */
protected $middlewareGroups = [
    'web' => [
        \Keevitaja\Linguist\LocalizeUrls::class,

Note: This middleware has to be the first item in group!

Another option is to use Linguist in your applications service provider:

class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     *
     * @return void
     */
    public function boot(\Keevitaja\Linguist\Linguist $linguist)
    {
        $linguist->localize();
    }

UrlGenerator will add the locale slug in front of the URI when needed. No extra actions needed.

Route::get('people', ['as' => 'people.index', 'uses' => ''PeopleController@index'']);

{{ route('people.index') }} or {{ url('people') }}

http://site.com/people // default locale from linguist config
http://site.com/fr/people
http://site.com/ru/people

Switcher is a little helper to get the current URLs for the locale switcher.

$urls = dispatch_now(new \Keevitaja\Linguist\Switcher);

NB! Both config and route caching are working!

Assets

Use linguist helpers for a correct routing of assets

Regular Assets

<link rel="stylesheet" href="{{ linguist_asset('css/style.css') }}">
<script type="text/javascript" src="{{ linguist_asset('js/my_js.js') }}"></script>

Secure Assets

<link rel="stylesheet" href="{{ secure_linguist_asset('css/style.css') }}">
<script type="text/javascript" src="{{ secure_linguist_asset('js/my_js.js') }}"></script>

Queues

To make localization work in queues you need to run Linguist->localize($theLocaleYouWant) inside the queued item.

Licence

MIT

Comments

$Class 'Keevitaja\Linguist\UriFixer' not found$

Class 'Keevitaja\Linguist\UriFixer' not found

I installed the package composer require keevitaja/linguist and going with option 1 Add following line after the vendor autoloading to your projects public/index.php file. (new Keevitaja\Linguist\UriFixer)->fixit(); Got Class 'Keevitaja\Linguist\UriFixer' not found

opened by johnef 3
Getting config variables
Took a look at your package and it looks interesting. But looking through sources I've found this code:

$config = include __DIR__.'/../../config/linguist.php'; $pattern = '/^\/('.implode('|', $config['locales']).')(?:\/|$)/';

in https://github.com/keevitaja/linguist/blob/master/src/Http/Kernel.php#L30

Shouldn't actually be:

$pattern = '/^\/('.implode('|', Config::get('linguist.locales').')(?:\/|$)/';

as you've already merged the configs in the service provider?

Just trying to prevent a future problem here, maybe I'm wrong.
opened by cdarken 2
is there any way for the root to redirect to the default domain?

is there any way for the root to redirect to the default domain?

for example, if access to mydomain.com redirects me to mydomain.com/en by default, if my default is en on case it is fr redirect to mydomain.com/fr

opened by gueroverde 0
Scrutinizer Auto-Fixes

@keevitaja requested this pull request.

It consists of patches automatically generated for this project on Scrutinizer: https://scrutinizer-ci.com/g/keevitaja/linguist/

opened by scrutinizer-auto-fixer 0
Not Working with url()->previous() and on FormRequest-Redirects

Hi,

the plugin does not seem to work with url()->previous() or on FormRequest Redirects. You can try be creating a controller for a form that makes use of a FormRequest (https://laravel.com/docs/5.6/validation#form-request-validation) and triggering an error in your rule-set. The following redirect will lead the user to a non-prefixed url.

opened by volkeransmann 0
Assets problem

Hello,

Using Laravel 5.5, and Linguist ^2.1, when using asset to link a style sheet or a javascript file I get 404 and the URL becomes localhost:8000/ar/css/.....

opened by moharrum 2