Documentation

clearTemp extends cron
in package

Cronjob temp files cleanup

Tags
author

Stefan Seehafer sea75300@yahoo.de

Table of Contents

$asyncCurrent  : bool
Wird Cronjob aktuell asynchron ausgeführt
$cronName  : string
Name des Crons
$dbcon  : database
Datenbank-Objekt
$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
__construct()  : mixed
Konstruktor
checkTime()  : bool
Häufigkeit der Ausführung einschränken
createFromDbObject()  : mixed
Initialisiert anhand von Datenbank-Result-Set
getAsyncCurrent()  : bool
Gibt Status zurück, ob Cronjob aktuell asynchron ausgführt wird
getCronName()  : string
Gibt Cronjob-Name zurück
getCronNameLangVar()  : string
Gibt Sprachvariable zur Übersetzung des Cronjob-Namen zurück
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
run()  : mixed
Auszuführender Cron-Code
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

Properties

$asyncCurrent

Wird Cronjob aktuell asynchron ausgeführt

protected bool $asyncCurrent = false

$cronName

Name des Crons

protected string $cronName

$execinterval

Interval der Ausführung

protected int $execinterval
Tags
since
3.2.0

$execParams

add execution parameters

protected array<string|int, mixed> $execParams = false
Tags
since
5.0.0-b3

$isrunning

Cronjob is running

protected bool $isrunning
Tags
since
4.5.0-a1

$lastExecTime

Zeitpunkt der letzten Ausführung

protected int $lastExecTime

$modulekey

Module key string

protected string $modulekey
Tags
since
4.3.0

$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

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

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()

Gibt Sprachvariable zur Übersetzung des Cronjob-Namen zurück

public getCronNameLangVar() : string
Return values
string

getCronNamespace()

Gibt Klassen-Namepsace für Cronjob-Klassen zurück

public static getCronNamespace(string $cronId) : string
Parameters
$cronId : string
Tags
since
3.3
Return values
string

getExecParams()

Return execution parameter

public final getExecParams([string $val = '' ]) : mixed
Parameters
$val : string = ''
Tags
since
5.0.0-b3
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

run()

Auszuführender Cron-Code

public run() : mixed
Return values
mixed

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
since
5.0.0-b3
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

Search results