`$msg.success`¶

Description¶

Inscrit un message signalant un succès à l'écran de l'utilisateur.

Syntaxe¶

$msg.success( text [ , options ] )

Paramètres¶

text string

Message de succès à inscrire.

Techniquement le paramètre peut être de n'importe quel type. Le message sera construit à partir de la représentation de l'objet en tant que string.

options map

Map d'options à passer à la méthode. Les options reconnues sont:

source string

Chaîne de caractères désignant la source du message. Si non défini, la source est script.

target map / string

Objet(s) sur le(s)quel(s) porte(nt) le message.

Le paramètre peut être un contexte unique passé sous forme de map ou de string, ou un tableau de maps/strings permettant de désigner plusieurs contextes en même temps.

attributes map

Map d'attributs à associer au message dans l'arbre de sortie. On pourra par exemple spécifier un attribut disableOutputEscaping pour indiquer à la feuille de style de désactiver l'échappement des caractères spéciaux. Attention dans ce cas à ce que le message ne présente pas de risque d'injection XSS, c'est-à-dire qu'il ne contienne aucune valeur issue directement ou indirectement d'une saisie utilisateur non nettoyée (sanitized).

Retour¶

Le message reçu en entrée

Exemple¶

$msg.success("Traitement réalisé avec succès.");

$msg.success("Le traitement <code>statRebuild</code> est terminé.",
          { attributes: { disableOutputEscaping: "yes" } });

// ici on passe un attribut "status" qui est interprété par la feuille
// de style qui applique une classe "text-success" au message
$msg.success("Traitement réussi.");

La méthode $msg.error fournit un exemple d'utilisation avec plusieurs "targets".

$msg.success¶