Download the PHP package in10/multilanguage without Composer
On this page you can find all versions of the php package in10/multilanguage. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download in10/multilanguage
More information about in10/multilanguage
Files in in10/multilanguage
Package multilanguage
Short Description Simple, opinionated multilanguage package for Laravel
License proprietary
Informations about the package multilanguage
IN10 Multilanguage
Simple, opinionated multilanguage package for Laravel
Contents
- Requirements
- Design
- Installation
- Migrating from Arcanedev/localization
- Usage
- Developer
- License
Requirements
- PHP 7.1 - 7.3
- Laravel 5.7
Design
This is an opinionated package: it works in a specific way, based on the setups we run at IN10. That means:
- All translated routes start with a route part, e.g. example.com/de/news/
- A website has a pre-defined set of languages, all other languages return a 404.
- A language is always two characters.
- The homepage is translated.
- The website has a single default language, by default "en" which you can change in the configuration. This default language is excluded from the URL via a 301-redirect. If you visit example.com/en/test, it will be redirected to example.com/test.
Installation
Install the package using composer:
and publish the configuration file:
You can customize this file as needed.
Migrating from ARCANEDEV/localization
One of the packages we used to use at IN10 is ARCANEDEV/Localization. To facilitate an easy upgrade from the package to this new, smaller package, execute the following steps:
- Remove the existing package:
composer remove arcanedev/localization
. - Remove the ServiceProvider and configuration file if needed.
- Follow the steps in the Installation section above to install IN10/multilanguage.
- Search through your project for the following instances of Localization-specific code that must be replaced
Search for | Replace with | Remarks |
---|---|---|
localization()->getCurrentLocale() |
App::getLocale() |
Don't forget to import the Facade |
Localization::getCurrentLocale() |
App::getLocale() |
Don't forget to import the Facade |
config('localization.supported-locales') |
config('languages.supported-languages |
- Test your project thoroughly to check if all translated routes and features still work.
Usage
Setting up groups
You can make a set of routes translated by wrapping them in a group:
The first parameter attributes
takes the same settings as a regular route group, except for prefix
, as
and middleware
, which are overwritten (these parameters are required to make the translation work). The multilanguage-group should be a root-level construct. Adding it inside of another group or prefix is not tested and probably won't work.
Route translation
In some cases, you might want to translate slugs in the URL. A common example is the /en/news/an-article
and /nl/nieuws/een-artikel
variants of URLs. This can be accomplished using the transGet
routing function:
Note that using transGet
outside of a multilanguage routing group will not work.
The translation key is automatically looked up in the routes.php
translation file. All translation routes must always be translated. Don't fret: the package will scream at you if you're missing a translation.
Route generation
If you want to generate a route with a correct language, use the included helper:
This helpers takes the same parameters as the Laravel route()
helper, with an optional language as a last parameter. If you omit the language, the helper uses the current language for the request. This is usually what you want, so in general you can use the translatedRoute helper as if it were the regular helper:
which will generate /nl/news/five-ways-to-translate-content
in this example if the current language is set to Dutch.
Developer
License
Copyright 2019 IN10. All rights reserved.