PHP Класс Yalesov\Cron\Service\Cron

handle cron job registration, validation, scheduling, running, and cleanup
Автор: yalesov ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$em Doctrine\ORM\EntityManager the Doctrine ORM Entity Manager
$failureLogLifetime how long to keep failed (missed / error) cron job logs
$maxRunningTime maximum running time of each cron job
$pending wrapped the Repo function here to implement a (crude) cache feature
$scheduleAhead how long ahead to schedule cron jobs
$scheduleLifetime how long before a scheduled job is considered missed
$successLogLifetime how long to keep successfully completed cron job logs

Открытые методы

Метод Описание
cleanLog ( ) : self delete old cron job logs
cleanup ( ) : self perform various cleanup work
getEm ( )
getFailureLogLifetime ( )
getMaxRunningtime ( )
getPending ( )
getScheduleAhead ( )
getScheduleLifeTime ( )
getSuccessLogLifetime ( )
process ( ) : self run cron jobs
recoverRunning ( )
register ( $code, $frequency, $callback, array $args = [] ) wrapper function
resetPending ( )
run ( ) : self main entry function
schedule ( ) : self schedule cron jobs
setEm ( EntityManager $em )
setFailureLogLifetime ( $failureLogLifetime )
setMaxRunningTime ( $maxRunningTime )
setScheduleAhead ( $scheduleAhead )
setScheduleLifetime ( $scheduleLifetime )
setSuccessLogLifetime ( $successLogLifetime )
tryLockJob ( Job $job ) : boolean try to acquire a lock on a cron job

Описание методов

cleanLog() публичный Метод

delete old cron job logs
public cleanLog ( ) : self
Результат self

cleanup() публичный Метод

perform various cleanup work
public cleanup ( ) : self
Результат self

getEm() публичный Метод

public getEm ( )

getFailureLogLifetime() публичный Метод

public getFailureLogLifetime ( )

getMaxRunningtime() публичный Метод

public getMaxRunningtime ( )

getPending() публичный Метод

public getPending ( )

getScheduleAhead() публичный Метод

public getScheduleAhead ( )

getScheduleLifeTime() публичный Метод

public getScheduleLifeTime ( )

getSuccessLogLifetime() публичный Метод

public getSuccessLogLifetime ( )

process() публичный Метод

run cron jobs
public process ( ) : self
Результат self

recoverRunning() публичный Метод

public recoverRunning ( )

register() публичный статический Метод

wrapper function
См. также: Registry::register()
public static register ( $code, $frequency, $callback, array $args = [] )
$args array

resetPending() публичный Метод

public resetPending ( )

run() публичный Метод

1. schedule new cron jobs 2. process cron jobs 3. cleanup old logs
public run ( ) : self
Результат self

schedule() публичный Метод

schedule cron jobs
public schedule ( ) : self
Результат self

setEm() публичный Метод

public setEm ( EntityManager $em )
$em Doctrine\ORM\EntityManager

setFailureLogLifetime() публичный Метод

public setFailureLogLifetime ( $failureLogLifetime )

setMaxRunningTime() публичный Метод

public setMaxRunningTime ( $maxRunningTime )

setScheduleAhead() публичный Метод

public setScheduleAhead ( $scheduleAhead )

setScheduleLifetime() публичный Метод

public setScheduleLifetime ( $scheduleLifetime )

setSuccessLogLifetime() публичный Метод

public setSuccessLogLifetime ( $successLogLifetime )

tryLockJob() публичный Метод

set a job to 'running' only if it is currently 'pending'
public tryLockJob ( Job $job ) : boolean
$job Yalesov\Cron\Entity\Job
Результат boolean

Описание свойств

$em защищенное свойство

the Doctrine ORM Entity Manager
protected EntityManager,Doctrine\ORM $em
Результат Doctrine\ORM\EntityManager

$failureLogLifetime защищенное свойство

how long to keep failed (missed / error) cron job logs
protected $failureLogLifetime

$maxRunningTime защищенное свойство

maximum running time of each cron job
protected $maxRunningTime

$pending защищенное свойство

wrapped the Repo function here to implement a (crude) cache feature
protected $pending

$scheduleAhead защищенное свойство

how long ahead to schedule cron jobs
protected $scheduleAhead

$scheduleLifetime защищенное свойство

how long before a scheduled job is considered missed
protected $scheduleLifetime

$successLogLifetime защищенное свойство

how long to keep successfully completed cron job logs
protected $successLogLifetime