Cette fonction retourne un texte localisé en fonction d'une clé alphanumérique et de la locale d'exécution du template.
Les textes doivent être stockés dans un fichier ".properties". Le nom du fichier doit correspondre au nom du template. L'encodage du fichier doit correspondre à l'encodage passé en paramètre de la fonction.
Dans un fichier ".properties", chaque ligne contient le couple texte/clé en suivant la syntaxe clé = texte.
Pour chaque locale d'exécution supportée par le template, il est nécessaire de créer un fichier ".properties". Le nom du fichier doit satisfaire la syntaxe suivante : "nomTemplate_code langue_code pays ou region_variante.properties".
En fonction d'une valeur de locale, la recherche de fichier se fait comme suit :
- Recherche du fichier "nomTemplate_code langue _code pays ou region _variante.properties",
- Recherche du fichier "nomTemplate_code langue _code pays ou region.properties",
- Recherche du fichier "nomTemplate_code langue.properties",
- Recherche du fichier "nomTemplate.properties".
De plus, si l'appel à la fonction message est fait depuis un template qui n'est pas le template principal (template importé ou inclus), la recherche se fait comme suit :
- Recherche du fichier ".properties" (en fonction de la locale) dont le nom correspond au nom du template courant,
- Si la clé n'est pas trouvée dans ce fichier, on relance une recherche dans le fichier dont le nom correspond au nom du template principal. Attention, l'encodage du fichier ".properties" du template principal doit être le même que celui passé en paramètre de la fonction.
Il est également possible de saisir des textes paramétrables. Chaque paramètre est identifié dans le texte par la syntaxe {N}, où N correspond au numéro d'ordre du paramètre (N commence à 0) lors de l'appel à message. Les paramètres doivent être de type String, Number, Boolean ou Date.
Exemples de textes paramétrables :
Fichier myTemplate_en.properties | welcomePhrase=Welcome dear {0} {1}! |
Template myTemplate.ftlx executé avec la locale English (en) | ${message(welcomePhrase, customerName, customerLastName) } |
Paramètres
String | msgKey | Clé unique associée au texte à retourner. | Obligatoire |
| String | encoding | Encodage du fichier ".properties". Celui-ci doit être supporté par le JDK utilisé. | Obligatoire |
String / Number / Boolean / Date | params… | Liste des paramètres (un ou plusieurs) qui seront insérés dans le texte à retourner. | Optionnel |
Exemple
${ hardisCore.encodedMessage("title", "windows-1254") }
<#assign label = hardisCore.encodedMessage("designation", "UTF-8", "123, "FRANCE")/>