lykegenes/laravel-locale-switcher

A Laravel locale switcher Middleware

Laravel Locale Switcher

![Build Status][ico-github-action] , _(*1)

A Simple Laravel middleware to easily load and switch the user's locale., _(*2)

Version Compatibility

Install

Via Composer, _(*3)

``` bash composer require lykegenes/laravel-locale-switcher, <sub>(*4)</sub>

Then, add this to your Service Providers (It should be done automa) :
``` php
Lykegenes\LocaleSwitcher\ServiceProvider::class,

and add this Alias [Optional] ``` php 'LocaleSwitcher' => Lykegenes\LocaleSwitcher\Facades\LocaleSwitcher::class,, <sub>(*5)</sub>

Finally, you will need to register this Middleware either in your `Kernel.php` or directly in your routes.
This way, you can control which routes will have automatic locale detection (Web pages) or not (your API).
Make sure this middleware is placed **after** any Session or Cookie related middlewares from the framework.
``` php
\Lykegenes\LocaleSwitcher\Middleware\SwitchLocaleMiddleware::class,

Optionally, you can publish and edit the configuration file : ``` bash php artisan vendor:publish --provider="Lykegenes\LocaleSwitcher\ServiceProvider" --tag=config, <sub>(*6)</sub>

## Usage

To change the locale, simply add **"locale"** to the route parameters.
It works for all your routes.
Some examples :

http://my-app.com/?locale=en http://my-app.com/some/sub/route?locale=fr http://my-app.com/some/sub/route?locale=es&otherParam=value, <sub>(*7)</sub>

This will store the locale in the user's session, and set it as the current locale everytime the user requests a page.

You can build the routes with the included helpers. The URLs will be generated using the current locale.
```php
$url = action_localized('SomeController@someFunction', ['your' => 'parameters']);
$url = route_localized('someNamedRoute', ['your' => 'parameters']);

To build a URL to the same page, but with a different locale, use the switch_locale() helper., <sub>(*8)</sub>

$url = switch_locale('fr'); // URL of the French version of the current page.

You can easily generate a dropdown using the laravelcollective/html package :, <sub>(*9)</sub>

HTML::ul(LocaleSwitcher::getEnabledLocales());

Credits

• Patrick Samson
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*10)</sub>