$msg.pushMessage¶

Description¶

Place les messages existants dans un espace mémoire séparé.

Le but de cette méthode est la suivante : il peut arriver qu'un script doive invoquer d'autres scripts qui génèrent des messages au moyen des méthodes $msg.error, $msg.warn, $msg.info ou $msg.success. On peut imaginer que le script principal est une tâche qui doit contrôler des dossiers : il va itérer sur des dossiers et invoquer un script de contrôle. Si ce dernier génère des messages, ils seront mélanger avec les messages du script principal. De plus, si le nombre de dossiers vérifiés est grand, le volume de messages générés sera conséquent. L'idée est donc de faire un push des messages du script principal, d'effectuer la boucle de contrôle, éventuellement de récupérer les messages générés par les scripts appelés, puis de faire un pop des messages pour revenir à la liste de messages initiale.

Du point de vue du script, les messages "pushés" n'existent plus. Cela signifie que les méthodes $msg.clear, $msg.get, $msg.count ou $msg.remapTargets n'en tiendront pas compte et qu'ils ne seront pas affichés à l'écran si le script n'effectue pas de pop.

Syntaxe¶

$msg.pushMessages()

Retour¶

Retourne null

Exemple¶

1
2
3
4
5
6
7
8
9

try {
    $msg.error("Message 1");
    $msg.pushMessages();

    $msg.error("Message 2");
}
finally {
    $msg.popMessages();
}

À la fin du traitement, seule l'erreur "Message 1" sera affichée à l'écran.