Class CronTask

CronTask class

CommonGLPI

CommonDBTM

CronTask

Located at crontask.class.php

Methods summary
`public static array`	# `getForbiddenActionsForMenu( )` Get forbidden actions for menu : may be add / template Get forbidden actions for menu : may be add / template Returns array array of forbidden actions Since 0.85 Overrides `CommonGLPI::getForbiddenActionsForMenu()`
`public array`	# `getForbiddenStandardMassiveAction( )` Get the standard massive actions which are forbidden Get the standard massive actions which are forbidden Returns array an array of massive actions Since 0.84 This should be overloaded in Class Overrides `CommonDBTM::getForbiddenStandardMassiveAction()`
`public static string`	# `getTypeName( integer $nb = 0 )` Return the localized name of the current Type Should be overloaded in each new class Return the localized name of the current Type Should be overloaded in each new class Parameters `$nb` Number of items Returns string Overrides `CommonGLPI::getTypeName()`
`public array`	# `defineTabs( array $options = [] )` Define tabs to display Define tabs to display NB : Only called for existing object Parameters `$options` Options - withtemplate is a template view ? Returns array array containing the tabs Overrides `CommonGLPI::defineTabs()`
`public static boolean`	# `canDelete( )` Have I the global right to "delete" the Object Have I the global right to "delete" the Object May be overloaded if needed Returns boolean Overrides `CommonDBTM::canDelete()`
`public`	# `cleanDBonPurge( )` Actions done when item is deleted from the database Actions done when item is deleted from the database Overrides `CommonDBTM::cleanDBonPurge()`
`public boolean`	# `getFromDBbyName( string $itemtype, string $name )` Read a Crontask by its name Read a Crontask by its name Used by plugins to load its crontasks Parameters `$itemtype` itemtype of the crontask `$name` name of the task Returns boolean true if succeed else false
`public integer`	# `isDisabled( )` Give a task state Give a task state Returns integer 0 : task is enabled if disable : 1: by config, 2: by system lock, 3: by plugin
`public static string[]`	# `getUsedItemtypes( )` Get all itemtypes used Get all itemtypes used Returns string[]
`public`	# `signal( $signo )` Signal handler callback Signal handler callback Since 9.1
`public boolean`	# `start( )` Start a task, timer, stat, log, ... Start a task, timer, stat, log, ... Returns boolean : true if ok (not start by another)
`public`	# `setVolume( $volume )` Set the currently proccessed volume of a running task Set the currently proccessed volume of a running task Parameters `$volume`
`public`	# `addVolume( $volume )` Increase the currently proccessed volume of a running task Increase the currently proccessed volume of a running task Parameters `$volume`
`public boolean`	# `end( $retcode )` Start a task, timer, stat, log, ... Start a task, timer, stat, log, ... Parameters `$retcode` <0 : need to run again, 0:nothing to do, >0:ok Returns boolean : true if ok (not start by another)
`public`	# `log( $content )` Add a log message for a running task Add a log message for a running task Parameters `$content`
`public boolean`	# `getNeedToRun( integer $mode = 0, string $name = '' )` read the first task which need to be run by cron read the first task which need to be run by cron Parameters `$mode` 0 retrieve task configured for this mode <0 retrieve task allowed for this mode (force, no time check) `$name` one specify action Returns boolean false if no task to run
`public boolean`	# `showForm( integer $ID, array $options = [] )` Print the contact form Print the contact form Parameters `$ID` `$options` target filename : where to go when done. withtemplate boolean : template or basic item Returns boolean
`public`	# `resetDate( )` reset the next launch date => for a launch as soon as possible reset the next launch date => for a launch as soon as possible
`public`	# `resetState( )` reset the current state reset the current state
`public string`	# `getDescription( $id )` Translate task description Translate task description Parameters `$id` ID of the crontask Returns string
`public string`	# `getParameterDescription( )` Translate task parameter description Translate task parameter description Returns string
`public static string`	# `getStateName( $state )` Translate state to string Translate state to string Parameters `$state` integer Returns string
`public static string\|integer`	# `dropdownState( string $name, integer $value = 0, boolean $display = true )` Dropdown of state Dropdown of state Parameters `$name` select name `$value` default value `$display` display or get string Returns string\|integer HTML output, or random part of dropdown ID.
`public static string`	# `getModeName( $mode )` Translate Mode to string Translate Mode to string Parameters `$mode` integer Returns string
`private static Boolean`	# `get_lock( )` Get a global database lock for cron Get a global database lock for cron Returns Boolean
`private static`	# `release_lock( )` Release the global database lock Release the global database lock
`public static string\|boolean`	# `launch( integer $mode, integer $max = 1, string $name = '' )` Launch the need cron tasks Launch the need cron tasks Parameters `$mode` (internal/external, <0 to force) `$max` number of task to launch `$name` name of task to run Returns string\|boolean the name of last task launched, or false if execution not available
`public static boolean`	# `register( string $itemtype, string $name, integer $frequency, array $options = [] )` Register new task for plugin (called by plugin during install) Register new task for plugin (called by plugin during install) Parameters `$itemtype` itemtype of the plugin object `$name` task name `$frequency` execution frequency `$options` optional options (state, mode, allowmode, hourmin, hourmax, logs_lifetime, param, comment) Returns boolean
`public static boolean`	# `unregister( $plugin )` Unregister tasks for a plugin (call by glpi after uninstall) Unregister tasks for a plugin (call by glpi after uninstall) Parameters `$plugin` name of the plugin Returns boolean for success
`public`	# `showStatistics( )` Display statistics of a task Display statistics of a task
`public`	# `showHistory( )` Display list of a runned tasks Display list of a runned tasks
`public`	# `showHistoryDetail( $logid )` Display detail of a runned task Display detail of a runned task Parameters `$logid` crontasklogs_id
`public static string`	# `getSpecificValueToSelect( $field, $name = '', $values = '', array $options = [] )` Parameters `$field` `$name` '') `$values` '') `$options` array Returns string the string to display Since 0.84 Overrides `CommonDBTM::getSpecificValueToSelect()`
`public static string`	# `getSpecificValueToDisplay( string $field, string\|array $values, array $options = [] )` display a specific field value display a specific field value Parameters `$field` name of the field `$values` with the value to display or a Single value `$options` Array of options Returns string the string to display Since 0.83 Overrides `CommonDBTM::getSpecificValueToDisplay()`
`public array`	# `getSpecificMassiveActions( object $checkitem = null )` Get the specific massive actions Get the specific massive actions Parameters `$checkitem` link item to check right (default NULL) Returns array an array of massive actions Since 0.84 This should be overloaded in Class Overrides `CommonDBTM::getSpecificMassiveActions()`
`public static`	# `processMassiveActionsForOneItemtype( MassiveAction $ma, CommonDBTM $item, array $ids )` Class specific execution of the massive action (new system) by itemtypes Class specific execution of the massive action (new system) by itemtypes Parameters `$ma` the current massive action object `$item` the item on which apply the massive action `$ids` an array of the ids of the item on which apply the action Returns (direct submit to $ma object) Since 0.85 Overrides `CommonDBTM::processMassiveActionsForOneItemtype()`
`public array`	# `rawSearchOptions( )` Provides search options configuration. Do not rely directly on this, @see CommonDBTM::searchOptions instead. Provides search options configuration. Do not rely directly on this, @see CommonDBTM::searchOptions instead. Returns array a not indexed array of search options Since 9.3 This should be overloaded in Class See https://glpi-developer-documentation.rtfd.io/en/master/devapi/search.html Overrides `CommonDBTM::rawSearchOptions()`
`public static integer`	# `cronSession( CronTask $task )` Garbage collector for expired file session Garbage collector for expired file session Parameters `$task` for log Returns integer
`public static integer`	# `cronCircularlogs( CronTask $task )` Circular logs Circular logs Parameters `$task` for log Returns integer Since 0.85
`public static integer`	# `cronGraph( CronTask $task )` Garbage collector for cleaning graph files Garbage collector for cleaning graph files Parameters `$task` for log Returns integer
`public static integer`	# `cronTemp( CronTask $task )` Garbage collector for cleaning tmp files Garbage collector for cleaning tmp files Parameters `$task` for log Returns integer
`public static integer`	# `cronLogs( CronTask $task )` Clean log cron function Clean log cron function Parameters `$task` Returns integer
`public static integer`	# `cronCheckUpdate( CronTask $task )` Cron job to check if a new version is available Cron job to check if a new version is available Parameters `$task` for log Returns integer
`public static integer`	# `cronWatcher( CronTask $task )` Check zombie crontask Check zombie crontask Parameters `$task` for log Returns integer
`public static array`	# `cronInfo( $name )` get Cron description parameter for this class get Cron description parameter for this class Parameters `$name` name of the task Returns array of string
`public string\|integer`	# `dropdownFrequency( string $name, integer $value = 0 )` Dropdown for frequency (interval between 2 actions) Dropdown for frequency (interval between 2 actions) Parameters `$name` select name `$value` default value (default 0) Returns string\|integer HTML output, or random part of dropdown ID.
`public static boolean`	# `callCronForce( )` Call cron without time check Call cron without time check Returns boolean : true if launched
`public static`	# `callCron( )` Call cron if time since last launch elapsed Call cron if time since last launch elapsed

