13.6.2.16 Doc::preUndelete()

13.6.2.16.1 Description

string preUndelete (  )

Cette méthode permet de contrôler la restauration d'un document.

13.6.2.16.1.1 Avertissements

Cette méthode est appelée après les contrôles de profils pour suppression du document.

Le document est encore en statut supprimé (locked=-1 et doctype=Z).

13.6.2.16.2 Liste des paramètres

Aucun.

13.6.2.16.3 Valeur de retour

Message d'erreur. Si la méthode retourne une chaîne de caractères non vide, elle est considérée comme un message d'erreur et la restauration est abandonnée.

Ce message est retourné par la méthode Doc::undelete() si elle est non vide.

13.6.2.16.4 Erreurs / Exceptions

Aucune.

13.6.2.16.5 Historique

Anciennement preRevive().

13.6.2.16.6 Exemples

Cet exemple, interdit la suppression si l'attribut sp_protectionlevel vaut "archived".

namespace My;
use \Dcp\AttributeIdentifiers\MyFamily as MyAttributes;
 
class MyFamily extends Dcp\Family\Document
{
    public function preUndelete() {
 
        if ($this->getAttributeValue(MyAttributes::sp_protectionlevel) == "archived")) {}
            return "Archive document"; // blocage de la restauration
        }
        return '';
    }
}

13.6.2.16.7 Notes

Même le compte "admin" ne peut pas outrepasser les conditions de restauration de cette méthode.

Le menu de restauration n'est pas accessible si cette méthode retourne un message d'erreur.

13.6.2.16.8 Voir aussi

• Doc::postUndelete().
• Doc::undelete().