Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patricksamson/laravel-locale-switcher
A Locale Switcher Middleware for Laravel
https://github.com/patricksamson/laravel-locale-switcher
hacktoberfest i18n laravel locale package
Last synced: 6 days ago
JSON representation
A Locale Switcher Middleware for Laravel
- Host: GitHub
- URL: https://github.com/patricksamson/laravel-locale-switcher
- Owner: patricksamson
- License: mit
- Created: 2015-07-11T22:44:37.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-10-26T19:11:40.000Z (about 2 years ago)
- Last Synced: 2024-03-14T21:12:14.464Z (8 months ago)
- Topics: hacktoberfest, i18n, laravel, locale, package
- Language: PHP
- Homepage:
- Size: 105 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Locale Switcher
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
![Build Status][ico-github-action]
[![Total Downloads][ico-downloads]][link-downloads]
A Simple Laravel middleware to easily load and switch the user's locale.
## Version Compatibility
Laravel | Laravel Locale Switcher
:---------|:----------
5.x | 1.5.x
6.x | 6.x
7.x | 7.x
8.x | 8.x
9.x | 9.x
## Install
Via Composer
``` bash
composer require lykegenes/laravel-locale-switcher
```
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,
```
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
```
## 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
```
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.
```php
$url = switch_locale('fr'); // URL of the French version of the current page.
```
You can easily generate a dropdown using the [laravelcollective/html](https://github.com/LaravelCollective/html) package :
```php
HTML::ul(LocaleSwitcher::getEnabledLocales());
```
## Credits
- [Patrick Samson][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/lykegenes/laravel-locale-switcher.svg
[ico-license]: https://img.shields.io/github/license/patricksamson/laravel-locale-switcher.svg
[ico-github-action]: https://github.com/patricksamson/laravel-locale-switcher/workflows/Run%20Tests/badge.svg?branch=9.x
[ico-downloads]: https://img.shields.io/packagist/dt/lykegenes/laravel-locale-switcher.svg
[link-packagist]: https://packagist.org/packages/lykegenes/laravel-locale-switcher
[link-downloads]: https://packagist.org/packages/lykegenes/laravel-locale-switcher
[link-author]: https://github.com/patricksamson
[link-contributors]: ../../contributors