Download the PHP package jersyfi/laravel-localization without Composer
On this page you can find all versions of the php package jersyfi/laravel-localization. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jersyfi/laravel-localization
More information about jersyfi/laravel-localization
Files in jersyfi/laravel-localization
Package laravel-localization
Short Description A package to localize a laravel application
License MIT
Homepage https://github.com/jersyfi/laravel-localization
Informations about the package laravel-localization
A package to make your application localized
Installation
You can install the package via composer
You need to publish the config file to customize the package
You have the option to publish a migration file for adding a customizable column to a users table for storing the current locale for a logged in user. This is usefull if your application wants to send emails to every user.
The published config localization
looks like so
How to use
More information can be found in the original Laravel documentation with version 8.x. There you need to know everything about Routing and Localization. When you also want to have translatable models i prefere to use laravel-translatable from Spatie.
Routing
The middleware is using redirect_default
to redirect any request when the requested locale was not in locales
. To detect the browser language when entering the page for the first time the LocaleController
is using detect_locale
.
You can redirect to the default_locale
by accessing the LocaleController
function called localize
with the example:
To group a route it is the easiest way to set a prefix named {locale}
together with the middleware locale
.
Inside this group you can set your own localized routes.
An example to get this localized route group:
Helpers
The helpers can be accesed directly by aliases or by facades. When using aliases in your controller you need to include use Localization
.
In below examples the used values are from the above config file so that you can compare it.
Return the given locale or the current app locale with replaced separator.
Return all available locales set in the localization config.
Return application default locale set in the localization config.
Return all available locales from localization config without the default locale.
Return all available locales from localization config without the current locale.
Return the current Route URL
Return the current Route URL with any different locale set in the localization config. The function replaces the {locale} set in routes with the given locale.
Return the current Route URL with default locale set in the localization config.
Check if the locales are valid
Examples
Route to named routes
We create a simple index Route named home
calling whatever you want. In this example we call a Controller. Then you can call your route from whereever you want with route('home')
.
Create a canonical link
You need to call the helper function Localization::currentRouteDefaultLocaleURL()
Create alternate links
To get all alternate links without the default locale you can call the helper function Localization::getLocalesWithoutDefault()
inside a foreach loop. Inside the href of the html you can call the helper function Localization::currentRouteLocaleURL()
and pass the $locale
to it.
Create a language selector
When you want to create a language selector first you need the current locale slug. For this you can call the helper function Localization::getLocaleSlug()
. To loop the other locales you can decide if you want to display all available locales with Localization::getLocales()
or if you want to display the available locales without the current locale with Localization::getLocalesWithoutCurrent()
. Inside the foreach loop you can call the helper function Localization::currentRouteLocaleURL($locale)
to get the link and Localization::getLocalSlug($locale)
for the locale slug.
Changelog
Please see CHANGELOG for more information what has changed recently.
Credits
- Jérôme Bastian Winkel
- All Contributors
License
The MIT License (MIT). Please see License File for more information.