Download the PHP package jeffersongoncalves/laravel-locale-cookie without Composer
On this page you can find all versions of the php package jeffersongoncalves/laravel-locale-cookie. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jeffersongoncalves/laravel-locale-cookie
More information about jeffersongoncalves/laravel-locale-cookie
Files in jeffersongoncalves/laravel-locale-cookie
Package laravel-locale-cookie
Short Description A Laravel middleware that resolves the application locale from a cookie, validating the requested value against a configurable list of supported locales and falling back to a sensible default when the cookie is missing or unknown. Cookie name, supported locales, and fallback locale are all driven by config.
License MIT
Homepage https://github.com/jeffersongoncalves/laravel-locale-cookie
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-locale-cookie
Laravel Locale Cookie
A Laravel middleware that resolves the application locale from a cookie. The requested value is validated against a configurable list of supported locales and ignored when it is missing or unknown, falling back to a sensible default. Cookie name, supported locales, and fallback locale are all driven by config.
Installation
You can install the package via composer:
You can publish the config file with:
This is the contents of the published config file:
cookie— the name of the cookie the middleware reads the visitor's locale from (defaultlocale).supported— the whitelist of accepted locales. A cookie value that is not in this list is ignored.fallback— the locale applied when the cookie is missing or unsupported. Whennull, the middleware falls back to the framework'sconfig('app.fallback_locale').
Usage
Register the middleware on the route group that should be locale-aware. The middleware reads the cookie, validates it against your supported list, and applies the matching locale (or the fallback) for the rest of the request:
For convenience, the package also registers a locale middleware alias, so you can reference it by name:
You can also alias it in bootstrap/app.php:
Setting the cookie
This package only reads the locale cookie — it never writes it. Your application is responsible for setting the cookie when the visitor chooses a locale. You can do that from PHP:
…or from the client with JavaScript:
Encrypted cookies
By default Laravel's EncryptCookies middleware encrypts every cookie, and it runs before this middleware. To keep the read side (the SetLocale middleware, which reads the raw value via $request->cookies->get()) and the write side (the bundled switch route) consistent — and so that client-set cookies (e.g. the JavaScript example above, which are never encrypted) keep working — the package automatically registers the configured cookie name in EncryptCookies' exception list (via EncryptCookies::except()). The cookie is therefore always written and read as a plaintext value; you do not need to add it to $except yourself.
If you change locale-cookie.cookie, the exclusion follows the new name automatically.
Using with Livewire
If your locale-aware pages use Livewire, register the middleware as a Livewire persistent middleware as well, so subsequent /livewire/update requests keep the visitor's locale instead of falling back to the default. Register both the route-group middleware and the persistent middleware (pattern taken from the source project this package was extracted from):
Locale switch route
The package registers a ready-made route that persists the chosen locale in the cookie and redirects back to a same-host Referer (open-redirect safe). Point your language switcher at it:
The {locale} param is constrained to config('locale-cookie.supported'). Configure (or disable) it under locale-cookie.switch:
Shortening a locale code
The LocaleCookie::short() helper reduces a locale to its short language code — handy for <html lang="…">, flag icons, or any place you only need the base language:
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Jèfferson Gonçalves
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-locale-cookie with dependencies
illuminate/support Version ^11.0|^12.0|^13.0
spatie/laravel-package-tools Version ^1.14