IPS_SetEventCyclic

 bool IPS_SetEventCyclic (int $EreignisID, int $Datumstyp, int $Datumsintervall, int $Datumstage, int $Datumstagesintervall, int $Zeittyp, int $Zeitintervall) 

Parameterliste

Rückgabewert

Konnte die Funktion erfolgreich ausgeführt werden, liefert sie als Ergebnis TRUE, andernfalls FALSE.

Beschreibung

Um ein zyklisches Ereignis zu konfigurieren, muss festgelegt werden, in welchen Intervallen dieses ausgeführt werden soll. Dazu gehört ein Datumsintervall, welches das Intervall in einem bestimmten Tages-, Wochen-, Monats- oder Jahresrhythmus festlegt und ein Zeitintervall, welches an dem jeweiligen Tag ein sekunden-, minuten- oder stundenbasierendes Intervall festlegt.

Wird der Datumstyp “Wöchentlich” gewählt, so besteht die Möglichkeit, im Parameter Datumstage die Tage der Woche zu bestimmen, an denen das Ereignis gestartet werden soll. Bei monatlichem oder jährlichem Datumstyp wird der Tag im Monat im Parameter Datumstagesintervall angegeben. Bei allen anderen Typen kann der Parameter mit dem Platzhalter 0 angegeben werden.

Spitzfindigkeiten:

• (Monatlich) Bei der Variante “Am X. Tag alle Y Monate” bedeutet X > 31, dass der letzte Tag im Monat gewählt wird. Wird z.B. X = 31 gewählt, so werden nur Monate berücksichtigt, die 31 Tage haben.
• (Monatlich) Bei der Variante “Am X. Wochentag alle Y Monate” bedeutet X > 5, dass die letzte Woche gewählt wird. Wird z.B. X = 5 gewählt, so werden nur Monate berücksichtigt, die einen jeweiligen 5. Wochentag haben.
• (Jährlich) Bei der Variante “Am X. Tag im Monat Y” wird ein Timer nur ausgeführt, wenn X ein gültiger Tag in diesem Monat ist, andernfalls wird der Timer nicht ausgeführt.

Beispiel

//Zum aktuellen Zeitpunkt alle 8 Wochen etwas ausführen
$eid = IPS_CreateEvent(EVENTTYPE_CYCLIC);
IPS_SetParent($eid, $_IPS['SELF']);
IPS_SetEventCyclicTimeFrom($eid, (int)date("H"), (int)date("i"), (int)date("s"));
IPS_SetEventCyclicDateFrom($eid, (int)date("d"), (int)date("m"), (int)date("Y"));
IPS_SetEventCyclic($eid, EVENTCYCLICDATETYPE_DAY, 8 * 7 /* Alle 8 Wochen */, 0, 0, EVENTCYCLICTIMETYPE_ONCE, 0);
IPS_SetEventActive($eid, true);

//Jeden Tag alle 6 Stunden ab 0 Uhr
$eid = IPS_CreateEvent(EVENTTYPE_CYCLIC);
IPS_SetParent($eid, $_IPS['SELF']);
IPS_SetEventCyclic($eid, EVENTCYCLICDATETYPE_DAY, 1 /* Jeden Tag */, 0, 0, EVENTCYCLICTIMETYPE_HOUR, 6 /* Alle 6 Stunden */);   

//Alle 2 Minuten ab 0 Uhr bis 12 Uhr
$eid = IPS_CreateEvent(EVENTTYPE_CYCLIC);
IPS_SetParent($eid, $_IPS['SELF']);
IPS_SetEventCyclic($eid, EVENTCYCLICDATETYPE_NONE /* Keine Datumsüberprüfung */, 0, 0, 0, EVENTCYCLICTIMETYPE_MINUTE, 2 /* Alle 2 Minuten */);
IPS_SetEventCyclicTimeTo($eid, 12, 0, 0);

//Alle 2 Minuten zwischen 8 Uhr und 10 Uhr
$eid = IPS_CreateEvent(EVENTTYPE_CYCLIC);
IPS_SetParent($eid, $_IPS['SELF']);
IPS_SetEventCyclic($eid, EVENTCYCLICDATETYPE_NONE /* Keine Datumsüberprüfung */, 0, 0, 0, EVENTCYCLICTIMETYPE_MINUTE, 2 /* Alle 2 Minuten */);
IPS_SetEventCyclicTimeFrom($eid, 8, 0, 0);
IPS_SetEventCyclicTimeTo($eid, 10, 0, 0);

//Alle 2 Wochen am Montag+Mittwoch einmalig um genau 0:00 Uhr
$eid = IPS_CreateEvent(EVENTTYPE_CYCLIC);
IPS_SetParent($eid, $_IPS['SELF']);
IPS_SetEventCyclic($eid, EVENTCYCLICDATETYPE_WEEK, 2 /* Alle 2 Wochen */, EVENT_DAY_MONDAY + EVENT_DAY_WEDNESDAY, 0, EVENTCYCLICTIMETYPE_ONCE, 0); 

//Täglich um 15 Uhr
$eid = IPS_CreateEvent(EVENTTYPE_CYCLIC);
IPS_SetParent($eid, $_IPS['SELF']);
IPS_SetEventCyclicTimeFrom($eid, 15, 0, 0);

//Am ersten Tag im Monat um 0 Uhr
$eid = IPS_CreateEvent(EVENTTYPE_CYCLIC);
IPS_SetParent($eid, $_IPS['SELF']);
IPS_SetEventCyclic($eid, EVENTCYCLICDATETYPE_MONTH, 1 /* Jeden Monat */, 0 /* Egal welcher Tag */, 1 /* Erster Tag im Monat */, EVENTCYCLICTIMETYPE_ONCE, 0); 

//Am ersten Freitag im Monat um 0 Uhr
$eid = IPS_CreateEvent(EVENTTYPE_CYCLIC);
IPS_SetParent($eid, $_IPS['SELF']);
IPS_SetEventCyclic($eid, EVENTCYCLICDATETYPE_MONTH, 1 /* Jeden Monat */, EVENT_DAY_FRIDAY, 1 /* Erster Freitag im Monat */, EVENTCYCLICTIMETYPE_ONCE, 0);