mtz-jaime/locale-middleware

This package will help you to localize your application depending from where a user is coming using geoIP, also offers the possibility to overwrite the default language provided via geoIP using a cookie.

dev-master 2018-01-20 11:57 UTC

Requires

• geoip2/geoip2: ^2.3
• guzzlehttp/guzzle: ^6.2

MIT

• Jaime Martinez

• locale
• geoip
• middleware
• laravel

README

This package will help you to localize your application depending from where a user is coming using geoIP, also offers the possibility to overwrite the default language provided via geoIP using a cookie.

Getting Started

Installation

Install via Composer.

composer require mtz-jaime/locale-middleware

If you are using Laravel 5.5 this package already includes the auto discovery package. If for some reason you decided to remove this functionality on your application, add the service provider into your application config.

Do this by adding the following line to the 'providers' section of the application config (usually config/app.php):

MtzJaime\LocaleMiddleware\LocaleMiddlewareServiceProvider::class,

Publish the config file in order to have control to decide which languages your applications is going to support, also to enable the middleware functionality.

php artisan vendor:publish --provider="MtzJaime\LocaleMiddleware\LocaleMiddlewareServiceProvider" --tag="config"

To enable the middleware add the following variable ENABLE_LOCALE_MIDDLEWARE=true in your .env file, to disable the middleware just delete the variable or change it to false.

To download the geoIP binary file there are two options.

• (Option #1) You can find a free version here of the file GeoLite2 Country by MaxMind DB. Also you need to add the following variable GEOIP_MAXMIND_DATABASE='storage/path/of/the/binary' in your .env file, as a good practice is recommended to stored this kind of files under your storage folder.

• (Option #2) You can simply run the following command and let the package do the rest. You don't need to add here the .env variable

php artisan mtzJaime:get-geoIP

Setting up the cookie

On the file app/Http/Middleware/EncryptCookies.php add under $except array the value 'visitLocale',

You can take a look and create your own version of the LocaleCookieController.php (vendor/mtz-jaime/locale-middleware/src/LocaleCookieController.php)

Testing the middleware

This package offers you out of the box the possibility to test if the localization functionality is working.

Publish the needed views and translations using the following command:

php artisan vendor:publish --provider="MtzJaime\LocaleMiddleware\LocaleMiddlewareServiceProvider" --tag="test"

Then add in your .env file the following variable ENABLE_TEST_MIDDLEWARE=LOCALE this variable can be set for any of the supported locales present on the config file LocaleMiddleware.

Note: add the locale in uppercase

ENABLE_TEST_MIDDLEWARE=CH or
ENABLE_TEST_MIDDLEWARE=MX 

Finally just access to the following link 'http://your.app/middleware/test' and the middleware will be up and running

If you are switching between locales remember to clear the config cache of your application.

php artisan config:clear

To remove the testing files just run the following command and delete manually the variable that you added in your .env file

php artisan mtzJaime:remove-test-files