ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilMStListCoursesTableGUI Class Reference

Class ilMStListCoursesTableGUI. More...

+ Inheritance diagram for ilMStListCoursesTableGUI:
+ Collaboration diagram for ilMStListCoursesTableGUI:

Public Member Functions

 __construct (ilMStListCoursesGUI $parent_obj, $parent_cmd=ilMStListCoursesGUI::CMD_INDEX)
 
 initFilter ()
 Init filter. More...
 
 getSelectableColumns ()
 
 fillRow ($my_staff_course)
 
- 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)
 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

 parseData ()
 
 fillRowExcel (ilExcel $a_excel, &$a_row, $my_staff_course)
 
 fillRowCSV ($a_csv, $my_staff_course)
 
 getFieldValuesForExport (ilMStListCourse $my_staff_course)
 
- 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...
 

Protected Attributes

 $filter = array()
 
 $access
 
- 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
 
 $sel_buttons = []
 
- Protected Attributes inherited from ilTableGUI
 $tpl
 
 $lng
 

Private Member Functions

 addColumns ()
 

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
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilMStListCoursesTableGUI::__construct ( ilMStListCoursesGUI  $parent_obj,
  $parent_cmd = ilMStListCoursesGUI::CMD_INDEX 
)
Parameters
ilMStListCoursesGUI$parent_obj
string$parent_cmd

Definition at line 25 of file class.ilMStListCoursesTableGUI.php.

26 {
27 global $DIC;
28
29 $this->access = ilMyStaffAccess::getInstance();
30
31 $this->setPrefix('myst_lc');
32 $this->setFormName('myst_lc');
33 $this->setId('myst_lc');
34
35 parent::__construct($parent_obj, $parent_cmd, '');
36
37 $this->setRowTemplate('tpl.list_courses_row.html', "Services/MyStaff");
38 $this->setFormAction($DIC->ctrl()->getFormAction($parent_obj));
39 $this->setDefaultOrderDirection('desc');
40
41 $this->setShowRowsSelector(true);
42
43 $this->setEnableTitle(true);
44 $this->setDisableFilterHiding(true);
45 $this->setEnableNumInfo(true);
46
47 $this->setExportFormats(array( self::EXPORT_EXCEL, self::EXPORT_CSV ));
48
49 $this->setFilterCols(5);
50 $this->initFilter();
51
52 $this->addColumns();
53
54 $this->parseData();
55 }
setDisableFilterHiding($a_val=true)
Set disable filter hiding.
setShowRowsSelector($a_value)
Toggle rows-per-page selector.
setExportFormats(array $formats)
Set available export formats.
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...
setEnableTitle($a_enabletitle)
Set Enable Title.
setEnableNumInfo($a_val)
Set enable num info.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
setId($a_val)
Set id.
setFormName($a_formname="")
Set Form name.
setFilterCols($a_val)
Set filter columns.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
global $DIC
Definition: saml.php:7

