13.6.4.3 Doc::unAttachTimer()

13.6.4.3.1 Description

string unAttachTimer ( Dcp\Family\TIMER $timer )

Cette méthode permet de détacher un minuteur précis du document.

13.6.4.3.1.1 Avertissements

Aucuns.

13.6.4.3.2 Liste des paramètres

(Dcp\Family\Timer) timer

Document Minuteur qui doit être détaché du document

13.6.4.3.3 Valeur de retour

La valeur de retour est le message d'erreur. Un retour vide indique que l'opération s'est bien déroulée.

Si le minuteur n'est pas présent, aucun message d'erreur n'est retourné.

13.6.4.3.4 Erreurs / Exceptions

Les cas de retours d'erreurs sont :

• Le document "minuteur" n'est pas un minuteur
• Erreur d'accès interne à la base de donnée

13.6.4.3.5 Historique

Aucun.

13.6.4.3.6 Exemples

Détachement d'un minuteur :

$myDocument=new_doc("", 1427);
$myTimer=new_doc("", 13510);
print "Avant\n"
print_r( $myDocument->getAttachedTimers());
$err=$myDocument->unattachTimer($myTimer);
 
print "Après\n"
if (empty($err)) {
  print_r( $myDocument->getAttachedTimers());
} else {
  print "$err\n";
}

Résultat :

Le minuteur n°13510 est présent à l'origine :

Avant:
    Array
    (
        [0] => Array
            (
                [timerid] => 13510
                [level] => 0
                [originid] => 
                [docid] => 1427
                [title] => Éléonore
                [fromid] => 1059
                [attachdate] => 2014-10-15 17:24:00
                [referencedate] => 2012-10-01 05:00:00
                [tododate] => 2012-10-01 05:00:00
                [donedate] => 
                [actions] => a:3:{s:5:"state";s:0:"";s:5:"tmail";s:0:"";s:6:"method";s:12:"::myMethod()";}
                [result] => 
                [id] => 22
            )
    )

Le minuteur n'est plus enregistré

Après:
    Array
    (
    )

13.6.4.3.7 Notes

Une entrée, de niveau notice, est enregistrée dans l'historique pour indiquer le détachement du minuteur.

13.6.4.3.8 Voir aussi

• Doc::attachTimer(),
• Doc::getAttachedTimers()