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) | |
| Constructor. More... | |
| Public Member Functions inherited from ilTable2GUI | |
| __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="") | |
| 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) | |
| 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... | |
| 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 | |
| ilTableGUI ($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... | |
| 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 ($worksheet, &$a_row) | |
| Add meta information to excel export. More... | |
| fillHeaderExcel ($worksheet, &$a_row) | |
| Excel Version of Fill Header. More... | |
| fillRowExcel ($a_worksheet, &$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... | |
Detailed Description
List all active cron jobs.
Definition at line 12 of file class.ilCronManagerTableGUI.php.
Constructor & Destructor Documentation
◆ __construct()
| ilCronManagerTableGUI::__construct | ( | $a_parent_obj, | |
| $a_parent_cmd | |||
| ) |
Constructor.
- Parameters
-
ilObject $a_parent_obj string $a_parent_cmd
Definition at line 20 of file class.ilCronManagerTableGUI.php.
21 {
23
25
26 parent::__construct($a_parent_obj, $a_parent_cmd);
27
38
41
45
47 $this->setFormAction($ilCtrl->getFormAction($a_parent_obj, $a_parent_cmd));
48
49 $this->getItems();
50 }
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.
Definition: class.ilTable2GUI.php:1308
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
Definition: class.ilTable2GUI.php:508
setRowTemplate($a_template, $a_template_dir="")
Set row template.
Definition: class.ilTable2GUI.php:1125
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
Definition: class.ilTable2GUI.php:1136
setSelectAllCheckbox($a_select_all_checkbox)
Set the name of the checkbox that should be toggled with a select all button.
Definition: class.ilTable2GUI.php:1030
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
Definition: class.ilTable2GUI.php:935
References $ilCtrl, $lng, ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), getItems(), 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()
|
protected |
Standard Version of Fill Row.
Most likely to be overwritten by derived class.
- Parameters
-
array $a_set data array
Reimplemented from ilTable2GUI.
Definition at line 264 of file class.ilCronManagerTableGUI.php.
265 {
267
268 $this->tpl->setVariable("VAL_ID", $a_set["title"]);
269 $this->tpl->setVariable("VAL_JID", $a_set["job_id"]);
270
271 if($a_set["description"])
272 {
273 $this->tpl->setVariable("VAL_DESC", $a_set["description"]);
274 }
275
276 $this->tpl->setVariable("VAL_COMPONENT", $a_set["component"]);
277 $this->tpl->setVariable("VAL_SCHEDULE", $a_set["schedule"]);
278 $this->tpl->setVariable("VAL_STATUS", $a_set["status"]);
279 $this->tpl->setVariable("VAL_STATUS_INFO", $a_set["status_info"]);
280 $this->tpl->setVariable("VAL_RESULT", $a_set["result"]);
281 $this->tpl->setVariable("VAL_RESULT_INFO", $a_set["result_info"]);
282 if($a_set["last_run"] > time())
283 {
286
287 // job has pinged
288 if($a_set["alive_ts"] != $a_set["running_ts"])
289 {
290 $a_set["last_run"] .= "<br />(Ping: ".
292 }
293 }
294 else if($a_set["last_run"])
295 {
296 $a_set["last_run"] = ilDatePresentation::formatDate(new ilDateTime($a_set["last_run"], IL_CAL_UNIX));
297 }
298 $this->tpl->setVariable("VAL_LAST_RUN", $a_set["last_run"] ? $a_set["last_run"] : "-");
299
300
301 // actions
302
303 $actions = array();
304
305 if(!$a_set["running_ts"])
306 {
307 // reset
309 {
310 $actions[] = "reset";
311 }
312 // activate
313 else if(!$a_set["job_status"])
314 {
315 $actions[] = "activate";
316 }
317 // deactivate
318 else
319 {
320 if($a_set['is_manually_executable'])
321 {
322 $actions[] = 'run';
323 }
324 $actions[] = "deactivate";
325 }
326 // edit (schedule)
327 if($a_set["editable_schedule"] || $a_set["has_settings"])
328 {
329 $actions[] = "edit";
330 }
331
333
334 foreach($actions as $action)
335 {
336 $this->tpl->setCurrentBlock("action_bl");
337 $this->tpl->setVariable("URL_ACTION",
338 $ilCtrl->getLinkTarget($this->getParentObject(), $action));
340 $this->tpl->parseCurrentBlock();
341 }
342
344 }
345 }
static formatDate(ilDateTime $date)
Format a date @access public.
Definition: class.ilDatePresentation.php:113
References $ilCtrl, $lng, ilDatePresentation\formatDate(), ilTable2GUI\getParentObject(), IL_CAL_UNIX, and ilCronJobResult\STATUS_CRASHED.
Here is the call graph for this function:
◆ getItems()
|
protected |
Definition at line 229 of file class.ilCronManagerTableGUI.php.
230 {
231 global $ilPluginAdmin, $lng;
232
233 include_once "Services/User/classes/class.ilUserUtil.php";
234 include_once "Services/Cron/classes/class.ilCronJobResult.php";
235
236 // systems
239 {
241 $item["component"], $item["class"], $item["path"]);
242 if($job)
243 {
245 }
246 }
247
248 // plugins
251 {
252 $job = $item[0];
253 $item = $item[1];
254
255 $item["job_id"] = "pl__".$item["component"]."__".$job->getId();
257
259 }
260
262 }
parseJobToData(array $a_item, ilCronJob $job)
Definition: class.ilCronManagerTableGUI.php:52
static getCronJobData($a_id=null, $a_include_inactive=true)
Get cron job configuration/execution data.
Definition: class.ilCronManager.php:506
static getJobInstance($a_id, $a_component, $a_class, $a_path=null)
Get job instance (by job data)
Definition: class.ilCronManager.php:270
static getPluginJobs($a_only_active=false)
Definition: class.ilCronManager.php:466
References ilTableGUI\$data, $lng, ilCronManager\getCronJobData(), ilCronManager\getJobInstance(), ilCronManager\getPluginJobs(), parseJobToData(), and ilTable2GUI\setData().
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ parseJobToData()
|
protected |
Definition at line 52 of file class.ilCronManagerTableGUI.php.
53 {
54 global $lng;
55
56 $res = $a_item;
57
61
63 {
65 }
66
67 // schedule
69 {
70 // schedule type changed
71 if($a_item["schedule_type"])
72 {
74 }
75
79 }
80 else
81 {
82 // schedule type changed
83 if(!$a_item["schedule_type"])
84 {
88 $a_item["schedule_value"]);
89 }
90
92 }
93
94 switch($a_item["schedule_type"])
95 {
98 break;
99
102 break;
103
106 break;
107
110 break;
111
114 break;
115
118 break;
119
122 break;
123
126 break;
127 }
129
130 // status
131 if($a_item["job_status"])
132 {
134 }
135 else
136 {
138 }
139
140 $status_info = array();
141 if($a_item["job_status_ts"])
142 {
143 $status_info[] = ilDatePresentation::formatDate(new ilDateTime($a_item["job_status_ts"], IL_CAL_UNIX));
144 }
145 if(!$a_item["job_status_type"])
146 {
148 }
149 else
150 {
152 }
154
155 // result
157 if($a_item["job_result_status"])
158 {
159 switch($a_item["job_result_status"])
160 {
163 break;
164
167 break;
168
171 break;
172
175 break;
176
179 break;
180
183 break;
184 }
185 }
187
188 $result_info = array();
189 if($a_item["job_result_dur"])
190 {
191 $result_info[] = ($a_item["job_result_dur"]/1000)." sec";
192 }
193 if($a_item["job_result_message"])
194 {
195 $result_info[] = $a_item["job_result_message"];
196 }
197 if(DEVMODE && $a_item["job_result_code"]) // #11866
198 {
199 $result_info[] = $a_item["job_result_code"];
200 }
201 if(!$a_item["job_result_type"])
202 {
204 }
205 else
206 {
208 }
210
211 if($a_item["running_ts"])
212 {
214 }
215 else if($a_item["job_result_ts"])
216 {
218 }
219 else
220 {
222 }
223
225
227 }
const STATUS_INVALID_CONFIGURATION
Definition: class.ilCronJobResult.php:13
hasCustomSettings()
Has cron job any custom setting which can be edited?
Definition: class.ilCronJob.php:211
isManuallyExecutable()
Defines whether or not a cron job can be started manually.
Definition: class.ilCronJob.php:197
static updateJobSchedule(ilCronJob $a_job, $a_schedule_type, $a_schedule_value)
Update job schedule.
Definition: class.ilCronManager.php:684
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)
Default behaviour is:
Definition: class.ilUserUtil.php:42
References $lng, $res, $result, ilDatePresentation\formatDate(), ilCronJob\getDefaultScheduleType(), ilCronJob\getDefaultScheduleValue(), ilCronJob\getDescription(), ilUserUtil\getNamePresentation(), ilCronJob\getTitle(), ilCronJob\hasCustomSettings(), ilCronJob\hasFlexibleSchedule(), IL_CAL_UNIX, ilCronJob\isManuallyExecutable(), 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:
The documentation for this class was generated from the following file:
- Services/Cron/classes/class.ilCronManagerTableGUI.php
