13.1.6 Action::addWarningMsg

Enregistre un message à afficher à l'utilisateur.

13.1.6.1 Description

void addWarningMsg ( string $msg )

Le message est affiché sous forme de fenêtre de dialogue si l'interface dispose de la fonction jquery ui dialog (ce qui est le cas d'une vue de document). Sinon le message est affichée avec la fonction window.alert().

Si plusieurs messages sont envoyés, ils sont affichés dans la même fenêtre les uns au dessous des autres.

13.1.6.2 Avertissements

N/A

13.1.6.3 Liste des paramètres

(string) msg
Texte brut (pas de html) à afficher

13.1.6.4 Valeur de Retour

Aucun.

13.1.6.5 Erreurs / Exceptions

Aucune.

13.1.6.6 Historique

N/A

13.1.6.7 Exemples

$err = $action->addWarningMsg('Mon premier message');

13.1.6.8 Notes

Les messages ainsi enregistrés sont stockés sur la session de l'utilisateur. Ainsi, même s'ils ne sont pas affichés immédiatement (voir Action::getWarningMsg), ils restent disponibles tant que l'utilisateur ne s'est pas déconnecté.

Les interfaces standard de Dynacase, ainsi que toutes les interfaces utilisant la classe Layout récupèrent automatiquemenet ces messages (lors de l'appel à Layout::gen()). Ils sont ensuite injectés dans la page au moyen de la balise [JS:CODE]. Pour que les messages ne soient ni récupérés, ni affichés, il faut utiliser la balise [JS:CODENLOG].

Les messages affichés par le code de la balise [JS:CODE] peuvent être capturés par la fenêtre parente si celle ci déclare la fonction dcp.displayWarningMessage(messages). Cette fonction reçoit en paramètre la liste des messages d'avertissement sous la forme d'un array.

window.dcp = window. dcp || {};
window.dcp.displayWarningMessage = function (messages) {
    for (var i=0;i<messages.length;i++) {
        // Do something with messages[i]
    }
}

13.1.6.9 Voir aussi

×