13.6.4.2 Doc::getAttachedTimer()
Méthode utilisée récupérer les informations des minuteurs attachés au document.
13.6.4.2.1 Description
array getAttachedTimer ( )
Cette méthode renvoie les informations des minuteurs qui sont attachés au document.
13.6.4.2.1.1 Avertissements
Aucun.
13.6.4.2.2 Liste des paramètres
Aucun
13.6.4.2.3 Valeur de retour
Le retour est un tableau de valeur indexé. Si le tableau est vide, alors aucun minuteur n'est attaché au document.
| Clef | Description | Exemple |
|---|---|---|
| timerid | Identifiant du document Timer | 13510 |
| level | Nombre de fois qu'une action a été exécutée depuis l'attachement. Dépend du nombre d'itération et du nombre d'actions | 0 |
| originid | Identifiant du document Origine | |
| docid | Identifiant initial (initid) du document portant le minuteur |
1427 |
| title | Titre du document portant le minuteur | Éléonore |
| fromid | Identifiant de la famille du document portant le minuteur | 1059 |
| attachdate | Date d'attachement du minuteur | 2014-10-15 17:24:00 |
| referencedate | Date de référence du minuteur | 2012-10-01 05:00:00 |
| tododate | Date de prochaine échéance | 2012-10-01 05:00:00 |
| donedate | Date à laquelle l'action a été exécutée | |
| actions | Actions à faire (chaîne serialisée) | a:3:{s:5:"state";s:0:"";s:5:"tmail";s:0:"";s:6:"method";s:12:"::myMethod()";} |
| result | Résultat de l'action | |
| id | Identifiant de l'attachement | 22 |
Seuls les attachements actifs sont retournés. Les actions effectuées ne sont pas retournées.
13.6.4.2.4 Erreurs / Exceptions
Aucunes.
13.6.4.2.5 Historique
Aucun.
13.6.4.2.6 Exemples
Deux minuteurs sont attachés au document n°1427. Le premier minuteur n°13509 est lié à l'origine n°1090. Le deuxième minuteur n'est pas lié.
$myOrigin=new_doc("", 1090); $myDocument=new_doc("", 1427); $myFirstTimer=new_doc("", 13509); $mySecondTimer=new_doc("", 13510); $err=$myDocument->attachTimer($myFirstTimer, $myOrigin); $err=$myDocument->attachTimer($mySecondTimer); print "Attachements:\n"; if (empty($err)) { print_r( $myDocument->getAttachedTimers()); } else { print "$err\n"; }
Résultat :
Attachements
Array
(
[0] => Array
(
[timerid] => 13509
[level] => 0
[originid] => 1090
[docid] => 1427
[title] => Éléonore
[fromid] => 1059
[attachdate] => 2014-10-16 10:19:00
[referencedate] => 2014-10-16 13:19:00
[tododate] => 2014-10-17 13:19:00
[donedate] =>
[actions] => a:3:{s:5:"state";s:0:"";s:5:"tmail";s:0:"";s:6:"method";s:12:"::myMethod()";}
[result] =>
[id] => 31
)
[1] => Array
(
[timerid] => 13510
[level] => 0
[originid] =>
[docid] => 1427
[title] => Éléonore
[fromid] => 1059
[attachdate] => 2014-10-16 10:19: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] => 32
)
)
13.6.4.2.7 Notes
Aucunes.