API Documentation
\

\cron

Summary

Methods
Properties
Constants
all()
byId()
byClassAndFunction()
searchClassAndFunction()
clean()
nbCronRun()
nbProcess()
loadAvg()
setPidFile()
getPidFile()
jeeCronRun()
convertDateToCron()
preSave()
postInsert()
save()
remove()
start()
run()
running()
refresh()
stop()
halt()
isDue()
getNextRunDate()
getName()
toArray()
getId()
getClass()
getFunction()
getLastRun()
getState()
getEnable()
getPID()
setId()
setEnable()
setClass()
setFunction()
setLastRun()
setState()
setPID()
getSchedule()
setSchedule()
getDeamon()
setDeamon()
getTimeout()
setTimeout()
getDeamonSleepTime()
setDeamonSleepTime()
getOption()
getOnce()
setOption()
setOnce()
getCache()
setCache()
getChanged()
setChanged()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$id
$enable
$class
$function
$schedule
$timeout
$deamon
$deamonSleepTime
$option
$once
$_changed
N/A

Properties

$id

$id :

Type

$enable

$enable :

Type

$class

$class :

Type

$function

$function :

Type

$schedule

$schedule :

Type

$timeout

$timeout :

Type

$deamon

$deamon :

Type

$deamonSleepTime

$deamonSleepTime :

Type

$option

$option :

Type

$once

$once :

Type

$_changed

$_changed :

Type

Methods

all()

all(  $_order = false) : array

Return an array of all cron object

Parameters

$_order

Returns

array

byId()

byId(integer  $_id) : object

Get cron object associate to id

Parameters

integer $_id

Returns

object

byClassAndFunction()

byClassAndFunction(string  $_class, string  $_function, string  $_option = '') : object

Return cron object corresponding to parameters

Parameters

string $_class
string $_function
string $_option

Returns

object

searchClassAndFunction()

searchClassAndFunction(\type  $_class, \type  $_function, \type  $_option = '') : \type

Parameters

\type $_class
\type $_function
\type $_option

Returns

\type

clean()

clean()

nbCronRun()

nbCronRun() : integer

Return number of cron running

Returns

integer

nbProcess()

nbProcess() : integer

Return number of process on system

Returns

integer

loadAvg()

loadAvg() : array

Return array of load average

Returns

array

setPidFile()

setPidFile()

Set jeecron pid of current process

getPidFile()

getPidFile() : integer

Return the current pid of jeecron or empty if not running

Returns

integer

jeeCronRun()

jeeCronRun() : boolean

Return state of jeecron master

Returns

boolean

convertDateToCron()

convertDateToCron(  $_date)

Parameters

$_date

preSave()

preSave()

Check if cron object is valid before save

Throws

\Exception

postInsert()

postInsert()

save()

save() : boolean

Save cron object

Returns

boolean

remove()

remove(  $halt_before = true) : boolean

Remove cron object

Parameters

$halt_before

Returns

boolean

start()

start()

Set cron to be start

run()

run(  $_noErrorReport = false)

Launch cron (this method must be only call by jeecron master)

Parameters

$_noErrorReport

Throws

\Exception

running()

running() : boolean

Check if this cron is currently running

Returns

boolean

refresh()

refresh() : boolean

Refresh DB state of this cron

Returns

boolean

stop()

stop()

halt()

halt()

isDue()

isDue() : boolean

Check if it's time to launch cron

Returns

boolean

getNextRunDate()

getNextRunDate()

getName()

getName() : string

Get human name of cron

Returns

string

toArray()

toArray()

getId()

getId()

getClass()

getClass()

getFunction()

getFunction()

getLastRun()

getLastRun()

getState()

getState()

getEnable()

getEnable(  $_default)

Parameters

$_default

getPID()

getPID(  $_default = null)

Parameters

$_default

setId()

setId(  $_id)

Parameters

$_id

setEnable()

setEnable(  $_enable)

Parameters

$_enable

setClass()

setClass(  $_class)

Parameters

$_class

setFunction()

setFunction(  $_function)

Parameters

$_function

setLastRun()

setLastRun(  $lastRun)

Parameters

$lastRun

setState()

setState(  $state)

Parameters

$state

setPID()

setPID(  $pid = null)

Parameters

$pid

getSchedule()

getSchedule()

setSchedule()

setSchedule(  $_schedule)

Parameters

$_schedule

getDeamon()

getDeamon()

setDeamon()

setDeamon(  $_deamons)

Parameters

$_deamons

getTimeout()

getTimeout()

setTimeout()

setTimeout(  $_timeout)

Parameters

$_timeout

getDeamonSleepTime()

getDeamonSleepTime()

setDeamonSleepTime()

setDeamonSleepTime(  $_deamonSleepTime)

Parameters

$_deamonSleepTime

getOption()

getOption()

getOnce()

getOnce(  $_default)

Parameters

$_default

setOption()

setOption(  $_option)

Parameters

$_option

setOnce()

setOnce(  $_once)

Parameters

$_once

getCache()

getCache(  $_key = '',   $_default = '')

Parameters

$_key
$_default

setCache()

setCache(  $_key,   $_value = null)

Parameters

$_key
$_value

getChanged()

getChanged()

setChanged()

setChanged(  $_changed)

Parameters

$_changed