ILIAS  release_7 Revision v7.30-3-g800a261c036
All Data Structures Namespaces Files Functions Variables Modules Pages
ilCronManagerTableGUI Class Reference

List all active cron jobs. More...

+ Inheritance diagram for ilCronManagerTableGUI:
+ Collaboration diagram for ilCronManagerTableGUI:

Public Member Functions

 __construct (object $a_parent_obj, $a_parent_cmd, \ILIAS\DI\Container $dic=null, bool $mayWrite=false)
 ilCronManagerTableGUI constructor. More...
 
 populate (ilCronJobCollection $collection)
 
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 ilTable2GUI constructor. More...
 
 setOpenFormTag ($a_val)
 Set open form tag. More...
 
 getOpenFormTag ()
 Get open form tag. More...
 
 setCloseFormTag ($a_val)
 Set close form tag. More...
 
 getCloseFormTag ()
 Get close form tag. More...
 
 determineLimit ()
 Determine the limit. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 Determine selected columns. More...
 
 isColumnSelected ($a_col)
 Is given column selected? More...
 
 getSelectedColumns ()
 Get selected columns. More...
 
 executeCommand ()
 Execute command. More...
 
 resetOffset ($a_in_determination=false)
 Reset offset. More...
 
 initFilter ()
 Init filter. More...
 
 getParentObject ()
 Get parent object. More...
 
 getParentCmd ()
 Get parent command. More...
 
 setTopAnchor ($a_val)
 Set top anchor. More...
 
 getTopAnchor ()
 Get top anchor. More...
 
 setNoEntriesText ($a_text)
 Set text for an empty table. More...
 
 getNoEntriesText ()
 Get text for an empty table. More...
 
 setIsDataTable ($a_val)
 Set is data table. More...
 
 getIsDataTable ()
 Get is data table. More...
 
 setEnableTitle ($a_enabletitle)
 Set Enable Title. More...
 
 getEnableTitle ()
 Get Enable Title. More...
 
 setEnableHeader ($a_enableheader)
 Set Enable Header. More...
 
 getEnableHeader ()
 Get Enable Header. More...
 
 setEnableNumInfo ($a_val)
 Set enable num info. More...
 
 getEnableNumInfo ()
 Get enable num info. More...
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 Set title and title icon. More...
 
 setDescription ($a_val)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 setOrderField ($a_order_field)
 set order column More...
 
 getOrderField ()
 
 setData ($a_data)
 
 getData ()
 
 dataExists ()
 
 setPrefix ($a_prefix)
 
 getPrefix ()
 
 addFilterItem ($a_input_item, $a_optional=false)
 Add filter item. More...
 
 addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null)
 Add filter by standard type. More...
 
 getFilterItems ($a_optionals=false)
 Get filter items. More...
 
 getFilterItemByPostVar ($a_post_var)
 
 setFilterCols ($a_val)
 Set filter columns. More...
 
 getFilterCols ()
 Get filter columns. More...
 
 setDisableFilterHiding ($a_val=true)
 Set disable filter hiding. More...
 
 getDisableFilterHiding ()
 Get disable filter hiding. More...
 
 isFilterSelected ($a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 Get selected filters. More...
 
 determineSelectedFilters ()
 Determine selected filters. More...
 
 setCustomPreviousNext ($a_prev_link, $a_next_link)
 Set custom previous/next links. More...
 
 setFormAction ($a_form_action, $a_multipart=false)
 Set Form action parameter. More...
 
 getFormAction ()
 Get Form action parameter. More...
 
 setFormName ($a_formname="")
 Set Form name. More...
 
 getFormName ()
 Get Form name. More...
 
 setId ($a_val)
 Set id. More...
 
 getId ()
 Get element id. More...
 
 setDisplayAsBlock ($a_val)
 Set display as block. More...
 
 getDisplayAsBlock ()
 Get display as block. More...
 
 getSelectAllCheckbox ()
 Get the name of the checkbox that should be toggled with a select all button. More...
 
 setSelectAllCheckbox ($a_select_all_checkbox, $a_select_all_on_top=false)
 Set the name of the checkbox that should be toggled with a select all button. More...
 
 setExternalSorting ($a_val)
 Set external sorting. More...
 
 getExternalSorting ()
 Get external sorting. More...
 
 setFilterCommand ($a_val, $a_caption=null)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val, $a_caption=null)
 Set reset filter command. More...
 
 getResetCommand ()
 Get reset filter command. More...
 
 setExternalSegmentation ($a_val)
 Set external segmentation. More...
 
 getExternalSegmentation ()
 Get external segmentation. More...
 
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field. More...
 
 getDefaultOrderField ()
 Get Default order field. More...
 
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction. More...
 
 getDefaultOrderDirection ()
 Get Default order direction. More...
 
 setDefaultFilterVisiblity ($a_status)
 Set default filter visiblity. More...
 
 getDefaultFilterVisibility ()
 Get default filter visibility. More...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButtonBase $a_button)
 Add Command button instance. More...
 
 addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button. More...
 
 addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button for selected items. More...
 
 setCloseCommand ($a_link)
 Add command for closing table. More...
 
 addMultiCommand ($a_cmd, $a_text)
 Add Command button. More...
 
 addHiddenInput ($a_name, $a_value)
 Add Hidden Input field. More...
 
 addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
 Add Header Command (Link) (Image needed for now) More...
 
 setTopCommands ($a_val)
 Set top commands (display command buttons on top of table, too) More...
 
 getTopCommands ()
 Get top commands (display command buttons on top of table, too) More...
 
 addColumn ( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
 Add a column to the header. More...
 
 getNavParameter ()
 
 setOrderLink ($sort_field, $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder ($a_omit_offset=false)
 Determine offset and order. More...
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 render ()
 render table public More...
 
 writeFilterToSession ()
 Write filter values to session. More...
 
 resetFilter ()
 Reset filter. More...
 
 fillFooter ()
 Fill footer row. More...
 
 getLinkbar ($a_num)
 Get previous/next linkbar. More...
 
 fillHiddenRow ()
 
 fillActionRow ()
 Fill Action Row. More...
 
 setHeaderHTML ($html)
 set header html More...
 
 storeProperty ($type, $value)
 Store table property. More...
 
 loadProperty ($type)
 Load table property. More...
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext ($id)
 Set context. More...
 
 getContext ()
 Get context. More...
 
 setShowRowsSelector ($a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 Get rows-per-page selector state. More...
 
 setShowTemplates ($a_value)
 Toggle templates. More...
 
 getShowTemplates ()
 Get template state. More...
 
 restoreTemplate ($a_name)
 Restore state from template. More...
 
 saveTemplate ($a_name)
 Save current state as template. More...
 
 deleteTemplate ($a_name)
 Delete template. More...
 
 getLimit ()
 Get limit. More...
 
 getOffset ()
 Get offset. More...
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode ($a_value=false)
 Toogle print mode. More...
 
 getPrintMode ()
 Get print mode. More...
 
 getExportMode ()
 Was export activated? More...
 
 exportData ($format, $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand ($a_value)
 Enable actions for all entries in current result. More...
 
 setRowSelectorLabel ($row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission ($a_val)
 Set prevent double submission. More...
 
 getPreventDoubleSubmission ()
 Get prevent double submission. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 
- Public Member Functions inherited from ilTableGUI
 __construct ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate ($a_tpl)
 set template public More...
 
getTemplateObject ()
 
 setData ($a_data)
 set table data public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page public More...
 
 setHeaderNames ($a_header_names)
 set table header names public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars public More...
 
 setColumnWidth ($a_column_width)
 set table column widths public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width public More...
 
 setMaxCount ($a_max_count)
 set max. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
 getLimit ()
 Get limit. More...
 
 setPrefix ($a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) public More...
 
 setOffset ($a_offset)
 set dataset offset public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction public More...
 
 enable ($a_module_name)
 enables particular modules of table More...
 
 disable ($a_module_name)
 diesables particular modules of table More...
 
 sortData ()
 
 render ()
 render table public More...
 
 renderHeader ()
 
 setOrderLink ($key, $order_dir)
 
 setStyle ($a_element, $a_style)
 
 getStyle ($a_element)
 
 setBase ($a_base)
 Set Base script name (deprecated, only use this for workarounds). More...
 
 getBase ()
 Get Base script name (deprecated, only use this for workarounds). More...
 
 getFormName ()
 
 setFormName ($a_name="cmd")
 
 getSelectAllCheckbox ()
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton ($btn_name, $btn_value)
 

Protected Member Functions

 fillRow ($a_set)
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. More...
 
 isFilterVisible ()
 Check if filter is visible: manually shown (session, db) or default value set. More...
 
 isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, $a_element)
 Check if filter element is based on adv md. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value. More...
 
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value. More...
 
 fillMetaExcel (ilExcel $a_excel, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel (ilExcel $a_excel, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 

Private Member Functions

 formatSchedule (ilCronJobEntity $entity, array $row)
 
 formatStatusInfo (ilCronJobEntity $entity)
 
 formatResult (ilCronJobEntity $entity)
 
 formatResultInfo (ilCronJobEntity $entity)
 

Private Attributes

 $language
 
 $controller
 
 $mayWrite
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 
- Data Fields inherited from ilTable2GUI
const FILTER_TEXT = 1
 
const FILTER_SELECT = 2
 
const FILTER_DATE = 3
 
const FILTER_LANGUAGE = 4
 
const FILTER_NUMBER_RANGE = 5
 
const FILTER_DATE_RANGE = 6
 
const FILTER_DURATION_RANGE = 7
 
const FILTER_DATETIME_RANGE = 8
 
const FILTER_CHECKBOX = 9
 
const EXPORT_EXCEL = 1
 
const EXPORT_CSV = 2
 
const ACTION_ALL_LIMIT = 1000
 
- Data Fields inherited from ilTableGUI
 $title
 
 $icon
 
 $icon_alt
 
 $help_page
 
 $help_icon
 
 $help_icon_alt
 
 $header_names
 
 $header_vars
 
 $linkbar_vars
 
 $data
 
 $column_count
 
 $column_width
 
 $max_count
 
 $limit
 
 $max_limit = false
 
 $offset
 
 $order_column
 
 $order_direction
 
 $footer_style
 
 $footer_previous
 
 $footer_next
 
 $lang_support = true
 
 $global_tpl
 
 $form_name
 
 $select_all_checkbox
 
 $action_buttons
 
 $prefix
 
 $base = ""
 
 $enabled
 
 $styles
 
- Protected Attributes inherited from ilTable2GUI
 $ctrl
 
 $tpl
 
 $parent_obj
 
 $parent_cmd
 
 $close_command = ""
 
 $top_anchor = "il_table_top"
 
 $filters = array()
 
 $optional_filters = array()
 
 $filter_cmd = 'applyFilter'
 
 $reset_cmd = 'resetFilter'
 
 $filter_cols = 5
 
 $ext_sort = false
 
 $ext_seg = false
 
 $context = ""
 
 $mi_sel_buttons = []
 
 $disable_filter_hiding = false
 
 $selected_filter = false
 
 $top_commands = true
 
 $selectable_columns = array()
 
 $selected_column = array()
 
 $show_templates = false
 
 $show_rows_selector = true
 
 $rows_selector_off = false
 
 $nav_determined = false
 
 $limit_determined = false
 
 $filters_determined = false
 
 $columns_determined = false
 
 $open_form_tag = true
 
 $close_form_tag = true
 
 $export_formats = []
 
 $export_mode
 
 $print_mode
 
 $enable_command_for_all
 
 $restore_filter
 
 $restore_filter_values
 
 $default_filter_visibility = false
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 
 $select_all_on_top = false
 
 $sel_buttons = []
 
- Protected Attributes inherited from ilTableGUI
 $tpl
 
 $lng
 

Detailed Description

List all active cron jobs.

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 13 of file class.ilCronManagerTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilCronManagerTableGUI::__construct ( object  $a_parent_obj,
  $a_parent_cmd,
\ILIAS\DI\Container  $dic = null,
bool  $mayWrite = false 
)

ilCronManagerTableGUI constructor.

Parameters
object$a_parent_obj
$a_parent_cmd
\ILIAS\DI\Container | null$dic
bool$mayWrite

Definition at line 29 of file class.ilCronManagerTableGUI.php.

References $dic, $DIC, $mayWrite, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), language(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setTitle().

34  {
35  if ($dic === null) {
36  global $DIC;
37  $dic = $DIC;
38  }
39 
40  $this->language = $dic->language();
41  $this->controller = $dic->ctrl();
42  $this->mayWrite = $mayWrite;
43 
44  $this->setId('crnmng'); // #14526 / #16391
45 
46  parent::__construct($a_parent_obj, $a_parent_cmd);
47 
48  if ($this->mayWrite) {
49  $this->addColumn("", "", 1);
50  }
51  $this->addColumn($this->lng->txt('cron_job_id'), 'title');
52  $this->addColumn($this->lng->txt('cron_component'), 'component');
53  $this->addColumn($this->lng->txt('cron_schedule'), 'schedule');
54  $this->addColumn($this->lng->txt('cron_status'), 'status');
55  $this->addColumn($this->lng->txt('cron_status_info'), '');
56  $this->addColumn($this->lng->txt('cron_result'), 'result');
57  $this->addColumn($this->lng->txt('cron_result_info'), '');
58  $this->addColumn($this->lng->txt('cron_last_run'), 'last_run');
59  if ($this->mayWrite) {
60  $this->addColumn($this->lng->txt('actions'), '');
61  }
62 
63  $this->setTitle($this->lng->txt('cron_jobs'));
64  $this->setDefaultOrderField('title');
65 
66  if ($this->mayWrite) {
67  $this->setSelectAllCheckbox('mjid');
68  $this->addMultiCommand('activate', $this->language->txt('cron_action_activate'));
69  $this->addMultiCommand('deactivate', $this->language->txt('cron_action_deactivate'));
70  $this->addMultiCommand('reset', $this->language->txt('cron_action_reset'));
71  }
72 
73  $this->setRowTemplate('tpl.cron_job_row.html', 'Services/Cron');
74  $this->setFormAction($this->controller->getFormAction($a_parent_obj, $a_parent_cmd));
75  }
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
setId($a_val)
Set id.
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
setSelectAllCheckbox($a_select_all_checkbox, $a_select_all_on_top=false)
Set the name of the checkbox that should be toggled with a select all button.
global $DIC
Definition: goto.php:24
addMultiCommand($a_cmd, $a_text)
Add Command button.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
__construct(Container $dic, ilPlugin $plugin)
addColumn( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
Add a column to the header.
$dic
Definition: result.php:13
language()
Definition: language.php:2
+ Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilCronManagerTableGUI::fillRow (   $a_set)
protected

Definition at line 288 of file class.ilCronManagerTableGUI.php.

References ilDatePresentation\formatDate(), ilTable2GUI\getParentObject(), IL_CAL_UNIX, language(), and ilCronJobResult\STATUS_CRASHED.

289  {
290  if ($this->mayWrite) {
291  $this->tpl->setVariable('VAL_JID', $a_set['job_id']);
292  }
293  $this->tpl->setVariable('VAL_ID', $a_set['title']);
294 
295  if ($a_set['description']) {
296  $this->tpl->setVariable('VAL_DESC', $a_set['description']);
297  }
298 
299  $this->tpl->setVariable('VAL_COMPONENT', $a_set['component']);
300  $this->tpl->setVariable('VAL_SCHEDULE', $a_set['schedule']);
301  $this->tpl->setVariable('VAL_STATUS', $a_set['status']);
302  $this->tpl->setVariable('VAL_STATUS_INFO', $a_set['status_info']);
303  $this->tpl->setVariable('VAL_RESULT', $a_set['result']);
304  $this->tpl->setVariable('VAL_RESULT_INFO', $a_set['result_info']);
305  if ($a_set['last_run'] > time()) {
306  $a_set['last_run'] = $this->language->txt('cron_running_since') . ' ' .
307  ilDatePresentation::formatDate(new ilDateTime($a_set['running_ts'], IL_CAL_UNIX));
308 
309  // job has pinged
310  if ($a_set['alive_ts'] != $a_set['running_ts']) {
311  $a_set['last_run'] .= '<br />(Ping: ' .
312  ilDatePresentation::formatDate(new ilDateTime($a_set['alive_ts'], IL_CAL_UNIX)) . ')';
313  }
314  } elseif ($a_set['last_run']) {
315  $a_set['last_run'] = ilDatePresentation::formatDate(new ilDateTime($a_set['last_run'], IL_CAL_UNIX));
316  }
317  $this->tpl->setVariable('VAL_LAST_RUN', $a_set['last_run'] ? $a_set['last_run'] : '-');
318 
319  $actions = [];
320  if ($this->mayWrite && !$a_set['running_ts']) {
321  if ($a_set['job_result_status'] == ilCronJobResult::STATUS_CRASHED) {
322  $actions[] = 'reset';
323  } elseif (!$a_set['job_status']) {
324  $actions[] = 'activate';
325  } else {
326  if ($a_set['is_manually_executable']) {
327  $actions[] = 'run';
328  }
329  $actions[] = 'deactivate';
330  }
331 
332  if ($a_set['editable_schedule'] || $a_set['has_settings']) {
333  $actions[] = 'edit';
334  }
335 
336  $this->controller->setParameter($this->getParentObject(), 'jid', $a_set['job_id']);
337  foreach ($actions as $action) {
338  $this->tpl->setCurrentBlock('action_bl');
339  $this->tpl->setVariable(
340  'URL_ACTION',
341  $this->controller->getLinkTarget($this->getParentObject(), $action)
342  );
343  $this->tpl->setVariable('TXT_ACTION', $this->language->txt('cron_action_' . $action));
344  $this->tpl->parseCurrentBlock();
345  }
346  $this->controller->setParameter($this->getParentObject(), 'jid', '');
347  }
348  }
const IL_CAL_UNIX
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false, $include_seconds=false)
Format a date public.
getParentObject()
Get parent object.
language()
Definition: language.php:2
+ Here is the call graph for this function:

◆ formatResult()

ilCronManagerTableGUI::formatResult ( ilCronJobEntity  $entity)
private
Parameters
ilCronJobEntity$entity
Returns
string

Definition at line 158 of file class.ilCronManagerTableGUI.php.

References $result, ilCronJobEntity\getJobResultStatus(), language(), ilCronJobResult\STATUS_CRASHED, ilCronJobResult\STATUS_FAIL, ilCronJobResult\STATUS_INVALID_CONFIGURATION, ilCronJobResult\STATUS_NO_ACTION, ilCronJobResult\STATUS_OK, and ilCronJobResult\STATUS_RESET.

Referenced by populate().

158  : string
159  {
160  $result = '-';
161  if ($entity->getJobResultStatus()) {
162  switch ($entity->getJobResultStatus()) {
164  $result = $this->language->txt('cron_result_status_invalid_configuration');
165  break;
166 
168  $result = $this->language->txt('cron_result_status_no_action');
169  break;
170 
172  $result = $this->language->txt('cron_result_status_ok');
173  break;
174 
176  $result = $this->language->txt('cron_result_status_crashed');
177  break;
178 
180  $result = $this->language->txt('cron_result_status_reset');
181  break;
182 
184  $result = $this->language->txt('cron_result_status_fail');
185  break;
186  }
187  }
188 
189  return $result;
190  }
$result
language()
Definition: language.php:2
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ formatResultInfo()

ilCronManagerTableGUI::formatResultInfo ( ilCronJobEntity  $entity)
private
Parameters
ilCronJobEntity$entity
Returns
string

Definition at line 196 of file class.ilCronManagerTableGUI.php.

References ilCronJobResult\getCoreCodes(), ilCronJobEntity\getJobResultCode(), ilCronJobEntity\getJobResultDuration(), ilCronJobEntity\getJobResultMessage(), ilCronJobEntity\getJobResultType(), ilCronJobEntity\getJobResultUsrId(), ilUserUtil\getNamePresentation(), and language().

Referenced by populate().

196  : string
197  {
198  $result_info = [];
199  if ($entity->getJobResultDuration()) {
200  $result_info[] = ($entity->getJobResultDuration() / 1000) . ' sec';
201  }
202 
203  // #23391 / #11866
204  $resultCode = $entity->getJobResultCode();
205  if (in_array($resultCode, ilCronJobResult::getCoreCodes())) {
206  $result_info[] = $this->language->txt('cro_job_rc_' . $resultCode);
207  } elseif ($entity->getJobResultMessage()) {
208  $result_info[] = $entity->getJobResultMessage();
209  }
210 
211  if (defined('DEVMODE') && DEVMODE) {
212  $result_info[] = $resultCode;
213  }
214 
215  if ($entity->getJobResultType()) {
216  $result_info[] = ilUserUtil::getNamePresentation($entity->getJobResultUsrId());
217  } else {
218  $result_info[] = $this->language->txt('cron_changed_by_crontab');
219  }
220 
221  return implode('<br />', $result_info);
222  }
static getNamePresentation( $a_user_id, $a_user_image=false, $a_profile_link=false, $a_profile_back_link="", $a_force_first_lastname=false, $a_omit_login=false, $a_sortable=true, $a_return_data_array=false, $a_ctrl_path="ilpublicuserprofilegui")
Default behaviour is:
language()
Definition: language.php:2
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ formatSchedule()

ilCronManagerTableGUI::formatSchedule ( ilCronJobEntity  $entity,
array  $row 
)
private
Parameters
ilCronJobEntity$entity
array$row
Returns
string

Definition at line 82 of file class.ilCronManagerTableGUI.php.

References ilCronJobEntity\getEffectiveScheduleType(), ilCronJobEntity\getEffectiveScheduleValue(), language(), ilCronJob\SCHEDULE_TYPE_DAILY, ilCronJob\SCHEDULE_TYPE_IN_DAYS, ilCronJob\SCHEDULE_TYPE_IN_HOURS, ilCronJob\SCHEDULE_TYPE_IN_MINUTES, ilCronJob\SCHEDULE_TYPE_MONTHLY, ilCronJob\SCHEDULE_TYPE_QUARTERLY, ilCronJob\SCHEDULE_TYPE_WEEKLY, and ilCronJob\SCHEDULE_TYPE_YEARLY.

Referenced by populate().

82  : string
83  {
84  $schedule = '';
85  switch ($entity->getEffectiveScheduleType()) {
87  $schedule = $this->language->txt('cron_schedule_daily');
88  break;
89 
91  $schedule = $this->language->txt('cron_schedule_weekly');
92  break;
93 
95  $schedule = $this->language->txt('cron_schedule_monthly');
96  break;
97 
99  $schedule = $this->language->txt('cron_schedule_quarterly');
100  break;
101 
103  $schedule = $this->language->txt('cron_schedule_yearly');
104  break;
105 
107  $schedule = sprintf(
108  $this->language->txt('cron_schedule_in_minutes'),
109  $entity->getEffectiveScheduleValue()
110  );
111  break;
112 
114  $schedule = sprintf(
115  $this->language->txt('cron_schedule_in_hours'),
116  $entity->getEffectiveScheduleValue()
117  );
118  break;
119 
121  $schedule = sprintf(
122  $this->language->txt('cron_schedule_in_days'),
123  $entity->getEffectiveScheduleValue()
124  );
125  break;
126  }
127 
128  return $schedule;
129  }
const SCHEDULE_TYPE_IN_MINUTES
const SCHEDULE_TYPE_MONTHLY
const SCHEDULE_TYPE_WEEKLY
const SCHEDULE_TYPE_IN_DAYS
const SCHEDULE_TYPE_YEARLY
const SCHEDULE_TYPE_DAILY
const SCHEDULE_TYPE_QUARTERLY
language()
Definition: language.php:2
const SCHEDULE_TYPE_IN_HOURS
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ formatStatusInfo()

ilCronManagerTableGUI::formatStatusInfo ( ilCronJobEntity  $entity)
private
Parameters
ilCronJobEntity$entity
Returns
string
Exceptions
ilDateTimeException

Definition at line 136 of file class.ilCronManagerTableGUI.php.

References ilDatePresentation\formatDate(), ilCronJobEntity\getJobStatusTimestamp(), ilCronJobEntity\getJobStatusType(), ilCronJobEntity\getJobStatusUsrId(), ilUserUtil\getNamePresentation(), IL_CAL_UNIX, and language().

Referenced by populate().

136  : string
137  {
138  $status_info = [];
139  if ($entity->getJobStatusTimestamp()) {
140  $status_info[] = ilDatePresentation::formatDate(
142  );
143  }
144 
145  if ($entity->getJobStatusType()) {
146  $status_info[] = ilUserUtil::getNamePresentation($entity->getJobStatusUsrId());
147  } else {
148  $status_info[] = $this->language->txt('cron_changed_by_crontab');
149  }
150 
151  return implode('<br />', $status_info);
152  }
const IL_CAL_UNIX
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false, $include_seconds=false)
Format a date public.
static getNamePresentation( $a_user_id, $a_user_image=false, $a_profile_link=false, $a_profile_back_link="", $a_force_first_lastname=false, $a_omit_login=false, $a_sortable=true, $a_return_data_array=false, $a_ctrl_path="ilpublicuserprofilegui")
Default behaviour is:
language()
Definition: language.php:2
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ populate()

ilCronManagerTableGUI::populate ( ilCronJobCollection  $collection)
Parameters
ilCronJobCollection$collection
Returns
$this
Exceptions
ilDateTimeException

Definition at line 229 of file class.ilCronManagerTableGUI.php.

References formatResult(), formatResultInfo(), formatSchedule(), formatStatusInfo(), ilCronJobEntity\getAliveTimestamp(), ilCronJobEntity\getComponent(), ilCronJobEntity\getEffectiveScheduleType(), ilCronJobEntity\getEffectiveScheduleValue(), ilCronJobEntity\getEffectiveTitle(), ilCronJobEntity\getJob(), ilCronJobEntity\getJobId(), ilCronJobEntity\getJobResultStatus(), ilCronJobEntity\getJobResultTimestamp(), ilCronJobEntity\getJobStatus(), ilCronJobEntity\getRunningTimestamp(), ilCronJobEntity\getScheduleType(), ilCronJobEntity\isPlugin(), language(), ilTable2GUI\setData(), ilCronJobCollection\toArray(), and ilCronManager\updateJobSchedule().

229  : self
230  {
231  $this->setData(array_map(function (ilCronJobEntity $entity) : array {
232  $row = [];
233 
234  $row['schedule'] = $this->formatSchedule($entity, $row);
235  $row['status'] = $this->language->txt('cron_status_inactive');
236  if ($entity->getJobStatus()) {
237  $row['status'] = $this->language->txt('cron_status_active');
238  }
239  $row['status_info'] = $this->formatStatusInfo($entity);
240  $row['result'] = $this->formatResult($entity);
241  $row['result_info'] = $this->formatResultInfo($entity);
242 
243  $row['last_run'] = null;
244  if ($entity->getRunningTimestamp()) {
245  $row['last_run'] = strtotime('+1year', $entity->getRunningTimestamp());
246  } elseif ($entity->getJobResultTimestamp()) {
247  $row['last_run'] = $entity->getJobResultTimestamp();
248  }
249 
250  $row['job_id'] = $entity->getJobId();
251  $row['component'] = $entity->getComponent();
252  if ($entity->isPlugin()) {
253  $row['job_id'] = 'pl__' . $row['component'] . '__' . $row['job_id'];
254  $row['component'] = $this->language->txt('cmps_plugin') . '/' . $row['component'];
255  }
256 
257  $row['title'] = $entity->getEffectiveTitle();
258  $row['description'] = $entity->getJob()->getDescription();
259  $row['is_manually_executable'] = $entity->getJob()->isManuallyExecutable();
260  $row['has_settings'] = $entity->getJob()->hasCustomSettings();
261  $row['job_result_status'] = $entity->getJobResultStatus();
262  $row['job_status'] = $entity->getJobStatus();
263  $row['alive_ts'] = $entity->getAliveTimestamp();
264  $row['running_ts'] = $entity->getRunningTimestamp();
265 
266  if ($entity->getJob()->hasFlexibleSchedule()) {
267  $row['editable_schedule'] = true;
268  if (!$entity->getScheduleType()) {
270  $entity->getJob(),
271  $entity->getEffectiveScheduleType(),
272  $entity->getEffectiveScheduleValue()
273  );
274  }
275  } elseif ($entity->getScheduleType()) {
276  ilCronManager::updateJobSchedule($entity->getJob(), null, null);
277  }
278 
279  return $row;
280  }, $collection->toArray()));
281 
282  return $this;
283  }
formatResultInfo(ilCronJobEntity $entity)
formatSchedule(ilCronJobEntity $entity, array $row)
formatStatusInfo(ilCronJobEntity $entity)
Class ilCronJobEntity.
formatResult(ilCronJobEntity $entity)
static updateJobSchedule(ilCronJob $a_job, $a_schedule_type, $a_schedule_value)
Update job schedule.
language()
Definition: language.php:2
+ Here is the call graph for this function:

Field Documentation

◆ $controller

ilCronManagerTableGUI::$controller
private

Definition at line 18 of file class.ilCronManagerTableGUI.php.

◆ $language

ilCronManagerTableGUI::$language
private

Definition at line 16 of file class.ilCronManagerTableGUI.php.

◆ $mayWrite

ilCronManagerTableGUI::$mayWrite
private

Definition at line 20 of file class.ilCronManagerTableGUI.php.

Referenced by __construct().


The documentation for this class was generated from the following file: