Download the PHP package chinleung/laravel-multilingual-routes without Composer
On this page you can find all versions of the php package chinleung/laravel-multilingual-routes. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download chinleung/laravel-multilingual-routes
More information about chinleung/laravel-multilingual-routes
Files in chinleung/laravel-multilingual-routes
Package laravel-multilingual-routes
Short Description A package to register multilingual routes.
License MIT
Homepage https://github.com/chinleung/laravel-multilingual-routes
Informations about the package laravel-multilingual-routes
Laravel Multilingual Routes
A package to register multilingual routes for your application.
Versioning
Version | Laravel Version |
---|---|
v4 | 10.x, 11.x, 12.x |
v3 | 9.x |
v2 | Older than 9.x |
Installation
You can install the package via composer:
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.
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:
If your application supports different locales, you can either set a app.locales
configuration or follow the configuration instructions from chinleung/laravel-locales.
Example
Instead of doing this:
You can accomplish the same result with:
A demo repository 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
:
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:
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:
To retrieve the current route in another locale, you can use the current_route(string $locale = null)
helper:
Renaming the routes
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
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
Method | URI | Name | Action |
---|---|---|---|
GET|HEAD | test | en.test | App\Http\Controllers\TestController |
Restricting to a list of locales
Method | URI | Name | Action |
---|---|---|---|
GET|HEAD | fr/teste | fr.test | App\Http\Controllers\TestController |
Changing the method of the request
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
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
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
Redirect localized route
Check localized route
Signing localized routes
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
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Chin Leung
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
Laravel Package Boilerplate
This package was generated using the Laravel Package Boilerplate.
All versions of laravel-multilingual-routes with dependencies
chinleung/laravel-locales Version ^2.0
illuminate/support Version ^10.0|^11.0|^12.0