ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
ilCronManagerTableGUI Class Reference

List all active cron jobs. More...

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

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, \ILIAS\DI\Container $dic=null, bool $mayWrite=false)
 Constructor. More...
 
- 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)
 set table data @access public More...
 
 getData ()
 
 dataExists ()
 
 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) @access public More...
 
 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 @access 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)
 set max. More...
 
- Public Member Functions inherited from ilTableGUI
 __construct ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate ($a_tpl)
 set template @access public More...
 
getTemplateObject ()
 
 setData ($a_data)
 set table data @access public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title @access public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page @access public More...
 
 setHeaderNames ($a_header_names)
 set table header names @access public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns @access public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars @access public More...
 
 setColumnWidth ($a_column_width)
 set table column widths @access public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width @access 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) @access public More...
 
 setOffset ($a_offset)
 set dataset offset @access public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column @access public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction @access public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction @access 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 @access 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

 parseJobToData (array $a_item, ilCronJob $job)
 
 getItems ()
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
- 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 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 (   $a_parent_obj,
  $a_parent_cmd,
\ILIAS\DI\Container  $dic = null,
bool  $mayWrite = false 
)

Constructor.

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

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

32 {
33 if ($dic === null) {
34 global $DIC;
35 $dic = $DIC;
36 }
37
38 $this->language = $dic->language();
39 $this->controller = $dic->ctrl();
40 $this->mayWrite = $mayWrite;
41
42 $this->setId("crnmng"); // #14526 / #16391
43
44 parent::__construct($a_parent_obj, $a_parent_cmd);
45
46 if ($this->mayWrite) {
47 $this->addColumn("", "", 1);
48 }
49 $this->addColumn($this->lng->txt("cron_job_id"), "title");
50 $this->addColumn($this->lng->txt("cron_component"), "component");
51 $this->addColumn($this->lng->txt("cron_schedule"), "schedule");
52 $this->addColumn($this->lng->txt("cron_status"), "status");
53 $this->addColumn($this->lng->txt("cron_status_info"), "");
54 $this->addColumn($this->lng->txt("cron_result"), "result");
55 $this->addColumn($this->lng->txt("cron_result_info"), "");
56 $this->addColumn($this->lng->txt("cron_last_run"), "last_run");
57 if ($this->mayWrite) {
58 $this->addColumn($this->lng->txt("actions"), "");
59 }
60
61 $this->setTitle($this->lng->txt("cron_jobs"));
62 $this->setDefaultOrderField("title");
63
64 if ($this->mayWrite) {
65 $this->setSelectAllCheckbox("mjid");
66 $this->addMultiCommand("activate", $this->language->txt("cron_action_activate"));
67 $this->addMultiCommand("deactivate", $this->language->txt("cron_action_deactivate"));
68 $this->addMultiCommand("reset", $this->language->txt("cron_action_reset"));
69 }
70
71 $this->setRowTemplate("tpl.cron_job_row.html", "Services/Cron");
72 $this->setFormAction($this->controller->getFormAction($a_parent_obj, $a_parent_cmd));
73
74 $this->getItems();
75 }
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.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
addMultiCommand($a_cmd, $a_text)
Add Command button.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
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.
setId($a_val)
Set id.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
language()
Definition: language.php:2
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
$dic
Definition: result.php:13
$DIC
Definition: xapitoken.php:46

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

+ Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilCronManagerTableGUI::fillRow (   $a_set)
protected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters
array$a_setdata array

Reimplemented from ilTable2GUI.

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

