13.5.2.5 Dir::preRemoveDocument()
La méthode preRemoveDocument est appelée par la méthode
removeDocument avant la suppression d'un document dans
le dossier (si noprepost est égal à false).
13.5.2.5.1 Description
string preRemoveDocument ( string $docid )
13.5.2.5.1.1 Avertissements
Aucun.
13.5.2.5.2 Liste des paramètres
- (string)
docid - L'identifiant (identifiant numérique ou nom logique) du document à enlever du dossier.
13.5.2.5.3 Valeur de retour
La méthode retourne une chaîne vide s'il n'y a pas d'erreurs, ou une chaîne non- vide contenant le message d'erreur dans le cas contraire.
13.5.2.5.4 Erreurs / Exceptions
Si la méthode preRemoveDocument retourne une erreur, alors la suppression du
document dans le dossier n'est pas effectuée.
13.5.2.5.5 Historique
13.5.2.5.5.1 Release 3.2.5
La méthode preRemoveDocument remplace la méthode précédemment nommée
preUnlinkDoc.
L'utilisation de preUnlinkDoc est obsolète depuis la version 3.2.5 de
dynacase-core.
13.5.2.5.6 Exemples
namespace Facturation; class ArchiveFacture extends \Dcp\Family\Dir { public function preRemoveDocument($docId) { $facture = new_Doc('', $docId, true); // prendre la dernière révision if (!$facture->isPaid()) { return sprintf( 'La facture doit être payée pour pouvoir être enlevée du dossier.' ); } return ''; } }
13.5.2.5.7 Notes
Aucune.