Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chinleung/laravel-multilingual-routes
A package to handle multilingual routes in your Laravel application.
https://github.com/chinleung/laravel-multilingual-routes
composer-package hacktoberfest laravel laravel-multilingual-routes laravel-package laravel-routes localization package
Last synced: 5 days ago
JSON representation
A package to handle multilingual routes in your Laravel application.
- Host: GitHub
- URL: https://github.com/chinleung/laravel-multilingual-routes
- Owner: chinleung
- License: mit
- Created: 2019-07-29T20:01:31.000Z (over 5 years ago)
- Default Branch: v4
- Last Pushed: 2024-11-19T00:49:52.000Z (2 months ago)
- Last Synced: 2025-01-09T19:34:34.363Z (12 days ago)
- Topics: composer-package, hacktoberfest, laravel, laravel-multilingual-routes, laravel-package, laravel-routes, localization, package
- Language: PHP
- Homepage: https://github.com/chinleung/laravel-multilingual-routes-demo
- Size: 200 KB
- Stars: 402
- Watchers: 10
- Forks: 25
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Multilingual Routes
[](https://packagist.org/packages/chinleung/laravel-multilingual-routes)
[](https://github.com/chinleung/laravel-multilingual-routes/actions/workflows/tests.yml)
[](https://packagist.org/packages/chinleung/laravel-multilingual-routes)
A package to register multilingual routes for your application.
## Versioning
| Version | Laravel Version |
| ------------- | ------------- |
| v4 | 10.x, 11.x |
| v3 | 9.x |
| v2 | Older than 9.x |
## Installation
You can install the package via composer:
```bash
composer require chinleung/laravel-multilingual-routes
```
To detect and change the locale of the application based on the request automatically, you can add the middleware to your `app/Http/Kernel`. It must be the first item in the `web` middleware group.
``` php
protected $middlewareGroups = [
'web' => [
\ChinLeung\MultilingualRoutes\DetectRequestLocale::class,
// ...
]
];
```
## Configuration
By default, the application locales are only going to be `en` and the default locale is not prefixed. If you want to prefix the default locale, please run the following command to publish the configuration file:
``` bash
php artisan vendor:publish --provider="ChinLeung\MultilingualRoutes\MultilingualRoutesServiceProvider" --tag="config"
```
If your application supports different locales, you can either set a `app.locales` configuration or follow the configuration instructions from [chinleung/laravel-locales](https://github.com/chinleung/laravel-locales#configuration).
## Example
Instead of doing this:
``` php
Route::get('/', 'ShowHomeController')->name('en.home');
Route::get('/fr', 'ShowHomeController')->name('fr.home');
```
You can accomplish the same result with:
``` php
Route::multilingual('/', 'ShowHomeController')->name('home');
```
A [demo repository](https://github.com/chinleung/laravel-multilingual-routes-demo) has been setup to showcase the basic usage of the package.
## Usage
### Quick Usage
Once you have configured the locales, you can start adding routes like the following example in your `routes/web.php`:
``` php
Route::multilingual('test', 'TestController');
```
This will generate the following:
| Method | URI | Name | Action |
|----------|---------|---------|-------------------------------------|
| GET\|HEAD | test | en.test | App\Http\Controllers\TestController |
| GET\|HEAD | fr/teste | fr.test | App\Http\Controllers\TestController |
Note the `URI` column is generated from a translation file located at `resources/lang/{locale}/routes.php` which contains the key of the route like the following:
``` php
'teste'
];
```
To retrieve a route, you can use the `localized_route(string $name, array $parameters, string $locale = null, bool $absolute = true)` instead of the `route` helper:
```php
localized_route('test'); // Returns the url of the current application locale
localized_route('test', [], 'fr'); // Returns https://app.test/fr/teste
localized_route('test', [], 'en'); // Returns https://app.test/test
```
To retrieve the current route in another locale, you can use the `current_route(string $locale = null)` helper:
```php
current_route(); // Returns the current request's route
current_route('fr'); // Returns the current request's route in French version
current_route('fr', route('fallback')); // Returns the fallback route if the current route is not registered in French
```
### Renaming the routes
```php
Route::multilingual('test', 'TestController')->name('foo');
```
| Method | URI | Name | Action |
|----------|---------|--------|-------------------------------------|
| GET\|HEAD | test | en.foo | App\Http\Controllers\TestController |
| GET\|HEAD | fr/teste | fr.foo | App\Http\Controllers\TestController |
### Renaming a route based on the locale
```php
Route::multilingual('test', 'TestController')->names([
'en' => 'foo',
'fr' => 'bar',
]);
```
| Method | URI | Name | Action |
|----------|---------|--------|-------------------------------------|
| GET\|HEAD | test | en.foo | App\Http\Controllers\TestController |
| GET\|HEAD | fr/teste | fr.bar | App\Http\Controllers\TestController |
### Skipping a locale
```php
Route::multilingual('test', 'TestController')->except(['fr']);
```
| Method | URI | Name | Action |
|----------|---------|---------|-------------------------------------|
| GET\|HEAD | test | en.test | App\Http\Controllers\TestController |
### Restricting to a list of locales
```php
Route::multilingual('test', 'TestController')->only(['fr']);
```
| Method | URI | Name | Action |
|----------|---------|---------|-------------------------------------|
| GET\|HEAD | fr/teste | fr.test | App\Http\Controllers\TestController |
### Changing the method of the request
```php
Route::multilingual('test', 'TestController')->method('post');
```
| Method | URI | Name | Action |
|--------|---------|---------|-------------------------------------|
| POST | test | en.test | App\Http\Controllers\TestController |
| POST | fr/teste | fr.test | App\Http\Controllers\TestController |
### Registering a view route
```php
// Loads test.blade.php
Route::multilingual('test');
```
| Method | URI | Name | Action |
|----------|---------|---------|-------------------------------------|
| GET\|HEAD | test | en.test | Illuminate\Routing\ViewController |
| GET\|HEAD | fr/teste | fr.test | Illuminate\Routing\ViewController |
### Registering a view route with a different key for the route and view
```php
// Loads welcome.blade.php instead of test.blade.php
Route::multilingual('test')->view('welcome');
```
| Method | URI | Name | Action |
|----------|---------|---------|-------------------------------------|
| GET\|HEAD | test | en.test | Illuminate\Routing\ViewController |
| GET\|HEAD | fr/teste | fr.test | Illuminate\Routing\ViewController |
### Passing data to the view
```php
Route::multilingual('test')->data(['name' => 'Taylor']);
Route::multilingual('test')->view('welcome', ['name' => 'Taylor']);
```
### Redirect localized route
```php
Route::multilingual('support');
Route::multilingual('contact')->redirect('support');
```
### Check localized route
```php
Request::localizedRouteIs('home');
```
### Signing localized routes
```php
URL::signedLocalizedRoute('unsubscribe', ['user' => 1]);
URL::temporarySignedLocalizedRoute('unsubscribe', now()->addMinutes(30), ['user' => 1]);
```
## Upgrading from 1.x to 2.x
To update from 1.x to 2.x, you simply have to rename the namespace occurrences in your application from `LaravelMultilingualRoutes` to `MultilingualRoutes`. The most common use case would be the `DetectRequestLocale` middleware.
## Testing
```bash
composer test
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Chin Leung](https://github.com/chinleung)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
## Laravel Package Boilerplate
This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).