5.5 Internationalisation
Il est possible de traduire des chaînes de caractères côté client.
Ces traductions se font au moyen d'un translator, qui expose les méthodes
_
, ___
et getLocale
.
5.5.1 Récupération d'un translator
Un translator peut être obtenu au moyen de la fonction window.dcp.getTranslator
5.5.1.1 La fonction getTranslator
5.5.1.1.1 Arguments
catalog
- Le nom du catalogue à utiliser pour ce translator. Par défaut, dynacase génère un catalogue par application, appelé du même nom que l'application.
success
- Fonction de callback appelée une fois le translator prêt.
Elle reçoit le _translator_ en argument.
error
- Fonction de callback appelée en cas d'erreur.
Elle reçoit le message d'erreur en argument.
5.5.1.1.2 Retour
Retourne une promise qui peut être utilisée à la place du callback.
5.5.1.1.3 Exception
Aucune
5.5.2 Utilisation d'un translator
5.5.2.1 La méthode _
Cette méthode retourne la traduction d'un texte.
5.5.2.1.1 Arguments
key
- La chaîne à traduire
5.5.2.1.2 Retour
Retourne la chaîne traduite. Lorsque la traduction en figure pas dans le catalogue, la chaîne non traduite est retournée.
5.5.2.1.3 Exceptions
Aucune
5.5.2.2 La méthode ___
Cette méthode retourne la traduction d'un texte dans un contexte donné.
5.5.2.2.1 Arguments
key
- La chaîne à traduire
contexte
- Le contexte dans lequel chercher la traduction
5.5.2.2.2 Retour
Retourne la chaîne traduite. Lorsque la traduction en figure pas dans le catalogue pour le contexte demandé, la chaîne non traduite est retournée.
5.5.2.2.3 Exceptions
Aucune
5.5.2.3 La méthode getLocale
Cette méthode retourne un objet décrivant la locale de ce catalogue.
5.5.2.3.1 Arguments
aucun
5.5.2.3.2 Retour
Retourne un objet conforme à la description de locale de dynacase
5.5.2.3.3 Exceptions
Aucune
5.5.3 Usage avancé
Il est possible de générer un translator à partir d'un catalogue au moyen de la fonction
window.dcp.translatorFactory
.
5.5.3.1 La fonction translatorFactory
Retourne un nouvel objet translator à partir du catalogue passé en argument
5.5.3.1.1 Arguments
catalog
- le catalogue - au format JSON - sous la forme d'un objet javascript
Le format des ces objets est défini dans le manuel de référence.
5.5.3.1.2 Retour
Un translator, avec les méthodes _
,
___
et
getLocale
.
Si le catalogue n'est pas du JSON valide, le translator retourné ne contient que des traductions vides.
5.5.3.1.3 Exceptions
Aucune
5.5.4 Génération du catalogue
La génération du catalogue est couverte par le chapitre correspondant du manuel de référence
5.5.4.1 Format du catalogue
Le format du catalogue est couvert par le chapitre correspondant du manuel de référence