cron
in package
implements
cron
Cronjob model base
Tags
Interfaces, Classes, Traits and Enums
- cron
- Cronjob-Interface
Table of Contents
- $asyncCurrent : bool
- Wird Cronjob aktuell asynchron ausgeführt
- $cronName : string
- Name des Crons
- $dbcon : database
- Datenbank-Objekt
- $events : events
- Events object
- $execinterval : int
- Interval der Ausführung
- $execParams : array<string|int, mixed>
- add execution parameters
- $isrunning : bool
- Cronjob is running
- $lastExecTime : int
- Zeitpunkt der letzten Ausführung
- $modulekey : string
- Module key string
- $returnData : mixed
- Daten, die von Cronjob zurückgegeben werden sollen
- $runAsync : bool
- asynchrone Ausführung über cronasync-AJAX-Controller deaktivieren, false wenn cronasync-AJAX nicht ausgführt werden soll
- $table : string
- Database table
- __construct() : mixed
- Konstruktor
- checkTime() : bool
- Häufigkeit der Ausführung einschränken
- createFromDbObject() : mixed
- Initialisiert anhand von Datenbank-Result-Set
- forceCancelation() : bool
- Is cronjob running longer than interval
- getAsyncCurrent() : bool
- Gibt Status zurück, ob Cronjob aktuell asynchron ausgführt wird
- getCronName() : string
- Gibt Cronjob-Name zurück
- getCronNameLangVar() : string
- Returns translatetable language variable from cronjob names
- getCronNamespace() : string
- Gibt Klassen-Namepsace für Cronjob-Klassen zurück
- getExecParams() : mixed
- Return execution parameter
- getIntervalTime() : int
- Interval-Dauer zurückgeben
- getLastExecTime() : int
- Gibt Zeitpunkt der letzten Ausführung des Cronjobs zurück
- getModuleKey() : string
- Returns module key string
- getNextExecTime() : int
- Zeitpunkt der nächsten Ausführung berechnen getLastExecTime() + getIntervalTime()
- getReturnData() : mixed
- Daten, die für Rückgabe vorgesehen sind abrufen
- getRunAsync() : bool
- Läuft Cronjob auch asynchron
- init() : mixed
- Initialisiert
- isRunning() : bool
- Check is cronjob is running
- setAsyncCurrent() : mixed
- Setzt Status, ob Cronjob aktuell asynchron ausgführt wird
- setExecinterval() : mixed
- Setzt Interval des Cronjobs
- setExecParams() : $this
- Sets execution parameter
- setFinished() : bool
- Removes file option for running cronjon
- setReturnData() : mixed
- Daten, die für Rückgabe vorgesehen sind setzen
- setRunning() : bool
- Set file option, that cronjob is running
- update() : bool
- Aktualisiert einen Artikel in der Datenbank
- updateLastExecTime() : int
- Gibt Zeitpunkt der letzten Ausführung des Cronjobs zurück
- submitMailNotification() : bool
- Creates email from a template
Properties
$asyncCurrent
Wird Cronjob aktuell asynchron ausgeführt
protected
bool
$asyncCurrent
= false
$cronName
Name des Crons
protected
string
$cronName
$dbcon
Datenbank-Objekt
protected
database
$dbcon
$events
Events object
protected
events
$events
$execinterval
Interval der Ausführung
protected
int
$execinterval
Tags
$execParams
add execution parameters
protected
array<string|int, mixed>
$execParams
= false
Tags
$isrunning
Cronjob is running
protected
bool
$isrunning
Tags
$lastExecTime
Zeitpunkt der letzten Ausführung
protected
int
$lastExecTime
$modulekey
Module key string
protected
string
$modulekey
Tags
$returnData
Daten, die von Cronjob zurückgegeben werden sollen
protected
mixed
$returnData
= null
$runAsync
asynchrone Ausführung über cronasync-AJAX-Controller deaktivieren, false wenn cronasync-AJAX nicht ausgführt werden soll
protected
bool
$runAsync
= true
$table
Database table
protected
string
$table
Methods
__construct()
Konstruktor
public
__construct([bool $init = true ]) : mixed
Parameters
- $init : bool = true
Return values
mixed —checkTime()
Häufigkeit der Ausführung einschränken
public
checkTime() : bool
Return values
bool —createFromDbObject()
Initialisiert anhand von Datenbank-Result-Set
public
createFromDbObject(object $data) : mixed
Parameters
- $data : object
Return values
mixed —forceCancelation()
Is cronjob running longer than interval
public
forceCancelation() : bool
Tags
Return values
bool —getAsyncCurrent()
Gibt Status zurück, ob Cronjob aktuell asynchron ausgführt wird
public
getAsyncCurrent() : bool
Return values
bool —getCronName()
Gibt Cronjob-Name zurück
public
getCronName() : string
Return values
string —getCronNameLangVar()
Returns translatetable language variable from cronjob names
public
getCronNameLangVar([string $label = '' ]) : string
Parameters
- $label : string = ''
Return values
string —getCronNamespace()
Gibt Klassen-Namepsace für Cronjob-Klassen zurück
public
static getCronNamespace(string $cronId) : string
Parameters
- $cronId : string
Tags
Return values
string —getExecParams()
Return execution parameter
public
final getExecParams([string $val = '' ]) : mixed
Parameters
- $val : string = ''
Tags
Return values
mixed —getIntervalTime()
Interval-Dauer zurückgeben
public
getIntervalTime() : int
Return values
int —getLastExecTime()
Gibt Zeitpunkt der letzten Ausführung des Cronjobs zurück
public
getLastExecTime() : int
Return values
int —getModuleKey()
Returns module key string
public
getModuleKey() : string
Return values
string —getNextExecTime()
Zeitpunkt der nächsten Ausführung berechnen getLastExecTime() + getIntervalTime()
public
getNextExecTime() : int
Return values
int —getReturnData()
Daten, die für Rückgabe vorgesehen sind abrufen
public
getReturnData() : mixed
Return values
mixed —getRunAsync()
Läuft Cronjob auch asynchron
public
getRunAsync() : bool
Return values
bool —init()
Initialisiert
public
init() : mixed
Return values
mixed —isRunning()
Check is cronjob is running
public
isRunning() : bool
Return values
bool —setAsyncCurrent()
Setzt Status, ob Cronjob aktuell asynchron ausgführt wird
public
setAsyncCurrent(bool $asyncCurrent) : mixed
Parameters
- $asyncCurrent : bool
Return values
mixed —setExecinterval()
Setzt Interval des Cronjobs
public
setExecinterval(int $execinterval) : mixed
Parameters
- $execinterval : int
Return values
mixed —setExecParams()
Sets execution parameter
public
final setExecParams(array<string|int, mixed> $execParams) : $this
Parameters
- $execParams : array<string|int, mixed>
Tags
Return values
$this —setFinished()
Removes file option for running cronjon
public
setFinished() : bool
Return values
bool —setReturnData()
Daten, die für Rückgabe vorgesehen sind setzen
public
setReturnData(mixed $returnData) : mixed
Parameters
- $returnData : mixed
Return values
mixed —setRunning()
Set file option, that cronjob is running
public
setRunning() : bool
Return values
bool —update()
Aktualisiert einen Artikel in der Datenbank
public
update() : bool
Return values
bool —updateLastExecTime()
Gibt Zeitpunkt der letzten Ausführung des Cronjobs zurück
public
updateLastExecTime() : int
Return values
int —submitMailNotification()
Creates email from a template
protected
submitMailNotification([array<string|int, mixed> $vars = [] ][, array<string|int, mixed> $html = false ][, array<string|int, mixed> $fromData = false ][, array<string|int, mixed> $attachments = [] ]) : bool
Parameters
- $vars : array<string|int, mixed> = []
- $html : array<string|int, mixed> = false
- $fromData : array<string|int, mixed> = false
- $attachments : array<string|int, mixed> = []