13.6.3.38 Doc::undelete()

13.6.3.38.1 Description

string undelete (  )

Cette méthode permet d'annuler la suppression d'un document.

13.6.3.38.1.1 Avertissements

Cette méthode ne permet pas de restaurer un document qui a été supprimé physiquement.

13.6.3.38.2 Liste des paramètres

Aucun.

13.6.3.38.3 Valeur de retour

Message d'erreur. Si la chaîne retournée est non nulle, le message indique l'erreur qui a interdit la restauration.

13.6.3.38.4 Erreurs / Exceptions

Une erreur est retournée si :

• Le document n'existe pas ou plus (physiquement supprimé)
• Le document n'est pas supprimé
• L'utilisateur n'a pas le droit delete sur le document
• L'hameçon preUndelete() retourne une erreur.

13.6.3.38.5 Historique

Anciennement Doc::revive().

13.6.3.38.6 Exemples

Restauration du document référencé par l'identificateur $documentId.

$doc=new_doc('', $documentId);
if ($doc->isAffected() && !$doc->isAlive()) {
    $err=$doc->undelete();
    // maintenant le document est vivant
    if ($err == "") {
        printf("Restauration %s [%d]", $doc->getTitle(), $doc->id);
    }
}

13.6.3.38.7 Notes

Une entrée dans l'historique est enregistrée à chaque restauration.

13.6.3.38.8 Voir aussi

• Doc::postUndelete(),
• Doc::preUndelete(),
• Doc::delete().