References $DIC, ilTable2GUI\$parent_cmd, ilTable2GUI\$parent_obj, addColumns(), ilMyStaffAccess\getInstance(), initFilter(), parseData(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDisableFilterHiding(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExportFormats(), ilTable2GUI\setFilterCols(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), ilTable2GUI\setId(), ilTable2GUI\setPrefix(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setShowRowsSelector().

+ Here is the call graph for this function:

Member Function Documentation

◆ addColumns()

ilMStListCoursesTableGUI::addColumns ( )
private

Definition at line 254 of file class.ilMStListCoursesTableGUI.php.

255 {
256 global $DIC;
257
258 foreach ($this->getSelectableColumns() as $k => $v) {
259 if ($this->isColumnSelected($k)) {
260 if (isset($v['sort_field'])) {
261 $sort = $v['sort_field'];
262 } else {
263 $sort = null;
264 }
265 $this->addColumn($v['txt'], $sort, $v['width']);
266 }
267 }
268
269 //Actions
270 if (!$this->getExportMode()) {
271 $this->addColumn($DIC->language()->txt('actions'));
272 }
273 }
getExportMode()
Was export activated?
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.
isColumnSelected($a_col)
Is given column selected?

References $DIC, ilTable2GUI\addColumn(), ilTable2GUI\getExportMode(), getSelectableColumns(), and ilTable2GUI\isColumnSelected().

Referenced by __construct().

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

◆ fillRow()

ilMStListCoursesTableGUI::fillRow (   $my_staff_course)
Parameters
ilMStListCourse$my_staff_course

Reimplemented from ilTable2GUI.

Definition at line 279 of file class.ilMStListCoursesTableGUI.php.

280 {
281 global $DIC;
282
283 $propGetter = Closure::bind(function ($prop) {
284 return $this->$prop;
285 }, $my_staff_course, $my_staff_course);
286
287 foreach ($this->getSelectableColumns() as $k => $v) {
288 if ($this->isColumnSelected($k)) {
289 switch ($k) {
290 case 'usr_assinged_orgus':
291 $this->tpl->setCurrentBlock('td');
292 $this->tpl->setVariable('VALUE', strval(ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits($my_staff_course->getUsrId())));
293 $this->tpl->parseCurrentBlock();
294 break;
295 case 'usr_reg_status':
296 $this->tpl->setCurrentBlock('td');
297 $this->tpl->setVariable('VALUE', ilMStListCourse::getMembershipStatusText($my_staff_course->getUsrRegStatus()));
298 $this->tpl->parseCurrentBlock();
299 break;
300 case 'usr_lp_status':
301 $this->tpl->setCurrentBlock('td');
302 $this->tpl->setVariable('VALUE', ilMyStaffGUI::getUserLpStatusAsHtml($my_staff_course));
303 $this->tpl->parseCurrentBlock();
304 break;
305 default:
306 if ($propGetter($k) !== null) {
307 $this->tpl->setCurrentBlock('td');
308 $this->tpl->setVariable('VALUE', (is_array($propGetter($k)) ? implode(", ", $propGetter($k)) : $propGetter($k)));
309 $this->tpl->parseCurrentBlock();
310 } else {
311 $this->tpl->setCurrentBlock('td');
312 $this->tpl->setVariable('VALUE', ' ');
313 $this->tpl->parseCurrentBlock();
314 }
315 break;
316 }
317 }
318 }
319
320 $actions = new ilAdvancedSelectionListGUI();
321 $actions->setListTitle($DIC->language()->txt("actions"));
322 $actions->setAsynch(true);
323 $actions->setId($my_staff_course->getUsrId() . "-" . $my_staff_course->getCrsRefId());
324
325 $DIC->ctrl()->setParameterByClass(ilMStListCoursesGUI::class, 'mst_lco_usr_id', $my_staff_course->getUsrId());
326 $DIC->ctrl()->setParameterByClass(ilMStListCoursesGUI::class, 'mst_lco_crs_ref_id', $my_staff_course->getCrsRefId());
327
328 $actions->setAsynchUrl(str_replace("\\", "\\\\", $DIC->ctrl()
329 ->getLinkTarget($this->parent_obj, ilMStListCoursesGUI::CMD_GET_ACTIONS, "", true)));
330 $this->tpl->setVariable('ACTIONS', $actions->getHTML());
331 $this->tpl->parseCurrentBlock();
332 }
User interface class for advanced drop-down selection lists.
static getMembershipStatusText($status)
static getUserLpStatusAsHtml(ilMStListCourse $my_staff_course)

References $DIC, ilMStListCoursesGUI\CMD_GET_ACTIONS, ilMStListCourse\getMembershipStatusText(), getSelectableColumns(), ilMyStaffGUI\getUserLpStatusAsHtml(), and ilTable2GUI\isColumnSelected().

+ Here is the call graph for this function:

◆ fillRowCSV()

ilMStListCoursesTableGUI::fillRowCSV (   $a_csv,
  $my_staff_course 
)
protected
Parameters
ilCSVWriter$a_csv
ilMStListCourse$my_staff_course

Reimplemented from ilTable2GUI.

Definition at line 354 of file class.ilMStListCoursesTableGUI.php.

355 {
356 foreach ($this->getFieldValuesForExport($my_staff_course) as $k => $v) {
357 $a_csv->addColumn($v);
358 }
359 $a_csv->addRow();
360 }
getFieldValuesForExport(ilMStListCourse $my_staff_course)

References getFieldValuesForExport().

+ Here is the call graph for this function:

◆ fillRowExcel()

ilMStListCoursesTableGUI::fillRowExcel ( ilExcel  $a_excel,
$a_row,
  $my_staff_course 
)
protected
Parameters
ilExcel$a_excelexcel wrapper
int$a_row
ilMStListCourse$my_staff_course

Reimplemented from ilTable2GUI.

Definition at line 340 of file class.ilMStListCoursesTableGUI.php.

341 {
342 $col = 0;
343 foreach ($this->getFieldValuesForExport($my_staff_course) as $k => $v) {
344 $a_excel->setCell($a_row, $col, $v);
345 $col++;
346 }
347 }
setCell($a_row, $a_col, $a_value, $a_datatype=null)
Set cell value.

References getFieldValuesForExport(), and ilExcel\setCell().

+ Here is the call graph for this function:

◆ getFieldValuesForExport()

ilMStListCoursesTableGUI::getFieldValuesForExport ( ilMStListCourse  $my_staff_course)
protected
Parameters
ilMStListCourse$my_staff_course
Returns
array

Definition at line 368 of file class.ilMStListCoursesTableGUI.php.

369 {
370 $propGetter = Closure::bind(function ($prop) {
371 return $this->$prop;
372 }, $my_staff_course, $my_staff_course);
373
374 $field_values = array();
375 foreach ($this->getSelectedColumns() as $k => $v) {
376 switch ($k) {
377 case 'usr_assinged_orgus':
378 $field_values[$k] = ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits($my_staff_course->getUsrId());
379 break;
380 case 'usr_reg_status':
381 $field_values[$k] = ilMStListCourse::getMembershipStatusText($my_staff_course->getUsrRegStatus());
382 break;
383 case 'usr_lp_status':
384 $field_values[$k] = ilMyStaffGUI::getUserLpStatusAsText($my_staff_course);
385 break;
386 default:
387 $field_values[$k] = strip_tags($propGetter($k));
388 break;
389 }
390 }
391
392 return $field_values;
393 }
static getUserLpStatusAsText(ilMStListCourse $my_staff_course)
getSelectedColumns()
Get selected columns.

References ilMStListCourse\getMembershipStatusText(), ilTable2GUI\getSelectedColumns(), ilMyStaffGUI\getUserLpStatusAsText(), ilMStListCourse\getUsrId(), and ilMStListCourse\getUsrRegStatus().

Referenced by fillRowCSV(), and fillRowExcel().

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

◆ getSelectableColumns()

ilMStListCoursesTableGUI::getSelectableColumns ( )
Returns
array

Reimplemented from ilTable2GUI.

Definition at line 176 of file class.ilMStListCoursesTableGUI.php.

177 {
178 global $DIC;
179
180 $cols = array();
181
182 $arr_searchable_user_columns = ilUserSearchOptions::getSelectableColumnInfo();
183
184 $cols['crs_title'] = array(
185 'txt' => $DIC->language()->txt('crs_title'),
186 'default' => true,
187 'width' => 'auto',
188 'sort_field' => 'crs_title',
189 );
190 $cols['usr_reg_status'] = array(
191 'txt' => $DIC->language()->txt('member_status'),
192 'default' => true,
193 'width' => 'auto',
194 'sort_field' => 'reg_status',
195 );
196 if (ilObjUserTracking::_enabledLearningProgress() && $this->access->hasCurrentUserAccessToCourseLearningProgressForAtLeastOneUser()) {
197 $cols['usr_lp_status'] = array(
198 'txt' => $DIC->language()->txt('learning_progress'),
199 'default' => true,
200 'width' => 'auto',
201 'sort_field' => 'lp_status',
202 );
203 }
204
205 if ($arr_searchable_user_columns['login']) {
206 $cols['usr_login'] = array(
207 'txt' => $DIC->language()->txt('login'),
208 'default' => true,
209 'width' => 'auto',
210 'sort_field' => 'usr_login',
211 );
212 }
213 if ($arr_searchable_user_columns['firstname']) {
214 $cols['usr_firstname'] = array(
215 'txt' => $DIC->language()->txt('firstname'),
216 'default' => true,
217 'width' => 'auto',
218 'sort_field' => 'usr_firstname',
219 );
220 }
221 if ($arr_searchable_user_columns['lastname']) {
222 $cols['usr_lastname'] = array(
223 'txt' => $DIC->language()->txt('lastname'),
224 'default' => true,
225 'width' => 'auto',
226 'sort_field' => 'usr_lastname',
227 );
228 }
229
230 if ($arr_searchable_user_columns['email']) {
231 $cols['usr_email'] = array(
232 'txt' => $DIC->language()->txt('email'),
233 'default' => true,
234 'width' => 'auto',
235 'sort_field' => 'usr_email',
236 );
237 }
238
239 if ($arr_searchable_user_columns['org_units']) {
240 $cols['usr_assinged_orgus'] = array(
241 'txt' => $DIC->language()->txt('objs_orgu'),
242 'default' => true,
243 'width' => 'auto',
244 );
245 }
246
247 return $cols;
248 }
static _enabledLearningProgress()
check wether learing progress is enabled or not
static getSelectableColumnInfo($a_admin=false)
Get info of searchable fields for selectable columns in table gui.
$cols
Definition: xhr_table.php:11

References $cols, $DIC, ilObjUserTracking\_enabledLearningProgress(), and ilUserSearchOptions\getSelectableColumnInfo().

Referenced by addColumns(), and fillRow().

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

◆ initFilter()

ilMStListCoursesTableGUI::initFilter ( )

Init filter.

Overwrite this to initialize all filter input property objects.

Reimplemented from ilTable2GUI.

Definition at line 99 of file class.ilMStListCoursesTableGUI.php.

100 {
101 global $DIC;
102
103 $item = new ilTextInputGUI($DIC->language()->txt("crs_title"), "crs_title");
104 $this->addFilterItem($item);
105 $item->readFromSession();
106 $this->filter['crs_title'] = $item->getValue();
107
108 // course members
109 $item = new ilRepositorySelectorInputGUI($DIC->language()->txt("usr_filter_coursemember"), "course");
110 $item->setParent($this->getParentObject());
111 $item->setSelectText($DIC->language()->txt("mst_select_course"));
112 $item->setHeaderMessage($DIC->language()->txt("mst_please_select_course"));
113 $item->setClickableTypes(array( ilMyStaffAccess::DEFAULT_CONTEXT ));
114 $this->addFilterItem($item);
115 $item->readFromSession();
116 $item->setParent($this->getParentObject());
117 $this->filter["course"] = $item->getValue();
118
119 //membership status
120 $item = new ilSelectInputGUI($DIC->language()->txt('member_status'), 'memb_status');
121 $item->setOptions(array(
122 "" => $DIC->language()->txt("mst_opt_all"),
123 ilMStListCourse::MEMBERSHIP_STATUS_REQUESTED => $DIC->language()->txt('mst_memb_status_requested'),
124 ilMStListCourse::MEMBERSHIP_STATUS_WAITINGLIST => $DIC->language()->txt('mst_memb_status_waitinglist'),
125 ilMStListCourse::MEMBERSHIP_STATUS_REGISTERED => $DIC->language()->txt('mst_memb_status_registered'),
126 ));
127 $this->addFilterItem($item);
128 $item->readFromSession();
129 $this->filter["memb_status"] = $item->getValue();
130
131 if (ilObjUserTracking::_enabledLearningProgress() && $this->access->hasCurrentUserAccessToCourseLearningProgressForAtLeastOneUser()) {
132 //learning progress status
133 $item = new ilSelectInputGUI($DIC->language()->txt('learning_progress'), 'lp_status');
134 //+1 because LP_STATUS_NOT_ATTEMPTED_NUM is 0.
135 $item->setOptions(array(
136 "" => $DIC->language()->txt("mst_opt_all"),
141 ));
142 $this->addFilterItem($item);
143 $item->readFromSession();
144 $this->filter["lp_status"] = $item->getValue();
145 if ($this->filter["lp_status"]) {
146 $this->filter["lp_status"] = $this->filter["lp_status"] - 1;
147 }
148 }
149
150 //user
151 $item = new ilTextInputGUI($DIC->language()->txt("login") . "/" . $DIC->language()->txt("email") . "/" . $DIC->language()
152 ->txt("name"), "user");
153
154 $this->addFilterItem($item);
155 $item->readFromSession();
156 $this->filter['user'] = $item->getValue();
157
158 if (ilUserSearchOptions::_isEnabled('org_units')) {
160 $options[0] = $DIC->language()->txt('mst_opt_all');
161 foreach ($paths as $org_ref_id => $path) {
162 $options[$org_ref_id] = $path;
163 }
164 $item = new ilSelectInputGUI($DIC->language()->txt('obj_orgu'), 'org_unit');
165 $item->setOptions($options);
166 $this->addFilterItem($item);
167 $item->readFromSession();
168 $this->filter['org_unit'] = $item->getValue();
169 }
170 }
if(!isset( $_REQUEST[ 'ReturnTo'])) if(!isset($_REQUEST['AuthId'])) $options
Definition: as_login.php:20
const LP_STATUS_COMPLETED_NUM
const LP_STATUS_COMPLETED
const LP_STATUS_FAILED
const LP_STATUS_IN_PROGRESS_NUM
const LP_STATUS_NOT_ATTEMPTED_NUM
const LP_STATUS_FAILED_NUM
const LP_STATUS_NOT_ATTEMPTED
const LP_STATUS_IN_PROGRESS
static getTextRepresentationOfOrgUnits($sort_by_title=true)
Get ref id path array.
This class represents a repository selector in a property form.
This class represents a selection list property in a property form.
getParentObject()
Get parent object.
addFilterItem($a_input_item, $a_optional=false)
Add filter item.
This class represents a text property in a property form.

References $DIC, $options, $path, ilObjUserTracking\_enabledLearningProgress(), ilUserSearchOptions\_isEnabled(), ilTable2GUI\addFilterItem(), ilMyStaffAccess\DEFAULT_CONTEXT, ilTable2GUI\getParentObject(), ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits(), ilLPStatus\LP_STATUS_COMPLETED, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, ilMStListCourse\MEMBERSHIP_STATUS_REGISTERED, ilMStListCourse\MEMBERSHIP_STATUS_REQUESTED, and ilMStListCourse\MEMBERSHIP_STATUS_WAITINGLIST.

Referenced by __construct().

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

◆ parseData()

ilMStListCoursesTableGUI::parseData ( )
protected

Definition at line 61 of file class.ilMStListCoursesTableGUI.php.

62 {
63 global $DIC;
64
65 $this->setExternalSorting(true);
66 $this->setExternalSegmentation(true);
67 $this->setDefaultOrderField('crs_title');
68
69 $this->determineLimit();
71
72 $options = array(
73 'filters' => $this->filter,
74 'limit' => array(),
75 'count' => true,
76 'sort' => array(
77 'field' => $this->getOrderField(),
78 'direction' => $this->getOrderDirection(),
79 ),
80 );
81
82 $all_users_for_user = $this->access->getUsersForUser($DIC->user()->getId());
83
84 $count = ilMStListCourses::getData($all_users_for_user, $options);
85 $options['limit'] = array(
86 'start' => intval($this->getOffset()),
87 'end' => intval($this->getLimit()),
88 );
89 $options['count'] = false;
90 $data = ilMStListCourses::getData($all_users_for_user, $options);
91 $this->setMaxCount($count);
92 $this->setData($data);
93 }
static getData(array $arr_usr_ids=array(), array $options=array())
setExternalSorting($a_val)
Set external sorting.
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
setData($a_data)
set table data @access public
getLimit()
Get limit.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
getOffset()
Get offset.
setExternalSegmentation($a_val)
Set external segmentation.
determineLimit()
Determine the limit.
getOrderDirection()
Get order direction.
setMaxCount($a_max_count)
set max.

References ilTableGUI\$data, $DIC, $options, ilTable2GUI\determineLimit(), ilTable2GUI\determineOffsetAndOrder(), ilMStListCourses\getData(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilTable2GUI\setData(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), and ilTableGUI\setMaxCount().

Referenced by __construct().

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

Field Documentation

◆ $access

ilMStListCoursesTableGUI::$access
protected

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

◆ $filter

ilMStListCoursesTableGUI::$filter = array()
protected

Definition at line 14 of file class.ilMStListCoursesTableGUI.php.


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