Configurable localization middleware for your Laravel >=5.1 application
Configurable localization middleware for your Laravel >=5.1 application.
This package provides a simple set of configuration and middleware to allow you to automatically set your application's locale using the current request. You can set the locale from a request parameter, header, the current host, a cookie or session data.
Install the package via Composer:
$ composer require benconstable/laravel-localize-middleware
Next, add the package's service provider to your
// config/app.php 'providers' => [ BenConstable\Localize\LocalizeServiceProvider::class ]
and then you'll just need to publish the package's configuration:
$ php artisan vendor:publish --provider="BenConstable\Localize\LocalizeServiceProvider"
which will create
Out-of-the-box, the package is configured to set the application locale using a
request parameter called
locale (see the next section for more info). To enable
this functionality, just register the provided middleware in your
// app/Http/Kernel.php protected $middleware = [ \BenConstable\Localize\Http\Middleware\Localize::class ];
It's recommended to set this middleware globally and early in the stack, but you're free to register it in whatever way that suits your needs.
Configuration can be found at
config/localize-middleware.php. From there, you
can configure which localization determiner you'd like to use in your application
and set options for it. You simply have to change the
The list of available determiners is shown below.
The default determiner sets the application locale from a request parameter
locale. You can change this using the
parameter configuration option.
The parameter will be discovered in the query string or request body.
This determiner sets the application locale from a request header, which defaults
Accept-Language. You can change this using the
header configuration option.
Aside: For information on using
Accept-Language to determine the locale,
see this info from the W3C.
This determiner sets a different application locale depending on the current host.
You'll need to set a map of your application's locales to hosts using the
This determiner sets the application locale from a cookie called
locale. You can
change this using the
cookie configuration option.
This determiner sets the application locale from a session value called
You can change this using the
session configuration option.
Sometimes it might be useful to try and determine the locale from more than one
source. If you'd like to do this, just set the
driver configuration option to an
array of other driver names. For example:
'driver' => [ 'cookie', 'parameter' ]
The locale will then be deteremined from whichever determiner first provides a successful match, so make sure you add the drivers in the correct order (earliest in the array will be used first).
You don't have to use the provided middleware if you don't want to. You can instead write your own, or avoid using middleware entirely.
To determine the locale in your own code, first register an alias for the provided
facade (which is actually a reference to
you want to inject it).
// config/app.php 'aliases' => [ 'Localizer' => BenConstable\Localize\DeterminerFacade::class ]
Then, you can just do:
$locale = Localizer::determineLocale($request);
to determine the locale and do with it what you like.
Here are some other Laravel localization projects that might be useful to you:
MIT © Ben Constable 2017. See LICENSE for more info.