Methods inherited from CommonDBTM
__construct(), add(), addFiles(), addForwardEntity(), addMessageOnAddAction(), addMessageOnDeleteAction(), addMessageOnPurgeAction(), addMessageOnRestoreAction(), addMessageOnUpdateAction(), addNeededInfoToInput(), addToDB(), can(), canAddItem(), canCreate(), canCreateItem(), canDeleteItem(), canEdit(), canGlobal(), canMassiveAction(), canPurge(), canPurgeItem(), canUnrecurs(), canUpdate(), canUpdateItem(), canView(), canViewItem(), check(), checkEntity(), checkGlobal(), checkSpecificValues(), checkUnicity(), cleanDBonMarkDeleted(), cleanHistory(), cleanRelationData(), cleanRelationTable(), cleanTranslations(), clearSavedInput(), delete(), deleteByCriteria(), deleteChildrenAndRelationsFromDb(), deleteFromDB(), dropdown(), filterValues(), find(), forceTable(), forwardEntityInformations(), generateLinkContents(), getAutofillMark(), getComments(), getCompleteNameField(), getEmpty(), getEntityID(), getField(), getForeignKeyField(), getForeignKeyFieldsOf(), getFromDB(), getFromDBByCrit(), getFromDBByRequest(), getFromIter(), getFromResultSet(), getID(), getIndexName(), getItemEntity(), getLink(), getLinkURL(), getLinkedItems(), getLinkedItemsCount(), getLogTypeID(), getMassiveActionsForItemtype(), getName(), getNameField(), getNameID(), getOptions(), getPostAdditionalInfosForName(), getPreAdditionalInfosForName(), getRawCompleteName(), getRawName(), getRights(), getSearchOptionByField(), getSearchOptionIDByField(), getSearchOptionsToAdd(), getTable(), getTableField(), getTablesOf(), getUnallowedFieldsForUnicity(), getUnicityErrorMessage(), getUnicityFieldsToDisplayInErrorMessage(), getValueToDisplay(), getValueToSelect(), initForm(), isActive(), isDeleted(), isDynamic(), isEntityAssign(), isEntityForwardTo(), isField(), isNewID(), isNewItem(), isPrivate(), isRecursive(), isTemplate(), listTemplates(), maybeActive(), maybeDeleted(), maybeDynamic(), maybeLocated(), maybePrivate(), maybeRecursive(), maybeTemplate(), post_addItem(), post_deleteFromDB(), post_deleteItem(), post_getEmpty(), post_getFromDB(), post_purgeItem(), post_restoreItem(), post_updateItem(), pre_deleteItem(), pre_updateInDB(), prepareInputForAdd(), prepareInputForUpdate(), reset(), restore(), restoreInDB(), restoreInput(), saveInput(), searchOptions(), showDates(), showFormButtons(), showFormHeader(), showMassiveActionsSubForm(), unsetUndisclosedFields(), update(), updateInDB(), useDeletedToLockIfDynamic()

