13.6.3.2 Doc::addHistoryEntry()

13.6.3.2.1 Description

string addHistoryEntry ( string $comment = '', 
                            int $level = DocHisto::INFO,
                         string $code = '',
                            int $uid = '')

Cette méthode permet d'enregistrer un nouveau message daté dans l'historique du document.

13.6.3.2.1.1 Avertissements

Les messages enregistrés ne sont pas localisables. Cela implique que les messages restitués par l'historique ne sont pas traduits.

13.6.3.2.2 Liste des paramètres

(string) comment

Message qui sera enregistré dans l'historique.

(int) level

Niveau du message :

• DocHisto::NOTICE : notification,
• DocHisto::INFO : message d'information (valeur par défaut),
• DocHisto::MESSAGE : message standard,
• DocHisto:: WARNING : message d'avertissement,
• DocHisto::ERROR : message d'erreur. Dans ce cas, le message est aussi ajouté au fichier log d'erreur du serveur Apache.

(string) code

Code du message : ce code peut être utilisé pour répertorier certaines entrées dans l'historique. Par exemple, le code CREATE est utilisé pour indiquer les messages relatifs à la création d'un document. La méthode Doc::getHisto() permet de filtrer en fonction du code les messages de l'historique.

(int) uid

Identifiant système du compte utilisateur. Si celui-ci est vide alors le message sera attribué à l'utilisateur courant.

13.6.3.2.3 Valeur de retour

Message d'erreur.

13.6.3.2.4 Erreurs / Exceptions

Une exception Dcp\Db\Exception peut être levée en cas de problème d'enregistrement.

13.6.3.2.5 Historique

Cette méthode était anciennement nommée addComment.

13.6.3.2.6 Exemples

Enregistrement d'un nouveau message d'avertissement.

/** @var \Dcp\Family\MyFamily */
$d = new_Doc("", "MY_DOCUMENT");
if ($d->isAlive()) {
    // enregistrement
    $d->addHistoryEntry("Hello world", DocHisto:: WARNING);
}

13.6.3.2.7 Notes

Il n'y a pas de méthode depuis la classe Doc permettant de supprimer des messages de l'historique. Pour manipuler et gérer l'historique du document, il faut utiliser la classe DocHisto.

13.6.3.2.8 Voir aussi

Aucun.