ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ilCronManagerTableGUI Class Reference
+ Inheritance diagram for ilCronManagerTableGUI:
+ Collaboration diagram for ilCronManagerTableGUI:

Public Member Functions

 __construct (ilCronManagerGUI $a_parent_obj, ilCronJobRepository $cronRepository, string $a_parent_cmd, bool $mayWrite=false)
 
 populate (ilCronJobCollection $collection)
 
- Public Member Functions inherited from ilTable2GUI
 __construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")
 
 setOpenFormTag (bool $a_val)
 
 getOpenFormTag ()
 
 setCloseFormTag (bool $a_val)
 
 getCloseFormTag ()
 
 determineLimit ()
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 
 isColumnSelected (string $col)
 
 getSelectedColumns ()
 
 resetOffset (bool $a_in_determination=false)
 
 initFilter ()
 
 getParentObject ()
 
 getParentCmd ()
 
 setTopAnchor (string $a_val)
 
 getTopAnchor ()
 
 setNoEntriesText (string $a_text)
 
 getNoEntriesText ()
 
 setIsDataTable (bool $a_val)
 
 getIsDataTable ()
 
 setEnableTitle (bool $a_enabletitle)
 
 getEnableTitle ()
 
 setEnableHeader (bool $a_enableheader)
 
 getEnableHeader ()
 
 setEnableNumInfo (bool $a_val)
 
 getEnableNumInfo ()
 
 setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
 
 setDescription (string $a_val)
 
 getDescription ()
 
 setOrderField (string $a_order_field)
 
 getOrderField ()
 
 setData (array $a_data)
 
 getData ()
 
 dataExists ()
 
 setPrefix (string $a_prefix)
 
 getPrefix ()
 
 addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)
 
 addFilterItemByMetaType (string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
 Add filter by standard type. More...
 
 getFilterItems (bool $a_optionals=false)
 
 getFilterItemByPostVar (string $a_post_var)
 
 setFilterCols (int $a_val)
 
 getFilterCols ()
 
 setDisableFilterHiding (bool $a_val=true)
 
 getDisableFilterHiding ()
 
 isFilterSelected (string $a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 
 determineSelectedFilters ()
 
 setCustomPreviousNext (string $a_prev_link, string $a_next_link)
 
 setFormAction (string $a_form_action, bool $a_multipart=false)
 
 getFormAction ()
 
 setFormName (string $a_name="")
 
 getFormName ()
 
 setId (string $a_val)
 
 getId ()
 
 setDisplayAsBlock (bool $a_val)
 
 getDisplayAsBlock ()
 
 setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)
 
 setExternalSorting (bool $a_val)
 
 getExternalSorting ()
 
 setFilterCommand (string $a_val, string $a_caption="")
 
 getFilterCommand ()
 
 setResetCommand (string $a_val, string $a_caption="")
 
 getResetCommand ()
 
 setExternalSegmentation (bool $a_val)
 
 getExternalSegmentation ()
 
 setRowTemplate (string $a_template, string $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField (string $a_defaultorderfield)
 
 getDefaultOrderField ()
 
 setDefaultOrderDirection (string $a_defaultorderdirection)
 
 getDefaultOrderDirection ()
 
 setDefaultFilterVisiblity (bool $a_status)
 
 getDefaultFilterVisibility ()
 
 clearCommandButtons ()
 
 addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")
 
 addCommandButtonInstance (ilButtonBase $a_button)
 
 addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')
 
 setCloseCommand (string $a_link)
 
 addMultiCommand (string $a_cmd, string $a_text)
 
 addHiddenInput (string $a_name, string $a_value)
 
 addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")
 
 setTopCommands (bool $a_val)
 
 getTopCommands ()
 
 addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)
 
 getNavParameter ()
 
 setOrderLink (string $key, string $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder (bool $a_omit_offset=false)
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering (string $a_field)
 Should this field be sorted numeric? More...
 
 render ()
 
 writeFilterToSession ()
 
 resetFilter ()
 
 fillFooter ()
 
 getLinkbar (string $a_num)
 
 fillHiddenRow ()
 
 fillActionRow ()
 
 setHeaderHTML (string $html)
 
 storeProperty (string $type, string $value)
 
 loadProperty (string $type)
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext (string $id)
 
 getContext ()
 
 setShowRowsSelector (bool $a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 
 setShowTemplates (bool $a_value)
 
 getShowTemplates ()
 
 restoreTemplate (string $a_name)
 Restore state from template. More...
 
 saveTemplate (string $a_name)
 Save current state as template. More...
 
 deleteTemplate (string $a_name)
 
 getLimit ()
 
 getOffset ()
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode (bool $a_value=false)
 
 getPrintMode ()
 
 getExportMode ()
 
 exportData (int $format, bool $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand (bool $a_value)
 
 setRowSelectorLabel (string $row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission (bool $a_val)
 
 getPreventDoubleSubmission ()
 
 setLimit (int $a_limit=0, int $a_default_limit=0)
 
- Public Member Functions inherited from ilTableGUI
 __construct (array $a_data=[], bool $a_global_tpl=true)
 
 setTemplate (ilTemplate $a_tpl)
 
 getTemplateObject ()
 
 setData (array $a_data)
 Set table data. More...
 
 getData ()
 
 setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
 
 setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")
 
 setHeaderNames (array $a_header_names)
 
 getColumnCount ()
 
 setHeaderVars (array $a_header_vars, array $a_header_params=[])
 
 setColumnWidth (array $a_column_width)
 set table column widths More...
 
 setOneColumnWidth (string $a_column_width, int $a_column_number)
 
 setMaxCount (int $a_max_count)
 set max. More...
 
 setLimit (int $a_limit=0, int $a_default_limit=0)
 set max. More...
 
 getLimit ()
 
 setPrefix (string $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) More...
 
 setOffset (int $a_offset)
 set dataset offset More...
 
 getOffset ()
 
 setOrderColumn (string $a_order_column="", string $a_default_column="")
 
 getOrderColumn ()
 
 setOrderDirection (string $a_order_direction)
 
 getOrderDirection ()
 
 setFooter (string $a_style, string $a_previous="", string $a_next="")
 
 enable (string $a_module_name)
 
 disable (string $a_module_name)
 
 sortData ()
 
 render ()
 
 renderHeader ()
 
 setOrderLink (string $key, string $order_dir)
 
 setStyle (string $a_element, string $a_style)
 
 getStyle (string $a_element)
 
 setBase (string $a_base)
 
 getBase ()
 
 getFormName ()
 get the name of the parent form More...
 
 setFormName (string $a_name="cmd")
 
 getSelectAllCheckbox ()
 get the name of the checkbox that should be toggled with a select all button More...
 
 setSelectAllCheckbox (string $a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton (string $btn_name, string $btn_value)
 

Protected Member Functions

 fillRow (array $a_set)
 
- Protected Member Functions inherited from ilTable2GUI
 getRequestedValues ()
 
 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, ilTableFilterItem $a_element)
 Check if filter element is based on adv md. More...
 
 fillRow (array $a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilTableFilterItem $a_item)
 Get current filter value. More...
 
 setFilterValue (ilTableFilterItem $a_item, $a_value)
 
 fillMetaExcel (ilExcel $a_excel, int &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel (ilExcel $a_excel, int &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV (ilCSVWriter $a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV (ilCSVWriter $a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV (ilCSVWriter $a_csv, array $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

ilCronJobRepository $cronRepository
 
bool $mayWrite
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 
- Static Public Member Functions inherited from ilTableGUI
static linkbar (string $AScript, int $AHits, int $ALimit, int $AOffset, array $AParams=array(), array $ALayout=array(), string $prefix='')
 
- 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
string $title = ""
 
string $icon = ""
 
string $icon_alt = ""
 
string $help_page = ""
 
string $help_icon = ""
 
string $help_icon_alt = ""
 
array $header_names = []
 
array $header_vars = []
 
array $linkbar_vars = []
 
array $data = []
 
int $column_count = 0
 
array $column_width = []
 
int $max_count = 0
 
int $limit = 0
 
bool $max_limit = false
 
int $offset = 0
 
string $order_column = ""
 
string $order_direction = ""
 
string $footer_style = ""
 
string $footer_previous = ""
 
string $footer_next = ""
 
bool $lang_support = true
 
bool $global_tpl = false
 
string $form_name = ""
 
string $select_all_checkbox = ""
 
array $action_buttons = []
 
string $prefix = ""
 
string $base = ""
 
array $enabled
 
array $styles
 
- Protected Attributes inherited from ilTable2GUI
string $requested_tmpl_delete
 
string $requested_tmpl_create
 
string $requested_nav_par2 = ""
 
string $requested_nav_par = ""
 
string $requested_nav_par1 = ""
 
ILIAS Table TableGUIRequest $table_request = null
 
array $selected_columns = []
 
ilCtrl $ctrl
 
object $parent_obj = null
 
string $parent_cmd = ""
 
string $close_command = ""
 
string $top_anchor = "il_table_top"
 
array $filters = array()
 
array $optional_filters = array()
 
string $filter_cmd = 'applyFilter'
 
string $reset_cmd = 'resetFilter'
 
int $filter_cols = 5
 
bool $ext_sort = false
 
bool $ext_seg = false
 
string $context = ""
 
array $mi_sel_buttons = []
 
bool $disable_filter_hiding = false
 
bool $top_commands = true
 
array $selectable_columns = array()
 
array $selected_column = array()
 
bool $show_templates = false
 
bool $show_rows_selector = true
 
bool $rows_selector_off = false
 
bool $nav_determined = false
 
bool $limit_determined = false
 
bool $filters_determined = false
 
bool $columns_determined = false
 
bool $open_form_tag = true
 
bool $close_form_tag = true
 
array $export_formats = []
 
int $export_mode = 0
 
bool $print_mode = false
 
bool $enable_command_for_all = false
 
bool $restore_filter = false
 
array $restore_filter_values = []
 
bool $default_filter_visibility = false
 
array $sortable_fields = array()
 
bool $prevent_double_submission = true
 
string $row_selector_label = ""
 
bool $select_all_on_top = false
 
array $sel_buttons = []
 
string $nav_value = ''
 
string $noentriestext = ''
 
string $css_row = ''
 
bool $display_as_block = false
 
string $description = ''
 
string $id = ""
 
bool $custom_prev_next = false
 
string $reset_cmd_txt = ""
 
string $defaultorderfield = ""
 
string $defaultorderdirection = ""
 
array $column = []
 
bool $datatable = false
 
bool $num_info = false
 
bool $form_multipart = false
 
array $row_data = []
 
string $order_field = ""
 
array $selected_filter = []
 
string $form_action = ""
 
string $formname = ""
 
string $sort_order = ""
 
array $buttons = []
 
array $multi = []
 
array $hidden_inputs = []
 
array $header_commands = []
 
string $row_template = ""
 
string $row_template_dir = ""
 
string $filter_cmd_txt = ""
 
string $custom_prev = ""
 
string $custom_next = ""
 
array $raw_post_data = null
 
ilGlobalTemplateInterface $main_tpl
 
- Protected Attributes inherited from ilTableGUI
string $sort_order
 
string $link_params
 
array $header_params
 
 $tpl
 
ilLanguage $lng
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilCronManagerTableGUI::__construct ( ilCronManagerGUI  $a_parent_obj,
ilCronJobRepository  $cronRepository,
string  $a_parent_cmd,
bool  $mayWrite = false 
)

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

References $cronRepository, $mayWrite, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setTitle().

31  {
32  $this->cronRepository = $cronRepository;
33  $this->mayWrite = $mayWrite;
34 
35  $this->setId('crnmng'); // #14526 / #16391
36 
37  parent::__construct($a_parent_obj, $a_parent_cmd);
38 
39  if ($this->mayWrite) {
40  $this->addColumn("", "", '1px', true);
41  }
42  $this->addColumn($this->lng->txt('cron_job_id'), 'title');
43  $this->addColumn($this->lng->txt('cron_component'), 'component');
44  $this->addColumn($this->lng->txt('cron_schedule'), 'schedule');
45  $this->addColumn($this->lng->txt('cron_status'), 'status');
46  $this->addColumn($this->lng->txt('cron_status_info'), '');
47  $this->addColumn($this->lng->txt('cron_result'), 'result');
48  $this->addColumn($this->lng->txt('cron_result_info'), '');
49  $this->addColumn($this->lng->txt('cron_last_run'), 'last_run');
50  if ($this->mayWrite) {
51  $this->addColumn($this->lng->txt('actions'), '');
52  }
53 
54  $this->setTitle($this->lng->txt('cron_jobs'));
55  $this->setDefaultOrderField('title');
56 
57  if ($this->mayWrite) {
58  $this->setSelectAllCheckbox('mjid');
59  $this->addMultiCommand('activate', $this->lng->txt('cron_action_activate'));
60  $this->addMultiCommand('deactivate', $this->lng->txt('cron_action_deactivate'));
61  $this->addMultiCommand('reset', $this->lng->txt('cron_action_reset'));
62  }
63 
64  $this->setRowTemplate('tpl.cron_job_row.html', 'Services/Cron');
65  $this->setFormAction($this->ctrl->getFormAction($a_parent_obj, $a_parent_cmd));
66  }
setFormAction(string $a_form_action, bool $a_multipart=false)
setSelectAllCheckbox(string $a_select_all_checkbox, bool $a_select_all_on_top=false)
setId(string $a_val)
setDefaultOrderField(string $a_defaultorderfield)
setRowTemplate(string $a_template, string $a_template_dir="")
Set row template.
setTitle(string $a_title, string $a_icon="", string $a_icon_alt="")
__construct(Container $dic, ilPlugin $plugin)
addColumn(string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)
addMultiCommand(string $a_cmd, string $a_text)
+ Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilCronManagerTableGUI::fillRow ( array  $a_set)
protected

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

References ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ilTable2GUI\getParentObject(), IL_CAL_UNIX, ILIAS\Repository\lng(), and ilCronJobResult\STATUS_CRASHED.

253  : void
254  {
255  if ($this->mayWrite) {
256  $this->tpl->setVariable('VAL_JID', $a_set['job_id']);
257  }
258  $this->tpl->setVariable('VAL_ID', $a_set['title']);
259 
260  if ($a_set['description']) {
261  $this->tpl->setVariable('VAL_DESC', $a_set['description']);
262  }
263 
264  $this->tpl->setVariable('VAL_COMPONENT', $a_set['component']);
265  $this->tpl->setVariable('VAL_SCHEDULE', $a_set['schedule']);
266  $this->tpl->setVariable('VAL_STATUS', $a_set['status']);
267  $this->tpl->setVariable('VAL_STATUS_INFO', $a_set['status_info']);
268  $this->tpl->setVariable('VAL_RESULT', $a_set['result']);
269  $this->tpl->setVariable('VAL_RESULT_INFO', $a_set['result_info']);
270  if ($a_set['last_run'] > time()) {
271  $a_set['last_run'] = $this->lng->txt('cron_running_since') . ' ' .
272  ilDatePresentation::formatDate(new ilDateTime($a_set['running_ts'], IL_CAL_UNIX));
273 
274  // job has pinged
275  if ($a_set['alive_ts'] !== $a_set['running_ts']) {
276  $a_set['last_run'] .= '<br />(Ping: ' .
277  ilDatePresentation::formatDate(new ilDateTime($a_set['alive_ts'], IL_CAL_UNIX)) . ')';
278  }
279  } elseif ($a_set['last_run']) {
280  $a_set['last_run'] = ilDatePresentation::formatDate(new ilDateTime($a_set['last_run'], IL_CAL_UNIX));
281  }
282  $this->tpl->setVariable('VAL_LAST_RUN', $a_set['last_run'] ?: '-');
283 
284  $actions = [];
285  if ($this->mayWrite && !$a_set['running_ts']) {
286  if ($a_set['job_result_status'] === ilCronJobResult::STATUS_CRASHED) {
287  $actions[] = 'reset';
288  } elseif (!$a_set['job_status']) {
289  $actions[] = 'activate';
290  } else {
291  if ($a_set['is_manually_executable']) {
292  $actions[] = 'run';
293  }
294  $actions[] = 'deactivate';
295  }
296 
297  if (
298  (isset($a_set['editable_schedule']) && $a_set['editable_schedule']) ||
299  (isset($a_set['has_settings']) && $a_set['has_settings'])
300  ) {
301  $actions[] = 'edit';
302  }
303 
304  $this->ctrl->setParameter($this->getParentObject(), 'jid', $a_set['job_id']);
305  foreach ($actions as $action) {
306  $this->tpl->setCurrentBlock('action_bl');
307  $this->tpl->setVariable(
308  'URL_ACTION',
309  $this->ctrl->getLinkTarget($this->getParentObject(), $action)
310  );
311  $this->tpl->setVariable('TXT_ACTION', $this->lng->txt('cron_action_' . $action));
312  $this->tpl->parseCurrentBlock();
313  }
314  $this->ctrl->setParameter($this->getParentObject(), 'jid', '');
315  }
316  }
static formatDate(ilDateTime $date, bool $a_skip_day=false, bool $a_include_wd=false, bool $include_seconds=false)
const IL_CAL_UNIX
+ Here is the call graph for this function:

◆ formatResult()

ilCronManagerTableGUI::formatResult ( ilCronJobEntity  $entity)
private

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

References ilCronJobEntity\getJobResultStatus(), ILIAS\Repository\lng(), ilCronJobResult\STATUS_CRASHED, ilCronJobResult\STATUS_FAIL, ilCronJobResult\STATUS_INVALID_CONFIGURATION, ilCronJobResult\STATUS_NO_ACTION, ilCronJobResult\STATUS_OK, and ilCronJobResult\STATUS_RESET.

Referenced by populate().

135  : string
136  {
137  $result = '-';
138  if ($entity->getJobResultStatus()) {
139  switch ($entity->getJobResultStatus()) {
141  $result = $this->lng->txt('cron_result_status_invalid_configuration');
142  break;
143 
145  $result = $this->lng->txt('cron_result_status_no_action');
146  break;
147 
149  $result = $this->lng->txt('cron_result_status_ok');
150  break;
151 
153  $result = $this->lng->txt('cron_result_status_crashed');
154  break;
155 
157  $result = $this->lng->txt('cron_result_status_reset');
158  break;
159 
161  $result = $this->lng->txt('cron_result_status_fail');
162  break;
163  }
164  }
165 
166  return $result;
167  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ formatResultInfo()

ilCronManagerTableGUI::formatResultInfo ( ilCronJobEntity  $entity)
private

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

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

Referenced by populate().

169  : string
170  {
171  $result_info = [];
172  if ($entity->getJobResultDuration()) {
173  $result_info[] = ($entity->getJobResultDuration() / 1000) . ' sec';
174  }
175 
176  // #23391 / #11866
177  $resultCode = $entity->getJobResultCode();
178  if (in_array($resultCode, ilCronJobResult::getCoreCodes(), true)) {
179  $result_info[] = $this->lng->txt('cro_job_rc_' . $resultCode);
180  } elseif ($entity->getJobResultMessage()) {
181  $result_info[] = $entity->getJobResultMessage();
182  }
183 
184  if (defined('DEVMODE') && DEVMODE && $resultCode) {
185  $result_info[] = $resultCode;
186  }
187 
188  if ($entity->getJobResultType()) {
189  $result_info[] = ilUserUtil::getNamePresentation($entity->getJobResultUsrId());
190  } else {
191  $result_info[] = $this->lng->txt('cron_changed_by_crontab');
192  }
193 
194  return implode('<br />', $result_info);
195  }
static getNamePresentation( $a_user_id, bool $a_user_image=false, bool $a_profile_link=false, string $a_profile_back_link="", bool $a_force_first_lastname=false, bool $a_omit_login=false, bool $a_sortable=true, bool $a_return_data_array=false, $a_ctrl_path="ilpublicuserprofilegui")
Default behaviour is:
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ formatSchedule()

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

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

References ilCronJobEntity\getEffectiveScheduleType(), ilCronJobEntity\getEffectiveScheduleValue(), ILIAS\Repository\lng(), 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().

68  : string
69  {
70  $schedule = '';
71  switch ($entity->getEffectiveScheduleType()) {
73  $schedule = $this->lng->txt('cron_schedule_daily');
74  break;
75 
77  $schedule = $this->lng->txt('cron_schedule_weekly');
78  break;
79 
81  $schedule = $this->lng->txt('cron_schedule_monthly');
82  break;
83 
85  $schedule = $this->lng->txt('cron_schedule_quarterly');
86  break;
87 
89  $schedule = $this->lng->txt('cron_schedule_yearly');
90  break;
91 
93  $schedule = sprintf(
94  $this->lng->txt('cron_schedule_in_minutes'),
95  $entity->getEffectiveScheduleValue()
96  );
97  break;
98 
100  $schedule = sprintf(
101  $this->lng->txt('cron_schedule_in_hours'),
102  $entity->getEffectiveScheduleValue()
103  );
104  break;
105 
107  $schedule = sprintf(
108  $this->lng->txt('cron_schedule_in_days'),
109  $entity->getEffectiveScheduleValue()
110  );
111  break;
112  }
113 
114  return $schedule;
115  }
const SCHEDULE_TYPE_IN_MINUTES
This will be replaced with an ENUM in ILIAS 9
const SCHEDULE_TYPE_MONTHLY
This will be replaced with an ENUM in ILIAS 9
const SCHEDULE_TYPE_WEEKLY
This will be replaced with an ENUM in ILIAS 9
const SCHEDULE_TYPE_IN_DAYS
This will be replaced with an ENUM in ILIAS 9
const SCHEDULE_TYPE_YEARLY
This will be replaced with an ENUM in ILIAS 9
const SCHEDULE_TYPE_DAILY
This will be replaced with an ENUM in ILIAS 9
const SCHEDULE_TYPE_QUARTERLY
This will be replaced with an ENUM in ILIAS 9
const SCHEDULE_TYPE_IN_HOURS
This will be replaced with an ENUM in ILIAS 9
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ formatStatusInfo()

ilCronManagerTableGUI::formatStatusInfo ( ilCronJobEntity  $entity)
private

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

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

Referenced by populate().

117  : string
118  {
119  $status_info = [];
120  if ($entity->getJobStatusTimestamp()) {
121  $status_info[] = ilDatePresentation::formatDate(
123  );
124  }
125 
126  if ($entity->getJobStatusType()) {
127  $status_info[] = ilUserUtil::getNamePresentation($entity->getJobStatusUsrId());
128  } else {
129  $status_info[] = $this->lng->txt('cron_changed_by_crontab');
130  }
131 
132  return implode('<br />', $status_info);
133  }
static getNamePresentation( $a_user_id, bool $a_user_image=false, bool $a_profile_link=false, string $a_profile_back_link="", bool $a_force_first_lastname=false, bool $a_omit_login=false, bool $a_sortable=true, bool $a_return_data_array=false, $a_ctrl_path="ilpublicuserprofilegui")
Default behaviour is:
static formatDate(ilDateTime $date, bool $a_skip_day=false, bool $a_include_wd=false, bool $include_seconds=false)
const IL_CAL_UNIX
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ populate()

ilCronManagerTableGUI::populate ( ilCronJobCollection  $collection)

Definition at line 197 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(), ILIAS\Repository\lng(), ilTable2GUI\setData(), and ilCronJobCollection\toArray().

197  : self
198  {
199  $this->setData(array_map(function (ilCronJobEntity $entity): array {
200  $row = [];
201 
202  $row['schedule'] = $this->formatSchedule($entity, $row);
203  $row['status'] = $this->lng->txt('cron_status_inactive');
204  if ($entity->getJobStatus()) {
205  $row['status'] = $this->lng->txt('cron_status_active');
206  }
207  $row['status_info'] = $this->formatStatusInfo($entity);
208  $row['result'] = $this->formatResult($entity);
209  $row['result_info'] = $this->formatResultInfo($entity);
210 
211  $row['last_run'] = null;
212  if ($entity->getRunningTimestamp()) {
213  $row['last_run'] = strtotime('+1year', $entity->getRunningTimestamp());
214  } elseif ($entity->getJobResultTimestamp()) {
215  $row['last_run'] = $entity->getJobResultTimestamp();
216  }
217 
218  $row['job_id'] = $entity->getJobId();
219  $row['component'] = $entity->getComponent();
220  if ($entity->isPlugin()) {
221  $row['job_id'] = 'pl__' . $row['component'] . '__' . $row['job_id'];
222  $row['component'] = $this->lng->txt('cmps_plugin') . '/' . $row['component'];
223  }
224 
225  $row['title'] = $entity->getEffectiveTitle();
226  $row['description'] = $entity->getJob()->getDescription();
227  $row['is_manually_executable'] = $entity->getJob()->isManuallyExecutable();
228  $row['has_settings'] = $entity->getJob()->hasCustomSettings();
229  $row['job_result_status'] = $entity->getJobResultStatus();
230  $row['job_status'] = $entity->getJobStatus();
231  $row['alive_ts'] = $entity->getAliveTimestamp();
232  $row['running_ts'] = $entity->getRunningTimestamp();
233 
234  if ($entity->getJob()->hasFlexibleSchedule()) {
235  $row['editable_schedule'] = true;
236  if (!$entity->getScheduleType()) {
237  $this->cronRepository->updateJobSchedule(
238  $entity->getJob(),
239  $entity->getEffectiveScheduleType(),
240  $entity->getEffectiveScheduleValue()
241  );
242  }
243  } elseif ($entity->getScheduleType()) {
244  $this->cronRepository->updateJobSchedule($entity->getJob(), null, null);
245  }
246 
247  return $row;
248  }, $collection->toArray()));
249 
250  return $this;
251  }
setData(array $a_data)
formatResultInfo(ilCronJobEntity $entity)
formatSchedule(ilCronJobEntity $entity, array $row)
formatStatusInfo(ilCronJobEntity $entity)
formatResult(ilCronJobEntity $entity)
+ Here is the call graph for this function:

Field Documentation

◆ $cronRepository

ilCronJobRepository ilCronManagerTableGUI::$cronRepository
private

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

Referenced by __construct().

◆ $mayWrite

bool ilCronManagerTableGUI::$mayWrite
private

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

Referenced by __construct().


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