Jigsaw localization
Brings localization feature to tightenco/jigsaw using JSON files.
Get started
Setup
Bring jigsaw-localization to your Jigsaw project.
composer require elaborate-code/jigsaw-localization
Plug LoadLocalization to the builder by registering it in bootstrap.php.
// bootstrap.php
use ElaborateCode\JigsawLocalization\LoadLocalization;
$events->beforeBuild([LoadLocalization::class]);
Simple usage
Defining Translation Strings
- Create a
langfolder in the root of your project. - Create subfolders for each language supported by the application.
- Populate the subfolders with JSON files that hold translations using translation strings as keys (as much as you want).
File structure example:
/lang
/en
homepage.json
aboutpage.json
...
/fr
homepage.json
aboutpage.json
...
...
lang\en\homepage.json example:
{
"Good morning": "Good morning",
"view": "view",
"fast": "fast",
}
lang\fr\homepage.json example:
{
"Good morning": "bonjour",
"view": "vue",
"fast": "vite",
}
Retrieving Translation Strings
Source files example:
// source\index.blade.php
{{ $page->__("Good morning", 'en') }}
// source\fr\index.blade.php
{{ $page->__("Good morning", 'fr') }}
The outputted files:
<h2> Good morning h2>
<h2> Bonjour h2>
Using folder structure for lang prefix
This section explains how to dump the __ helper second argument for a more intuitive approach.
echo $page->__($text);
The default lang
First you should know that this package takes in consideration a parameter named default_lang. It set it to en by default but you can change it to any other value using default_lang key in config.php
// config.php
return [
// ...
'default_lang' => 'es',
// ...
];
Note that the explicit
$langargument has higher precedence than thelangdeduced from the folder structer!
The folder structure
example.com/{lang}
Pages that reside in the web root folder source are assumed to be rendered using the default_lang. Other pages that reside in subfolders named after a locale code have their language set to the subfolder name
/source
/fr
index.blade.php
contact.blade.php
about.blade.php
...
/es
index.blade.php
contact.blade.php
about.blade.php
...
...
index.blade.php
contact.blade.php
about.blade.php
...
The special multi folder
For the organizational purpose you can group internationalized translations in one JSON using many lang keys.
/lang
...
/multi
salutations.json
projects_short_descriptions.json
...
salutations.json example:
{
"en":{
"Hello": "Hello",
"Goodbye": "Goodbye"
},
"fr":{
"Hello": "Salut",
"Goodbye": "Au revoir"
},
"es":{
"Hello": "Hola",
"Goodbye": "Adiós"
}
}
First level keys must be lang codes
The included page trick
One of the tricks to not repeat your self by creating the same page many times. You can create a source/_pages folder which will contain the master pages where you write the HTML code and call the __ helper then include that page in the other empty files that only respects the languages folder structure or define a $lang variable.
/source
/_pages
index.blade.php
contact.blade.php
...
/fr
index.blade.php
contact.blade.php
...
index.blade.php
contact.blade.php
...
// Both /source/index.blade.php and /source/fr/index.blade.php
@include('_pages.index')
Live test
Wanna see a project that is up and running with this library? checkout my website and its repo
TODO
A helper that gives a route to an equivalent translated page (done, I will integrate it soon).- Add
get_current_langhelper. - Add testing.
- Check the minimum required PHP version.
- Automated github actions for testing.
- Check behavior with non A-Z languages.
- Support 5 caracters language codes
xx_YY.
Contributing
Any help is very welcomed, feel free to fork and PR :)
0 Jul 13, 2019
2 Jul 31, 2022
14 May 23, 2022
2 Sep 9, 2022
25 Sep 18, 2022
60 Nov 10, 2022
792 Jan 3, 2023
150 Nov 29, 2022
720 Jan 3, 2023
7 Oct 27, 2022
9 Nov 30, 2022
167 Dec 3, 2022
6 May 31, 2023
3k Jan 4, 2023
4 Oct 27, 2021
![Laravel URL Localization Manager - [ccTLD, sub-domain, sub-directory].](https://raw.githubusercontent.com/Pharaonic/logos/main/localization.jpg)
2 Aug 7, 2022
6 Mar 10, 2022
50 Dec 15, 2021
6 Mar 10, 2022
36 Jul 18, 2022
26 Oct 22, 2022
515 Nov 30, 2022
651 Dec 29, 2022
110 Dec 30, 2022
1.5k Jan 4, 2023
97 Dec 5, 2022
3 Nov 7, 2022