• Home
• CronTask

PHP Class CronTask, glpi

It has all necessary methods to set time schedule of the task. By default schedule is equal to original cron's: '* * * * *' that means to run specified console command every minute. Original cron syntax is supported for methods hour(), minute(), day(), month(), dayOfWeek(), cron(). By calling unique() method you can set flag for task to be unique. It means that if task already running and it's time to run it again - new instance will not be executed (warning message would be added to logs). You can combine any methods to set desired schedule. For example, if you want to run command 'import' with action 'products' and params '--updateAll=1' every day at 18:00, you need to create next task instance: $task = new CronTask('import', 'products', array('updateAll' => 1)); $task->name('Import products (daily@18:00)')->daily()->hour(18); How to add and run task see CronService class description. Mostra file Open project: glpi-project/glpi Class Usage Examples

Public Properties

Property	Type	Description
$dohistory		From CommonDBTM
$rightname

Public Methods

Method	Description
Register ( $itemtype, $name, $frequency, $options = [] ) : boolean	Register new task for plugin (called by plugin during install)
Unregister ( $plugin ) : boolean	Unregister tasks for a plugin (call by glpi after uninstall)
addVolume ( $volume )	Increase the currently proccessed volume of a running task
callCron ( ) : nothing	Call cron if time since last launch elapsed
callCronForce ( ) : boolean	Call cron without time check
canDelete ( )
cleanDBonPurge ( )
cronCheckUpdate ( $task )	Cron job to check if a new version is available
cronCircularlogs ( $task )	Circular logs
cronGraph ( $task )	Garbage collector for cleaning graph files
cronInfo ( $name ) : array	get Cron description parameter for this class
cronLogs ( $task )	Clean log cron function
cronOptimize ( $task )	Clean log cron function
cronSession ( $task )	Garbage collector for expired file session
cronTemp ( $task )	Garbage collector for cleaning tmp files
cronWatcher ( $task )	Check zombie crontask
defineTabs ( $options = [] )
dropdownFrequency ( $name, $value )	Dropdown for frequency (interval between 2 actions)
dropdownState ( $name, $value, $display = true ) : nothing	Dropdown of state
end ( $retcode ) : boolean	Start a task, timer, stat, log, .
getDescription ( $id ) : string	Translate task description
getForbiddenActionsForMenu ( )
getForbiddenStandardMassiveAction ( )
getFromDBbyName ( $itemtype, $name ) : true	Read a Crontask by its name
getModeName ( $mode ) : string	Translate Mode to string
getNeedToRun ( $mode, $name = '' ) : false	read the first task which need to be run by cron
getParameterDescription ( ) : string	Translate task parameter description
getSearchOptions ( )
getSpecificMassiveActions ( $checkitem = NULL )
getSpecificValueToDisplay ( $field, $values, array $options = [] )
getSpecificValueToSelect ( $field, $name = '', $values = '', array $options = [] )
getStateName ( $state ) : string	Translate state to string
getTypeName ( $nb )
getUsedItemtypes ( ) : array	Get all itemtypes used
isDisabled ( ) : integer	Give a task state
launch ( $mode, $max = 1, $name = '' ) : the	Launch the need cron tasks
log ( $content )	Add a log message for a running task
processMassiveActionsForOneItemtype ( MassiveAction $ma, CommonDBTM $item, array $ids )
resetDate ( )	reset the next launch date => for a launch as soon as possible
resetState ( )	reset the current state
setVolume ( $volume )	Set the currently proccessed volume of a running task
showForm ( $ID, $options = [] ) : Nothing	Print the contact form
showHistory ( ) : nothing	Display list of a runned tasks
showHistoryDetail ( $logid ) : nothing	Display detail of a runned task
showStatistics ( ) : nothing	Display statistics of a task
signal ( $signo )	Signal handler callback
start ( ) : boolean	Start a task, timer, stat, log, .

Private Methods

Method	Description
get_lock ( ) : boolean	Get a global database lock for cron
release_lock ( )	Release the global database lock

Method Details

Property Details