Methods inherited from CommonGLPI
addDefaultFormTab(), addStandardTab(), createTabEntry(), defineAllTabs(), display(), displayStandardTab(), displayTabContentForItem(), getAdditionalMenuContent(), getAdditionalMenuLinks(), getAdditionalMenuOptions(), getAvailableDisplayOptions(), getDisplayOptions(), getDisplayOptionsLink(), getErrorMessage(), getFormURL(), getFormURLWithID(), getMenuContent(), getMenuName(), getMenuShorcut(), getOtherTabs(), getSearchURL(), getTabNameForItem(), getTabsURL(), getType(), isLayoutExcludedPage(), isLayoutWithMain(), redirectToList(), registerStandardTab(), showDebugInfo(), showDislayOptions(), showNavigationHeader(), showPrimaryForm(), showTabsContent(), updateDisplayOptions()

Constants summary
`integer`	`STATE_DISABLE`	# `0`
`integer`	`STATE_WAITING`	# `1`
`integer`	`STATE_RUNNING`	# `2`
`integer`	`MODE_INTERNAL`	# `1`
`integer`	`MODE_EXTERNAL`	# `2`

Properties summary
`public boolean`	`$dohistory` Flag to determine whether or not changes must be logged into history. Flag to determine whether or not changes must be logged into history.	# `true`
`private static string`	`$lockname`	# `''`
`private float`	`$timer`	# `0.0`
`private integer`	`$startlog`	# `0`
`private integer`	`$volume`	# `0`
`public static string`	`$rightname` Rightname used to check rights to do actions on item. Rightname used to check rights to do actions on item.	# `'config'`

Properties inherited from CommonDBTM
`$additional_fields_for_dictionnary, $auto_message_on_action, $fields, $fkfield, $foreign_key_fields_of, $forward_entity_to, $get_item_to_display_tab, $history_blacklist, $no_form_page, $notable, $notificationqueueonaction, $plugins_forward_entity, $searchopt, $tables_of, $taborientation, $usenotepad`

Properties inherited from CommonGLPI
`$displaylist, $othertabs, $showdebug, $type`

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Class CronTask

Returns

Since

Overrides

Returns

Since

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Returns

Overrides

Overrides

Parameters

Returns

Returns

Returns

Since

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Returns

Since

See

Overrides

Parameters

Returns

Parameters

Returns

Since

Parameters