272 {
273 if ($this->mayWrite) {
274 $this->tpl->setVariable("VAL_JID", $a_set["job_id"]);
275 }
276 $this->tpl->setVariable("VAL_ID", $a_set["title"]);
277
278 if ($a_set["description"]) {
279 $this->tpl->setVariable("VAL_DESC", $a_set["description"]);
280 }
281
282 $this->tpl->setVariable("VAL_COMPONENT", $a_set["component"]);
283 $this->tpl->setVariable("VAL_SCHEDULE", $a_set["schedule"]);
284 $this->tpl->setVariable("VAL_STATUS", $a_set["status"]);
285 $this->tpl->setVariable("VAL_STATUS_INFO", $a_set["status_info"]);
286 $this->tpl->setVariable("VAL_RESULT", $a_set["result"]);
287 $this->tpl->setVariable("VAL_RESULT_INFO", $a_set["result_info"]);
288 if ($a_set["last_run"] > time()) {
289 $a_set["last_run"] = $this->language->txt("cron_running_since") . " " .
290 ilDatePresentation::formatDate(new ilDateTime($a_set["running_ts"], IL_CAL_UNIX));
291
292 // job has pinged
293 if ($a_set["alive_ts"] != $a_set["running_ts"]) {
294 $a_set["last_run"] .= "<br />(Ping: " .
295 ilDatePresentation::formatDate(new ilDateTime($a_set["alive_ts"], IL_CAL_UNIX)) . ")";
296 }
297 } elseif ($a_set["last_run"]) {
298 $a_set["last_run"] = ilDatePresentation::formatDate(new ilDateTime($a_set["last_run"], IL_CAL_UNIX));
299 }
300 $this->tpl->setVariable("VAL_LAST_RUN", $a_set["last_run"] ? $a_set["last_run"] : "-");
301
302
303 // actions
304
305 $actions = array();
306
307 if ($this->mayWrite && !$a_set["running_ts"]) {
308 // reset
309 if ($a_set["job_result_status"] == ilCronJobResult::STATUS_CRASHED) {
310 $actions[] = "reset";
311 }
312 // activate
313 elseif (!$a_set["job_status"]) {
314 $actions[] = "activate";
315 }
316 // deactivate
317 else {
318 if ($a_set['is_manually_executable']) {
319 $actions[] = 'run';
320 }
321 $actions[] = "deactivate";
322 }
323 // edit (schedule)
324 if ($a_set["editable_schedule"] || $a_set["has_settings"]) {
325 $actions[] = "edit";
326 }
327
328 $this->controller->setParameter($this->getParentObject(), "jid", $a_set["job_id"]);
329
330 foreach ($actions as $action) {
331 $this->tpl->setCurrentBlock("action_bl");
332 $this->tpl->setVariable(
333 "URL_ACTION",
334 $this->controller->getLinkTarget($this->getParentObject(), $action)
335 );
336 $this->tpl->setVariable("TXT_ACTION", $this->language->txt("cron_action_" . $action));
337 $this->tpl->parseCurrentBlock();
338 }
339
340 $this->controller->setParameter($this->getParentObject(), "jid", "");
341 }
342 }
const IL_CAL_UNIX
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false, $include_seconds=false)
Format a date @access public.
@classDescription Date and time handling
getParentObject()
Get parent object.

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

+ Here is the call graph for this function:

◆ getItems()

ilCronManagerTableGUI::getItems ( )
protected

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

238 {
239 include_once "Services/User/classes/class.ilUserUtil.php";
240 include_once "Services/Cron/classes/class.ilCronJobResult.php";
241
242 // systems
244 foreach ($data as $idx => $item) {
246 $item["job_id"],
247 $item["component"],
248 $item["class"],
249 $item["path"]
250 );
251 if ($job) {
252 $data[$idx] = $this->parseJobToData($item, $job);
253 }
254 }
255
256 // plugins
257 $this->language->loadLanguageModule("cmps");
258 foreach (ilCronManager::getPluginJobs() as $item) {
259 $job = $item[0];
260 $item = $item[1];
261
262 $item["job_id"] = "pl__" . $item["component"] . "__" . $job->getId();
263 $item["component"] = $this->language->txt("cmps_plugin") . "/" . $item["component"];
264
265 $data[] = $this->parseJobToData($item, $job);
266 }
267
268 $this->setData($data);
269 }
parseJobToData(array $a_item, ilCronJob $job)
static getCronJobData($a_id=null, $a_include_inactive=true)
Get cron job configuration/execution data.
static getJobInstance($a_id, $a_component, $a_class, $a_path=null)
Get job instance (by job data)
static getPluginJobs($a_only_active=false)
setData($a_data)
set table data @access public

