ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilTrObjectUsersPropsTableGUI Class Reference

Learning progress table: One object, rows: users, columns: properties Example: A course, rows: members, columns: name, status, mark, ... More...

+ Inheritance diagram for ilTrObjectUsersPropsTableGUI:
+ Collaboration diagram for ilTrObjectUsersPropsTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, $a_obj_id, $a_ref_id, $a_print_view=false)
 Constructor. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 getItems ()
 Get user items. More...
 
 initFilter ()
 Init filter. More...
 
- Public Member Functions inherited from ilLPTableBaseGUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 Constructor. More...
 
 executeCommand ()
 Execute command. More...
 
 searchFilterListener ($a_ref_id, $a_data)
 Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED @access public. More...
 
 initFilter ($a_split_learning_resources=false, $a_include_no_status_filter=true)
 Init filter. More...
 
 getCurrentFilter ($as_query=false)
 
- 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

 fillRow ($data)
 Fill table row. More...
 
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel ($worksheet, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 
- Protected Member Functions inherited from ilLPTableBaseGUI
 sendMail (array $a_user_ids, $a_parent_obj, $a_parent_cmd)
 
 searchObjects (array $filter, $permission, array $preset_obj_ids=null, $a_check_lp_activation=true)
 Search objects that match current filters. More...
 
 buildPath ($ref_ids)
 Build path with deep-link. More...
 
 getPossibleTypes ($a_split_learning_resources=false, $a_include_digilib=false, $a_allow_undefined_lp=false)
 Get possible subtypes. More...
 
 parseValue ($id, $value, $type)
 
 isPercentageAvailable ($a_obj_id)
 
 parseTitle ($a_obj_id, $action, $a_user_id=false)
 
 getExportMeta ()
 Build export meta data. More...
 
 fillMetaExcel ($worksheet, &$a_row)
 Add meta information to excel export. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 showTimingsWarning ($a_ref_id, $a_user_id)
 
 formatSeconds ($seconds, $a_shorten_zero=false)
 
 anonymizeValue ($a_value, $a_force_number=false)
 
 buildValueScale ($a_max_value, $a_anonymize=false, $a_format_seconds=false)
 
 getMonthsFilter ($a_short=false)
 
 getMonthsYear ($a_year=null, $a_short=false)
 
 getSelectableUserColumns ($a_in_course=false, $a_in_group=false)
 
- 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...
 

Protected Attributes

 $user_fields
 
 $filter
 
 $in_course
 
 $in_group
 
 $has_edit
 
 $has_collection
 
 $has_multi
 
- Protected Attributes inherited from ilLPTableBaseGUI
 $filter
 
 $anonymized
 
- Protected Attributes inherited from ilTable2GUI
 $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 = null
 
 $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
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 

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 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

Learning progress table: One object, rows: users, columns: properties Example: A course, rows: members, columns: name, status, mark, ...

PD, Personal Learning Progress -> UserObjectsProps PD, Learning Progress of Users -> UserAggObjectsProps Crs, Learnign Progress of Participants -> ObjectUsersProps Details -> UserObjectsProps

More: PropUsersObjects (Grading Overview in Course)

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

@ilCtrl_Calls ilTrObjectUsersPropsTableGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilTrObjectUsersPropsTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
  $a_obj_id,
  $a_ref_id,
  $a_print_view = false 
)

Constructor.

Definition at line 36 of file class.ilTrObjectUsersPropsTableGUI.php.

37 {
38 global $ilCtrl, $ilUser, $tree, $rbacsystem;
39
40 $this->setId("troup");
41 $this->obj_id = $a_obj_id;
42 $this->ref_id = $a_ref_id;
43 $this->type = ilObject::_lookupType($a_obj_id);
44
45 $this->in_group = $tree->checkForParentType($this->ref_id, "grp");
46 if($this->in_group)
47 {
48 $this->in_group = ilObject::_lookupObjId($this->in_group);
49 }
50 else
51 {
52 $this->in_course = $tree->checkForParentType($this->ref_id, "crs");
53 if($this->in_course)
54 {
55 $this->in_course = ilObject::_lookupObjId($this->in_course);
56 }
57 }
58
59 parent::__construct($a_parent_obj, $a_parent_cmd);
60
61 $this->parseTitle($a_obj_id, "trac_participants");
62
63 if($a_print_view)
64 {
65 $this->setPrintMode(true);
66 }
67
68 if(!$this->getPrintMode())
69 {
70 // see ilObjCourseGUI::addMailToMemberButton()
71 include_once "Services/Mail/classes/class.ilMail.php";
72 $mail = new ilMail($ilUser->getId());
73 if($rbacsystem->checkAccess("internal_mail", $mail->getMailObjectReferenceId()))
74 {
75 $this->addMultiCommand("mailselectedusers", $this->lng->txt("send_mail"));
76 $this->addColumn("", "", 1);
77 $this->has_multi = true;
78 }
79 }
80
81 $labels = $this->getSelectableColumns();
82 foreach ($this->getSelectedColumns() as $c)
83 {
84 $first = $c;
85
86 // list cannot be sorted by udf fields (separate query)
87 // because of pagination only core fields can be sorted
88 $sort_id = (substr($c, 0, 4) == "udf_") ? "" : $c;
89
90 $this->addColumn($labels[$c]["txt"], $sort_id);
91 }
92
93 if(!$this->getPrintMode())
94 {
95 $this->addColumn($this->lng->txt("actions"), "");
96 }
97 $this->setSelectAllCheckbox('uid');
98 $this->setExternalSorting(true);
99 $this->setExternalSegmentation(true);
100 $this->setEnableHeader(true);
101 $this->setFormAction($ilCtrl->getFormActionByClass(get_class($this)));
102 $this->setRowTemplate("tpl.object_users_props_row.html", "Services/Tracking");
103 $this->setEnableTitle(true);
104 $this->setShowTemplates(true);
105 $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
106
107 if($first)
108 {
109 $this->setDefaultOrderField($first);
110 $this->setDefaultOrderDirection("asc");
111 }
112
113 $this->initFilter();
114
115 $this->getItems();
116
117 // #13807
118 include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
119 $this->has_edit = ilLearningProgressAccess::checkPermission('edit_learning_progress', $this->ref_id);
120
121 /* currently not active, needs to be revised
122 include_once "Services/Object/classes/class.ilObjectLP.php";
123 include_once "Services/Tracking/classes/collection/class.ilLPCollection.php";
124 $objlp = ilObjectLP::getInstance($this->obj_id);
125 $this->has_collection = in_array($objlp->getCurrentMode(), ilLPCollection::getCollectionModes());
126 */
127 }
parseTitle($a_obj_id, $action, $a_user_id=false)
static checkPermission($a_permission, $a_ref_id, $a_user_id=null)
wrapper for rbac access checks
Class Mail this class handles base functions for mail handling.
static _lookupObjId($a_id)
static _lookupType($a_id, $a_reference=false)
lookup object type
getSelectedColumns()
Get selected columns.
setEnableHeader($a_enableheader)
Set Enable Header.
setExternalSorting($a_val)
Set external sorting.
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.
setExportFormats(array $formats)
Set available export formats.
setPrintMode($a_value=false)
Toogle print mode.
setEnableTitle($a_enabletitle)
Set Enable Title.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
addMultiCommand($a_cmd, $a_text)
Add Command button.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
setSelectAllCheckbox($a_select_all_checkbox)
Set the name of the checkbox that should be toggled with a select all button.
getPrintMode()
Get print mode.
setExternalSegmentation($a_val)
Set external segmentation.
setId($a_val)
Set id.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
setShowTemplates($a_value)
Toggle templates.
global $ilCtrl
Definition: ilias.php:18
global $ilUser
Definition: imgupload.php:15

References $ilCtrl, $ilUser, ilObject\_lookupObjId(), ilObject\_lookupType(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ilLearningProgressAccess\checkPermission(), getItems(), ilTable2GUI\getPrintMode(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), initFilter(), ilLPTableBaseGUI\parseTitle(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExportFormats(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setPrintMode(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setShowTemplates().

+ Here is the call graph for this function:

Member Function Documentation

◆ fillHeaderCSV()

ilTrObjectUsersPropsTableGUI::fillHeaderCSV (   $a_csv)
protected

CSV Version of Fill Header.

Likely to be overwritten by derived class.

Parameters
object$a_csvcurrent file

Reimplemented from ilTable2GUI.

Definition at line 442 of file class.ilTrObjectUsersPropsTableGUI.php.

443 {
444 $labels = $this->getSelectableColumns();
445 foreach ($this->getSelectedColumns() as $c)
446 {
447 $a_csv->addColumn($labels[$c]["txt"]);
448 }
449
450 $a_csv->addRow();
451 }

References getSelectableColumns(), and ilTable2GUI\getSelectedColumns().

+ Here is the call graph for this function:

◆ fillHeaderExcel()

ilTrObjectUsersPropsTableGUI::fillHeaderExcel (   $worksheet,
$a_row 
)
protected

Excel Version of Fill Header.

Likely to be overwritten by derived class.

Parameters
object$a_worksheetcurrent sheet
int$a_rowrow counter

Reimplemented from ilTable2GUI.

Definition at line 413 of file class.ilTrObjectUsersPropsTableGUI.php.

414 {
415 $labels = $this->getSelectableColumns();
416 $cnt = 0;
417 foreach ($this->getSelectedColumns() as $c)
418 {
419 $worksheet->write($a_row, $cnt, $labels[$c]["txt"]);
420 $cnt++;
421 }
422 }

References getSelectableColumns(), and ilTable2GUI\getSelectedColumns().

+ Here is the call graph for this function:

◆ fillRow()

ilTrObjectUsersPropsTableGUI::fillRow (   $data)
protected

Fill table row.

Reimplemented from ilTable2GUI.

Definition at line 327 of file class.ilTrObjectUsersPropsTableGUI.php.

328 {
329 global $ilCtrl, $lng, $objDefinition;
330
331 if($this->has_multi)
332 {
333 $this->tpl->setVariable("USER_ID", $data["usr_id"]);
334 }
335
336 foreach ($this->getSelectedColumns() as $c)
337 {
338 if(!(bool)$data["privacy_conflict"])
339 {
340 if($c == 'status' && $data[$c] != ilLPStatus::LP_STATUS_COMPLETED_NUM)
341 {
342 $timing = $this->showTimingsWarning($this->ref_id, $data["usr_id"]);
343 if($timing)
344 {
345 if($timing !== true)
346 {
347 $timing = ": ".ilDatePresentation::formatDate(new ilDate($timing, IL_CAL_UNIX));
348 }
349 else
350 {
351 $timing = "";
352 }
353 $this->tpl->setCurrentBlock('warning_img');
354 $this->tpl->setVariable('WARNING_IMG', ilUtil::getImagePath('time_warn.svg'));
355 $this->tpl->setVariable('WARNING_ALT', $this->lng->txt('trac_time_passed').$timing);
356 $this->tpl->parseCurrentBlock();
357 }
358 }
359
360 // #7694
361 if($c == 'login' && !$data["active"])
362 {
363 $this->tpl->setCurrentBlock('inactive_bl');
364 $this->tpl->setVariable('TXT_INACTIVE', $lng->txt("inactive"));
365 $this->tpl->parseCurrentBlock();
366 }
367
368 $val = $this->parseValue($c, $data[$c], $this->type);
369 }
370 else
371 {
372 if($c == 'login')
373 {
374 $this->tpl->setCurrentBlock('inactive_bl');
375 $this->tpl->setVariable('TXT_INACTIVE', $lng->txt("status_no_permission"));
376 $this->tpl->parseCurrentBlock();
377 }
378
379 $val = " ";
380 }
381
382 $this->tpl->setCurrentBlock("user_field");
383 $this->tpl->setVariable("VAL_UF", $val);
384 $this->tpl->parseCurrentBlock();
385 }
386
387 $ilCtrl->setParameterByClass("illplistofobjectsgui", "user_id", $data["usr_id"]);
388
389 if(!$this->getPrintMode() && !(bool)$data["privacy_conflict"])
390 {
391 // details for containers and collections
392 if($this->has_collection ||
393 $objDefinition->isContainer($this->type))
394 {
395 $this->tpl->setCurrentBlock("item_command");
396 $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass("illplistofobjectsgui", "userdetails"));
397 $this->tpl->setVariable("TXT_COMMAND", $lng->txt('details'));
398 $this->tpl->parseCurrentBlock();
399 }
400
401 if($this->has_edit)
402 {
403 $this->tpl->setCurrentBlock("item_command");
404 $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass("illplistofobjectsgui", "edituser"));
405 $this->tpl->setVariable("TXT_COMMAND", $lng->txt('edit'));
406 $this->tpl->parseCurrentBlock();
407 }
408 }
409
410 $ilCtrl->setParameterByClass("illplistofobjectsgui", 'user_id', '');
411 }
const IL_CAL_UNIX
Class for single dates.
const LP_STATUS_COMPLETED_NUM
parseValue($id, $value, $type)
showTimingsWarning($a_ref_id, $a_user_id)
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
global $lng
Definition: privfeed.php:40

References ilTableGUI\$data, $ilCtrl, $lng, ilUtil\getImagePath(), ilTable2GUI\getPrintMode(), ilTable2GUI\getSelectedColumns(), IL_CAL_UNIX, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPTableBaseGUI\parseValue(), and ilLPTableBaseGUI\showTimingsWarning().

+ Here is the call graph for this function:

◆ fillRowCSV()

ilTrObjectUsersPropsTableGUI::fillRowCSV (   $a_csv,
  $a_set 
)
protected

CSV Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters
object$a_csvcurrent file
array$a_setdata array

Reimplemented from ilTable2GUI.

Definition at line 453 of file class.ilTrObjectUsersPropsTableGUI.php.

454 {
455 foreach ($this->getSelectedColumns() as $c)
456 {
457 if($c != 'status')
458 {
459 $val = $this->parseValue($c, $a_set[$c], $this->type);
460 }
461 else
462 {
463 $val = ilLearningProgressBaseGUI::_getStatusText((int)$a_set[$c]);
464 }
465 $a_csv->addColumn($val);
466 }
467
468 $a_csv->addRow();
469 }
_getStatusText($a_status, $a_lng=null)
Get status alt text.

References ilLearningProgressBaseGUI\_getStatusText(), ilTable2GUI\getSelectedColumns(), and ilLPTableBaseGUI\parseValue().

+ Here is the call graph for this function:

◆ fillRowExcel()

ilTrObjectUsersPropsTableGUI::fillRowExcel (   $a_worksheet,
$a_row,
  $a_set 
)
protected

Excel Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters
object$a_worksheetcurrent sheet
int$a_rowrow counter
array$a_setdata array

Reimplemented from ilTable2GUI.

Definition at line 424 of file class.ilTrObjectUsersPropsTableGUI.php.

425 {
426 $cnt = 0;
427 foreach ($this->getSelectedColumns() as $c)
428 {
429 if($c != 'status')
430 {
431 $val = $this->parseValue($c, $a_set[$c], $this->type);
432 }
433 else
434 {
435 $val = ilLearningProgressBaseGUI::_getStatusText((int)$a_set[$c]);
436 }
437 $worksheet->write($a_row, $cnt, $val);
438 $cnt++;
439 }
440 }

References ilLearningProgressBaseGUI\_getStatusText(), ilTable2GUI\getSelectedColumns(), and ilLPTableBaseGUI\parseValue().

+ Here is the call graph for this function:

◆ getItems()

ilTrObjectUsersPropsTableGUI::getItems ( )

Get user items.

Definition at line 152 of file class.ilTrObjectUsersPropsTableGUI.php.

153 {
154 global $lng;
155
157
158 include_once("./Services/Tracking/classes/class.ilTrQuery.php");
159
160 $additional_fields = $this->getSelectedColumns();
161
162 // only if object is [part of] course/group
163 $check_agreement = false;
164 if($this->in_course)
165 {
166 // privacy (if course agreement is activated)
167 include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
169 if($privacy->courseConfirmationRequired())
170 {
171 $check_agreement = $this->in_course;
172 }
173 }
174 else if($this->in_group)
175 {
176 // privacy (if group agreement is activated)
177 include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
179 if($privacy->groupConfirmationRequired())
180 {
181 $check_agreement = $this->in_group;
182 }
183 }
184
186 $this->ref_id,
191 $this->getCurrentFilter(),
192 $additional_fields,
193 $check_agreement,
194 $this->user_fields
195 );
196
197 if (count($tr_data["set"]) == 0 && $this->getOffset() > 0)
198 {
199 $this->resetOffset();
201 $this->ref_id,
206 $this->getCurrentFilter(),
207 $additional_fields,
208 $check_agreement,
209 $this->user_fields
210 );
211 }
212
213 $this->setMaxCount($tr_data["cnt"]);
214 $this->setData($tr_data["set"]);
215 }
getCurrentFilter($as_query=false)
static _getInstance()
Get instance of ilPrivacySettings.
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
setData($a_data)
set table data @access public
getLimit()
Get limit.
resetOffset($a_in_determination=false)
Reset offset.
getOffset()
Get offset.
getOrderDirection()
Get order direction.
setMaxCount($a_max_count)
set max.
static getUserDataForObject($a_ref_id, $a_order_field="", $a_order_dir="", $a_offset=0, $a_limit=9999, array $a_filters=NULL, array $a_additional_fields=NULL, $check_agreement=false, $privacy_fields=NULL)
Get all user-based tracking data for object.
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled

References $in_course, $in_group, $lng, ilPrivacySettings\_getInstance(), ilTable2GUI\determineOffsetAndOrder(), ilLPTableBaseGUI\getCurrentFilter(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilTable2GUI\getSelectedColumns(), ilTrQuery\getUserDataForObject(), ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), and ilUtil\stripSlashes().

Referenced by __construct().

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

◆ getSelectableColumns()

ilTrObjectUsersPropsTableGUI::getSelectableColumns ( )

Get selectable columns.

Parameters

return

Reimplemented from ilTable2GUI.

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

136 {
137 if($this->selectable_columns)
138 {
140 }
141
142 $cols = $this->getSelectableUserColumns($this->in_course, $this->in_group);
143 $this->user_fields = $cols[1];
144 $this->selectable_columns = $cols[0];
145
147 }
getSelectableUserColumns($a_in_course=false, $a_in_group=false)

References ilTable2GUI\$selectable_columns, and ilLPTableBaseGUI\getSelectableUserColumns().

Referenced by __construct(), fillHeaderCSV(), fillHeaderExcel(), and initFilter().

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

◆ initFilter()

ilTrObjectUsersPropsTableGUI::initFilter ( )

Init filter.

Reimplemented from ilTable2GUI.

Definition at line 221 of file class.ilTrObjectUsersPropsTableGUI.php.

222 {
223 global $lng;
224
225 foreach($this->getSelectableColumns() as $column => $meta)
226 {
227 // no udf!
228 switch($column)
229 {
230 case "firstname":
231 case "lastname":
232 case "mark":
233 case "u_comment":
234 case "institution":
235 case "department":
236 case "title":
237 case "street":
238 case "zipcode":
239 case "city":
240 case "country":
241 case "email":
242 case "matriculation":
243 case "login":
244 if($column != "mark" ||
245 ilObjectLP::supportsMark($this->type))
246 {
247 $item = $this->addFilterItemByMetaType($column, ilTable2GUI::FILTER_TEXT, true, $meta["txt"]);
248 $this->filter[$column] = $item->getValue();
249 }
250 break;
251
252 case "first_access":
253 case "last_access":
254 case "create_date":
255 case 'status_changed':
256 $item = $this->addFilterItemByMetaType($column, ilTable2GUI::FILTER_DATETIME_RANGE, true, $meta["txt"]);
257 $this->filter[$column] = $item->getDate();
258 break;
259
260 case "birthday":
261 $item = $this->addFilterItemByMetaType($column, ilTable2GUI::FILTER_DATE_RANGE, true, $meta["txt"]);
262 $this->filter[$column] = $item->getDate();
263 break;
264
265 case "read_count":
266 case "percentage":
267 $item = $this->addFilterItemByMetaType($column, ilTable2GUI::FILTER_NUMBER_RANGE, true, $meta["txt"]);
268 $this->filter[$column] = $item->getValue();
269 break;
270
271 case "gender":
272 $item = $this->addFilterItemByMetaType("gender", ilTable2GUI::FILTER_SELECT, true, $meta["txt"]);
273 $item->setOptions(array("" => $lng->txt("trac_all"), "m" => $lng->txt("gender_m"), "f" => $lng->txt("gender_f")));
274 $this->filter["gender"] = $item->getValue();
275 break;
276
277 case "sel_country":
278 $item = $this->addFilterItemByMetaType("sel_country", ilTable2GUI::FILTER_SELECT, true, $meta["txt"]);
279
280 $options = array();
281 include_once("./Services/Utilities/classes/class.ilCountry.php");
282 foreach (ilCountry::getCountryCodes() as $c)
283 {
284 $options[$c] = $lng->txt("meta_c_".$c);
285 }
286 asort($options);
287 $item->setOptions(array("" => $lng->txt("trac_all"))+$options);
288
289 $this->filter["sel_country"] = $item->getValue();
290 break;
291
292 case "status":
293 include_once "Services/Tracking/classes/class.ilLPStatus.php";
294 $item = $this->addFilterItemByMetaType("status", ilTable2GUI::FILTER_SELECT, true, $meta["txt"]);
295 $item->setOptions(array("" => $lng->txt("trac_all"),
300 $this->filter["status"] = $item->getValue();
301 if($this->filter["status"])
302 {
303 $this->filter["status"]--;
304 }
305 break;
306
307 case "language":
308 $item = $this->addFilterItemByMetaType("language", ilTable2GUI::FILTER_LANGUAGE, true);
309 $this->filter["language"] = $item->getValue();
310 break;
311
312 case "spent_seconds":
313 if(ilObjectLP::supportsSpentSeconds($this->type))
314 {
315 $item = $this->addFilterItemByMetaType("spent_seconds", ilTable2GUI::FILTER_DURATION_RANGE, true, $meta["txt"]);
316 $this->filter["spent_seconds"]["from"] = $item->getCombinationItem("from")->getValueInSeconds();
317 $this->filter["spent_seconds"]["to"] = $item->getCombinationItem("to")->getValueInSeconds();
318 }
319 break;
320 }
321 }
322 }
static getCountryCodes()
Get country codes (DIN EN 3166-1)
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 supportsMark($a_obj_type)
static supportsSpentSeconds($a_obj_type)
const FILTER_DURATION_RANGE
addFilterItemByMetaType($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
Add filter by standard type.
const FILTER_NUMBER_RANGE
const FILTER_DATETIME_RANGE
if(!is_array($argv)) $options

References $lng, $options, ilTable2GUI\addFilterItemByMetaType(), ilTable2GUI\FILTER_DATE_RANGE, ilTable2GUI\FILTER_DATETIME_RANGE, ilTable2GUI\FILTER_DURATION_RANGE, ilTable2GUI\FILTER_LANGUAGE, ilTable2GUI\FILTER_NUMBER_RANGE, ilTable2GUI\FILTER_SELECT, ilTable2GUI\FILTER_TEXT, ilCountry\getCountryCodes(), getSelectableColumns(), 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, ilObjectLP\supportsMark(), and ilObjectLP\supportsSpentSeconds().

Referenced by __construct().

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

Field Documentation

◆ $filter

ilTrObjectUsersPropsTableGUI::$filter
protected

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

◆ $has_collection

ilTrObjectUsersPropsTableGUI::$has_collection
protected

Definition at line 30 of file class.ilTrObjectUsersPropsTableGUI.php.

◆ $has_edit

ilTrObjectUsersPropsTableGUI::$has_edit
protected

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

◆ $has_multi

ilTrObjectUsersPropsTableGUI::$has_multi
protected

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

◆ $in_course

ilTrObjectUsersPropsTableGUI::$in_course
protected

Definition at line 27 of file class.ilTrObjectUsersPropsTableGUI.php.

Referenced by getItems().

◆ $in_group

ilTrObjectUsersPropsTableGUI::$in_group
protected

Definition at line 28 of file class.ilTrObjectUsersPropsTableGUI.php.

Referenced by getItems().

◆ $user_fields

ilTrObjectUsersPropsTableGUI::$user_fields
protected

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


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