Documentation

cronjob

Table of Contents

Functions

add_cronjob()  : mixed
Anlegen eines Cronjobs
delete_cronjob()  : mixed
Löschen eines Cronjobs
get_cronjobs()  : mixed
Auslesen der Cronjobs
update_cronjob()  : mixed
Bearbeiten eines Cronjobs

Functions

add_cronjob()

Anlegen eines Cronjobs

add_cronjob(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • protocol: Cronjob Protokoll: http|https
  • http_url: die Cronjob-URL
  • cronjob_comment: der Cronjobkommentar
  • minute: die ausführende Minute: */1-59|0-59|*
  • hour: die ausführende Stunde: */1-23|1-23|*
  • day_of_month: der ausführende Tag des Monats: 0-31|*
  • month: der ausführende Monat: *
  • day_of_week: der ausführende Wochentag: 0-7|* (Sonntag =0 oder =7)
  • http_user: der HTTP-Auth Benutzer (optional)
  • http_password: das HTTP-Auth Passwort (optional)
  • mail_address: die Mailadresse, welche die Bestätigungsmail erhält: RFC2822 (optional)
  • mail_condition: Bedingungswort: erscheint dieses in der Scriptausgab, so wird _keine_ E-Mail versendet (optional)
  • mail_subject: verwende cronjob_comment als E-Mail-Subject: default|comment (optional, default)
  • is_active: der Cronjob ist aktiv: Y|N (optional, default Y)
Tags
link

Beispiel

throwss

TRUE die Aktion wurde durchgeführt

throwss

missing_parameter ein Pflichtparameter fehlt

throwss

couldnt_get_kas_ressources

throwss

day_of_month_or_day_of_week_incorrect

throwss

day_of_month_syntax_incorrect

throwss

day_of_week_syntax_incorrect

throwss

hour_syntax_incorrect

throwss

http_password_syntax_incorrect

throwss

protocol_syntax_incorrect

throwss

http_url_syntax_incorrect

throwss

http_user_syntax_incorrect

throwss

is_active_syntax_incorrect

throwss

mail_address_syntax_incorrect

throwss

mail_condition_syntax_incorrect

throwss

max_cronjobs_reached

throwss

minute_syntax_incorrect

throwss

month_syntax_incorrect

throwss

time_not_allowed

delete_cronjob()

Löschen eines Cronjobs

delete_cronjob(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • cronjob_id: die zu löschende Cronjob ID, siehe get_cronjobs
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
in_progress

das KAS Objekt ist zZt noch in Bearbeitung

throws
cronjob_id_not_found
throws
cronjob_id_syntax_incorrect

get_cronjobs()

Auslesen der Cronjobs

get_cronjobs(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • cronjob_id: die ID des Cronjobs (optional)
Tags
link

Beispiel

throws
array_return

Array der Cronjobs

update_cronjob()

Bearbeiten eines Cronjobs

update_cronjob(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • cronjob_id: die zu bearbeitende Cronjob-ID
  • protocol: Cronjob Protokoll: http|https (optional
  • http_url: die Cronjob-URL (optional)
  • cronjob_comment: der Cronjobkommentar (optional)
  • minute: die ausführende Minute: */1-59|0-59|* (optional)
  • hour: die ausführende Stunde: */1-23|1-23|* (optional)
  • day_of_month: der ausführende Tag des Monats: 0-31|* (optional)
  • month: der ausführende Monat: * (optional)
  • day_of_week: der ausführende Wochentag: 0-7|* (Sonntag =0 oder =7, optional)
  • http_user: der HTTP-Auth Benutzer (optional)
  • http_password: das HTTP-Auth Passwort (optional)
  • mail_address: die Mailadresse, welche die Bestätigungsmail erhält: RFC2822 (optional)
  • mail_condition: Bedingungswort: erscheint dieses in der Scriptausgab, so wird _keine_ E-Mail versendet (optional)
  • mail_subject: verwende cronjob_comment als E-Mail-Subject: default|comment (optional)
  • is_active: der Cronjob ist aktiv: Y|N (optional)
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
in_progress

das KAS Objekt ist zZt noch in Bearbeitung

throws
nothing_to_do

es wurde nichts geändert

throws
cronjob_id_syntax_incorrect
throws
cronjob_not_found
throws
day_of_month_or_day_of_week_incorrect
throws
day_of_month_syntax_incorrect
throws
day_of_week_syntax_incorrect
throws
hour_syntax_incorrect
throws
http_password_syntax_incorrect
throws
protocol_syntax_incorrect
throws
http_url_syntax_incorrect
throws
http_user_syntax_incorrect
throws
is_active_syntax_incorrect
throws
mail_address_syntax_incorrect
throws
mail_condition_syntax_incorrect
throws
minute_syntax_incorrect
throws
month_syntax_incorrect
throws
time_not_allowed

        
On this page

Search results