References ilTableGUI\$data, ilCronManager\getCronJobData(), ilCronManager\getJobInstance(), ilCronManager\getPluginJobs(), language(), parseJobToData(), and ilTable2GUI\setData().

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parseJobToData()

ilCronManagerTableGUI::parseJobToData ( array  $a_item,
ilCronJob  $job 
)
protected

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

78 {
79 $res = $a_item;
80
81 $res["title"] = $job->getTitle();
82 $res["description"] = $job->getDescription();
83 $res["has_settings"] = $job->hasCustomSettings();
84
85 if (!$res["title"]) {
86 $res["title"] = $a_item["job_id"];
87 }
88
89 // schedule
90 if (!$job->hasFlexibleSchedule()) {
91 // schedule type changed
92 if ($a_item["schedule_type"]) {
93 ilCronManager::updateJobSchedule($job, null, null);
94 }
95
96 $a_item["schedule_type"] = $job->getDefaultScheduleType();
97 $a_item["schedule_value"] = $job->getDefaultScheduleValue();
98 $res["editable_schedule"] = false;
99 } else {
100 // schedule type changed
101 if (!$a_item["schedule_type"]) {
102 $a_item["schedule_type"] = $job->getDefaultScheduleType();
103 $a_item["schedule_value"] = $job->getDefaultScheduleValue();
105 $job,
106 $a_item["schedule_type"],
107 $a_item["schedule_value"]
108 );
109 }
110
111 $res["editable_schedule"] = true;
112 }
113
114 switch ($a_item["schedule_type"]) {
116 $schedule = $this->language->txt("cron_schedule_daily");
117 break;
118
120 $schedule = $this->language->txt("cron_schedule_weekly");
121 break;
122
124 $schedule = $this->language->txt("cron_schedule_monthly");
125 break;
126
128 $schedule = $this->language->txt("cron_schedule_quarterly");
129 break;
130
132 $schedule = $this->language->txt("cron_schedule_yearly");
133 break;
134
136 $schedule = sprintf($this->language->txt("cron_schedule_in_minutes"), $a_item["schedule_value"]);
137 break;
138
140 $schedule = sprintf($this->language->txt("cron_schedule_in_hours"), $a_item["schedule_value"]);
141 break;
142
144 $schedule = sprintf($this->language->txt("cron_schedule_in_days"), $a_item["schedule_value"]);
145 break;
146 }
147 $res["schedule"] = $schedule;
148
149 // status
150 if ($a_item["job_status"]) {
151 $res["status"] = $this->language->txt("cron_status_active");
152 } else {
153 $res["status"] = $this->language->txt("cron_status_inactive");
154 }
155
156 $status_info = array();
157 if ($a_item["job_status_ts"]) {
158 $status_info[] = ilDatePresentation::formatDate(new ilDateTime($a_item["job_status_ts"], IL_CAL_UNIX));
159 }
160 if (!$a_item["job_status_type"]) {
161 $status_info[] = $this->language->txt("cron_changed_by_crontab");
162 } else {
163 $status_info[] = ilUserUtil::getNamePresentation($a_item["job_status_user_id"]);
164 }
165 $res["status_info"] = implode("<br />", $status_info);
166
167 // result
168 $result = "-";
169 if ($a_item["job_result_status"]) {
170 switch ($a_item["job_result_status"]) {
172 $result = $this->language->txt("cron_result_status_invalid_configuration");
173 break;
174
176 $result = $this->language->txt("cron_result_status_no_action");
177 break;
178
180 $result = $this->language->txt("cron_result_status_ok");
181 break;
182
184 $result = $this->language->txt("cron_result_status_crashed");
185 break;
186
188 $result = $this->language->txt("cron_result_status_reset");
189 break;
190
192 $result = $this->language->txt("cron_result_status_fail");
193 break;
194 }
195 }
196 $res["result"] = $result;
197
198 $result_info = array();
199 if ($a_item["job_result_dur"]) {
200 $result_info[] = ($a_item["job_result_dur"] / 1000) . " sec";
201 }
202
203 // #23391 / #11866
204 $resultCode = $a_item['job_result_code'];
205 if (in_array($resultCode, ilCronJobResult::getCoreCodes())) {
206 $result_info[] = $this->language->txt('cro_job_rc_' . $resultCode);
207 } else {
208 if ($a_item['job_result_message']) {
209 $result_info[] = $a_item['job_result_message'];
210 }
211 }
212
213 if (defined('DEVMODE') && DEVMODE) {
214 $result_info[] = $resultCode;
215 }
216
217 if (!$a_item["job_result_type"]) {
218 $result_info[] = $this->language->txt("cron_changed_by_crontab");
219 } else {
220 $result_info[] = ilUserUtil::getNamePresentation($a_item["job_result_user_id"]);
221 }
222 $res["result_info"] = implode("<br />", $result_info);
223
224 if ($a_item["running_ts"]) {
225 $res["last_run"] = strtotime("+1year", $a_item["running_ts"]);
226 } elseif ($a_item["job_result_ts"]) {
227 $res["last_run"] = $a_item["job_result_ts"];
228 } else {
229 $res["last_run"] = null;
230 }
231
232 $res['is_manually_executable'] = $job->isManuallyExecutable();
233
234 return $res;
235 }
$result
const SCHEDULE_TYPE_IN_DAYS
getDefaultScheduleType()
Get schedule type.
getDescription()
Get description.
const SCHEDULE_TYPE_IN_HOURS
getDefaultScheduleValue()
Get schedule value.
hasCustomSettings()
Has cron job any custom setting which can be edited?
const SCHEDULE_TYPE_IN_MINUTES
isManuallyExecutable()
Defines whether or not a cron job can be started manually.
const SCHEDULE_TYPE_WEEKLY
const SCHEDULE_TYPE_YEARLY
const SCHEDULE_TYPE_DAILY
hasFlexibleSchedule()
Can the schedule be configured?
const SCHEDULE_TYPE_QUARTERLY
const SCHEDULE_TYPE_MONTHLY
getTitle()
Get title.
static updateJobSchedule(ilCronJob $a_job, $a_schedule_type, $a_schedule_value)
Update job schedule.
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:
foreach($_POST as $key=> $value) $res

References $res, $result, ilDatePresentation\formatDate(), ilCronJobResult\getCoreCodes(), ilCronJob\getDefaultScheduleType(), ilCronJob\getDefaultScheduleValue(), ilCronJob\getDescription(), ilUserUtil\getNamePresentation(), ilCronJob\getTitle(), ilCronJob\hasCustomSettings(), ilCronJob\hasFlexibleSchedule(), IL_CAL_UNIX, ilCronJob\isManuallyExecutable(), 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, ilCronJob\SCHEDULE_TYPE_YEARLY, ilCronJobResult\STATUS_CRASHED, ilCronJobResult\STATUS_FAIL, ilCronJobResult\STATUS_INVALID_CONFIGURATION, ilCronJobResult\STATUS_NO_ACTION, ilCronJobResult\STATUS_OK, ilCronJobResult\STATUS_RESET, and ilCronManager\updateJobSchedule().

Referenced by getItems().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $controller

ilCronManagerTableGUI::$controller
private

Definition at line 19 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 21 of file class.ilCronManagerTableGUI.php.

Referenced by __construct().


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