`$i18n.getLabels`¶

Description¶

Retourne une map de libellés correspondant à l'expression wildcard donnée.

Cette méthode peut permettre d'envoyer des libellés internationalisés dans l'arbre de sortie afin que la feuille de style puisse disposer des libellés dans la bonne langue.

Syntaxe¶

$i18n.getLabels( [ options ] )

Paramètres¶

options map

Map d'options. Les options reconnues sont:

filter string

Expression wildcard permettant de filtrer les libellés à récupérer

bundle string

Nom du bundle de ressource dans lequel récupérer le libellé.

Peut être null ou vide, auquel cas le libellé sera récupéré à partir du bundle défini dans la propriété bundles.descriptBundle du fichier de configuration (ou descript si la propriété n'est pasdéfinie).

locale string

Nom de la locale. Si non défini, la méthode s'appuie sur la locale du thread courant.

raw boolean

Flag true/false permettant de demander les libellés bruts, sans substitution des références de variables du genre ${xxx}.

Retour¶

Map contenant les clés/valeurs de libellés.

Exemple¶

L'exemple ci-dessous montre comment on récupère tous les libellés dont le nom débute par style.mailing. et qu'on les place dans un objet xml "labels" après les avoir convertis en xml.

$out.addContent("labels",
                $xml.xmlize($i18n.getLabels({ filter: "style.mailing.*" })),
                "xml");

$i18n.getLabels¶