Download the PHP package benconstable/laravel-localize-middleware without Composer
On this page you can find all versions of the php package benconstable/laravel-localize-middleware. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download benconstable/laravel-localize-middleware
More information about benconstable/laravel-localize-middleware
Files in benconstable/laravel-localize-middleware
Package laravel-localize-middleware
Short Description Configurable localization middleware for your Laravel >=5.1 application
License MIT
Homepage https://github.com/BenConstable/laravel-localize-middleware
Informations about the package laravel-localize-middleware
Laravel Localize Middleware
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.
Installation
Install the package via Composer:
Next, add the package's service provider to your config/app.php
:
and then you'll just need to publish the package's configuration:
which will create config/localize-middleware.php
.
Usage
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
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
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 driver
option.
The list of available determiners is shown below.
Determining the locale from a request parameter
Driver name: parameter
The default determiner sets the application locale from a request parameter
called locale
. You can change this using the parameter
configuration option.
The parameter will be discovered in the query string or request body.
Determining the locale from a request header
Driver name: header
This determiner sets the application locale from a request header, which defaults
to 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.
Determining the locale using the current host
Driver name: host
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 hosts
configuration option.
Determining the locale from a cookie
Driver name: cookie
This determiner sets the application locale from a cookie called locale
. You can
change this using the cookie
configuration option.
Determining the locale from the session
Driver name: session
This determiner sets the application locale from a session value called locale
.
You can change this using the session
configuration option.
Using multiple determiners
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:
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).
Determining the locale outside of middleware
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 BenConstable\Localize\DeterminerManager
, if
you want to inject it).
Then, you can just do:
to determine the locale and do with it what you like.
Contributing
See CONTRIBUTING.md.
Other Localization Projects
Here are some other Laravel localization projects that might be useful to you:
License
MIT © Ben Constable 2017. See LICENSE for more info.