Locale formats #6358
Assignees
Labels
Comments
1 task
|
What about this ticket? Can it be closed? |
|
No, That's a general info ticket (same as contao/core-bundle#122) wich information on things we want to improve somewhen in a future release. |
leofeyer
referenced
this issue
Jul 6, 2021
Description ----------- | Q | A | -----------------| --- | Fixed issues | Fixes #1957 Since Contao 4.10, the URL prefix is no longer tied to the page language. With this PR, the page language can be any valid Locale ID. A Locale ID can include language, script, country and additional information (e.g. `de_Latn_CH@currency=EUR`), see https://github.com/contao/core-bundle/issues/233. Locale ID and ICU information can later be used a lot more things like rewriting the number formatting to use the ICU information (decimal point according to language & country). Commits ------- c45065b Use Locale ID for tl_page.language 832f980 Migrate the existing page languages 4372b7e Format locale instead of string replace 7fa7cf7 Support old locale style in legacy routing f5b0c0c Added support for full locale routing af35755 Do not migrate the page language 4b5c98a Updated hint for page language field 6d303ea Use a listener for the page language callback 40bfc17 Use method to calculate locale priority 0c22b1b CS bc4abe5 Fixed tests 95293af Feedback adjustments 3a853b8 Migrate the page languages de7b8d7 Always convert page language and make sure it starts with two letters c2ca955 Only support correctly formatted language folders e149b37 Fix user and member language fields 300d40f Fixed rebase issues edfff9a CS bfb0cf6 Merge branch '4.x' into feature/locale 3ad4a00 CS
leofeyer
referenced
this issue
in contao/core-bundle
Jul 6, 2021
Description ----------- | Q | A | -----------------| --- | Fixed issues | Fixes contao/contao#1957 Since Contao 4.10, the URL prefix is no longer tied to the page language. With this PR, the page language can be any valid Locale ID. A Locale ID can include language, script, country and additional information (e.g. `de_Latn_CH@currency=EUR`), see https://github.com/contao/core-bundle/issues/233. Locale ID and ICU information can later be used a lot more things like rewriting the number formatting to use the ICU information (decimal point according to language & country). Commits ------- c45065b5 Use Locale ID for tl_page.language 832f980f Migrate the existing page languages 4372b7e3 Format locale instead of string replace 7fa7cf79 Support old locale style in legacy routing f5b0c0c5 Added support for full locale routing af357553 Do not migrate the page language 4b5c98a0 Updated hint for page language field 6d303ea6 Use a listener for the page language callback 40bfc173 Use method to calculate locale priority 0c22b1bb CS bc4abe59 Fixed tests 95293af0 Feedback adjustments 3a853b8f Migrate the page languages de7b8d7c Always convert page language and make sure it starts with two letters c2ca955d Only support correctly formatted language folders e149b37a Fix user and member language fields 300d40f2 Fixed rebase issues edfff9ad CS bfb0cf68 Merge branch '4.x' into feature/locale 3ad4a000 CS
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
[RFC] Locale formats
For several days I now read on the topic of Locales in regards to our current handling and the Symfony way. I'm writing down here what I found so we're all up to date and to solve confusion once and for all. Loosely related to contao/core-bundle#190 and contao/core-bundle#171.
Background
https://en.wikipedia.org/wiki/Locale
This is probably familiar to everyone of us.
Locale formats
These two formats are relevant for our case.
Used in:
Used in:
Transifex uses a Locale ID to represent regional languages (e.g.
zh_TW) but a Language Tag to represent language scripts (e.g.zh-Hant) :-(Differences between Language Tag and Locale ID
As far as I understand, there is no major difference for our use case.
-) as delimiter between language, script and region._) as delimiter between language, script and country.A Locale ID also does allow to specify more details on locales like the currency, calendar or collation. However, they are (currently) not relevant for our case.
Structure of Language Tag and Locale ID
Apart from the differences noted above, both Language Tag and Locale ID are very similar in their format:
(Examples: Latn = Latin, Cyrl = Cyrillic, Hans = Chinese Simplified, Hant = Chinese Traditional)
Best practice is to add subtags only if they add relevant information. As an example, it's not recommended to write
en-Latnbecause english is almost always written in latin characters.Situation in Contao
Just so that everyone is on the same track, I'm quickly writing down the current Contao approach:
tl_page.language) is a Language Tag. It can either be two characters ISO 639-1 code (de,en) or a five characters language and country (de-DE,de-CH,en-US).de,en) or a five character language and country (de_DE,de_CH,en_US).system/config/languages.php) is also using Locale ID, which means the same applies for member and user language (tl_member.language/tl_user.language).The writing of both formats is case sensitive. The
$GLOBALS['TL_LANGUAGE']variable is inherited from the page language and therefore is a Language Tag.As our language folders are a Locale ID, we're converting the representation everywhere where we try to match a page language to a language folder (
str_replace('-', '_', $lang)). Because we're relying on Transifex, the package format is somewhat predefined.Situation in Symfony
Translation
The Translation component accepts numerous formats for the translation files (see [1], [2]). It simply tries to find a file with the given locale.
However, loading fallbacks (
zhforzh_CN) only works when using a Locale ID with underscore (see [1]). It does, however, not support three level fallbacks (loadszh_Hantbut notzhwhen locale iszh_Hant_TW).Request
The request has methods for
setLocaleandgetLocale. They are NOT related to the_localeattribute (see HttpKernel). On a call tosetLocale, the property is forwarded to the PHP Intl subsystem if available.The good news is: the PHP Intl component does happily accept both dash (
-) or underscore (_) as delimiter and correctly detects country, script and region.Intl
The Symfony Intl component provides fallback information if PHP Intl is not available. Same as PHP Intl, it uses Locale IDs (see [1]). I have not tested it, but I doubt it will work with Language Tags.
HttpKernel / Magic
The HttpKernel component contains some dependency injection magic in regards to locale handling. There are two listeners in place:
LocaleListenertriggers onkernel.request(priority 16) and callsRequest::setLocaleif a_localeattribute is found in the current request (see [1]).TranslatorListenertriggers onkernel.request(priority 10) and sets the locale for the default translator fromRequest::getLocale(see [1]).Problems
Frontend
In our current implementation (Contao 4.0.0-beta1), the request
_localeattribute is parsed from the route path, which means it will be a Language Tag according to the setting intl_page.language. Ifzh-TWis set as the page language, the Translator would not find thezh_TWlanguage pack (and it would not loadzheither).If routes do not contain locales (
contao.prefix_localeisfalse), the fallback language will be used for the Symfony Translator. Contao will use the best-matching language from Accept-Language header to find an appropriate page, and use that language then.Backend
Backend paths do not contain language information. For Symfony Translation, the fallback language (
en) will always be used. Contao will use the best-matching language from Accept-Language header.After a user login, the user's language (
tl_user.language) will be used to load Contao languages.Conclusion
For Symfony, it does not matter what Locale format you use, because it's just a framework. As long as your routes and translation files do match, the Translator will happily load what your URL contains.
The current Contao implementation is not really compatible with Symfony Translation though. It would only be possible to load translations by using Language Code files (
messages.de-CH.xliff), which is neither the recommended way nor the default in Contao or supported by Transifex.Solutions
TBD
Tools
The text was updated successfully, but these errors were encountered: