ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
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="")
 
 executeCommand ()
 
 searchFilterListener ($a_ref_id, $a_data)
 Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED public. More...
 
 initBaseFilter ($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="")
 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)
 
 getData ()
 
 dataExists ()
 
 setPrefix ($a_prefix)
 
 getPrefix ()
 
 addFilterItem ($a_input_item, $a_optional=false)
 Add filter item. More...
 
 addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null)
 Add filter by standard type. More...
 
 getFilterItems ($a_optionals=false)
 Get filter items. More...
 
 getFilterItemByPostVar ($a_post_var)
 
 setFilterCols ($a_val)
 Set filter columns. More...
 
 getFilterCols ()
 Get filter columns. More...
 
 setDisableFilterHiding ($a_val=true)
 Set disable filter hiding. More...
 
 getDisableFilterHiding ()
 Get disable filter hiding. More...
 
 isFilterSelected ($a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 Get selected filters. More...
 
 determineSelectedFilters ()
 Determine selected filters. More...
 
 setCustomPreviousNext ($a_prev_link, $a_next_link)
 Set custom previous/next links. More...
 
 setFormAction ($a_form_action, $a_multipart=false)
 Set Form action parameter. More...
 
 getFormAction ()
 Get Form action parameter. More...
 
 setFormName ($a_formname="")
 Set Form name. More...
 
 getFormName ()
 Get Form name. More...
 
 setId ($a_val)
 Set id. More...
 
 getId ()
 Get element id. More...
 
 setDisplayAsBlock ($a_val)
 Set display as block. More...
 
 getDisplayAsBlock ()
 Get display as block. More...
 
 getSelectAllCheckbox ()
 Get the name of the checkbox that should be toggled with a select all button. More...
 
 setSelectAllCheckbox ($a_select_all_checkbox, $a_select_all_on_top=false)
 Set the name of the checkbox that should be toggled with a select all button. More...
 
 setExternalSorting ($a_val)
 Set external sorting. More...
 
 getExternalSorting ()
 Get external sorting. More...
 
 setFilterCommand ($a_val, $a_caption=null)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val, $a_caption=null)
 Set reset filter command. More...
 
 getResetCommand ()
 Get reset filter command. More...
 
 setExternalSegmentation ($a_val)
 Set external segmentation. More...
 
 getExternalSegmentation ()
 Get external segmentation. More...
 
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field. More...
 
 getDefaultOrderField ()
 Get Default order field. More...
 
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction. More...
 
 getDefaultOrderDirection ()
 Get Default order direction. More...
 
 setDefaultFilterVisiblity ($a_status)
 Set default filter visiblity. More...
 
 getDefaultFilterVisibility ()
 Get default filter visibility. More...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButtonBase $a_button)
 Add Command button instance. More...
 
 addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button. More...
 
 addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button for selected items. More...
 
 setCloseCommand ($a_link)
 Add command for closing table. More...
 
 addMultiCommand ($a_cmd, $a_text)
 Add Command button. More...
 
 addHiddenInput ($a_name, $a_value)
 Add Hidden Input field. More...
 
 addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
 Add Header Command (Link) (Image needed for now) More...
 
 setTopCommands ($a_val)
 Set top commands (display command buttons on top of table, too) More...
 
 getTopCommands ()
 Get top commands (display command buttons on top of table, too) More...
 
 addColumn ( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
 Add a column to the header. More...
 
 getNavParameter ()
 
 setOrderLink ($sort_field, $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder ($a_omit_offset=false)
 Determine offset and order. More...
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 render ()
 render table 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)
 
- Public Member Functions inherited from ilTableGUI
 __construct ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate ($a_tpl)
 set template public More...
 
getTemplateObject ()
 
 setData ($a_data)
 set table data public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page public More...
 
 setHeaderNames ($a_header_names)
 set table header names public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars public More...
 
 setColumnWidth ($a_column_width)
 set table column widths public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width 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) public More...
 
 setOffset ($a_offset)
 set dataset offset public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction 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 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 (ilExcel $a_excel, &$a_row)
 
 fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
 
 fillHeaderCSV ($a_csv)
 
 fillRowCSV ($a_csv, $a_set)
 
- 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 (ilExcel $a_excel, &$a_row)
 
 fillMetaCSV ($a_csv)
 
 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)
 
 addToClipboard ()
 Add selected users to clipboard. More...
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. More...
 
 isFilterVisible ()
 Check if filter is visible: manually shown (session, db) or default value set. More...
 
 isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, $a_element)
 Check if filter element is based on adv md. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value. More...
 
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value. More...
 
 fillMetaExcel (ilExcel $a_excel, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel (ilExcel $a_excel, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 

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
 $ctrl
 
 $tpl
 
 $parent_obj
 
 $parent_cmd
 
 $close_command = ""
 
 $top_anchor = "il_table_top"
 
 $filters = array()
 
 $optional_filters = array()
 
 $filter_cmd = 'applyFilter'
 
 $reset_cmd = 'resetFilter'
 
 $filter_cols = 5
 
 $ext_sort = false
 
 $ext_seg = false
 
 $context = ""
 
 $mi_sel_buttons = []
 
 $disable_filter_hiding = false
 
 $selected_filter = false
 
 $top_commands = true
 
 $selectable_columns = array()
 
 $selected_column = array()
 
 $show_templates = false
 
 $show_rows_selector = true
 
 $rows_selector_off = false
 
 $nav_determined = false
 
 $limit_determined = false
 
 $filters_determined = false
 
 $columns_determined = false
 
 $open_form_tag = true
 
 $close_form_tag = true
 
 $export_formats = []
 
 $export_mode
 
 $print_mode
 
 $enable_command_for_all
 
 $restore_filter
 
 $restore_filter_values
 
 $default_filter_visibility = false
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 
 $select_all_on_top = false
 
 $sel_buttons = []
 
- Protected Attributes inherited from ilTableGUI
 $tpl
 
 $lng
 

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

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$

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.

References $c, $DIC, $ilCtrl, $ilUser, $tree, 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().

37  {
38  global $DIC;
39 
40  $ilCtrl = $DIC['ilCtrl'];
41  $ilUser = $DIC['ilUser'];
42  $tree = $DIC['tree'];
43  $rbacsystem = $DIC['rbacsystem'];
44 
45  $this->setId("troup");
46  $this->obj_id = $a_obj_id;
47  $this->ref_id = $a_ref_id;
48  $this->type = ilObject::_lookupType($a_obj_id);
49 
50  $this->in_group = $tree->checkForParentType($this->ref_id, "grp");
51  if ($this->in_group) {
52  $this->in_group = ilObject::_lookupObjId($this->in_group);
53  } else {
54  $this->in_course = $tree->checkForParentType($this->ref_id, "crs");
55  if ($this->in_course) {
56  $this->in_course = ilObject::_lookupObjId($this->in_course);
57  }
58  }
59 
60  parent::__construct($a_parent_obj, $a_parent_cmd);
61 
62  $this->parseTitle($a_obj_id, "trac_participants");
63 
64  if ($a_print_view) {
65  $this->setPrintMode(true);
66  }
67 
68  if (!$this->getPrintMode()) {
69  // see ilObjCourseGUI::addMailToMemberButton()
70  include_once "Services/Mail/classes/class.ilMail.php";
71  $mail = new ilMail($ilUser->getId());
72  if ($rbacsystem->checkAccess("internal_mail", $mail->getMailObjectReferenceId())) {
73  $this->addMultiCommand("mailselectedusers", $this->lng->txt("send_mail"));
74  }
75  $this->lng->loadLanguageModule('user');
76  $this->addMultiCommand(
77  'addToClipboard',
78  $this->lng->txt('clipboard_add_btn')
79  );
80  $this->addColumn("", "", 1);
81  $this->has_multi = true;
82  }
83 
84  $labels = $this->getSelectableColumns();
85  foreach ($this->getSelectedColumns() as $c) {
86  $first = $c;
87 
88  // list cannot be sorted by udf fields (separate query)
89  // because of pagination only core fields can be sorted
90  $sort_id = (substr($c, 0, 4) == "udf_") ? "" : $c;
91 
92  $this->addColumn($labels[$c]["txt"], $sort_id);
93  }
94 
95  if (!$this->getPrintMode()) {
96  $this->addColumn($this->lng->txt("actions"), "");
97  }
98  $this->setSelectAllCheckbox('uid');
99  $this->setExternalSorting(true);
100  $this->setExternalSegmentation(true);
101  $this->setEnableHeader(true);
102  $this->setFormAction($ilCtrl->getFormActionByClass(get_class($this)));
103  $this->setRowTemplate("tpl.object_users_props_row.html", "Services/Tracking");
104  $this->setEnableTitle(true);
105  $this->setShowTemplates(true);
106  $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
107 
108  if ($first) {
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  }
setExternalSorting($a_val)
Set external sorting.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
setExportFormats(array $formats)
Set available export formats.
global $DIC
Definition: saml.php:7
setPrintMode($a_value=false)
Toogle print mode.
setShowTemplates($a_value)
Toggle templates.
setExternalSegmentation($a_val)
Set external segmentation.
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
setId($a_val)
Set id.
global $ilCtrl
Definition: ilias.php:18
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
setSelectAllCheckbox($a_select_all_checkbox, $a_select_all_on_top=false)
Set the name of the checkbox that should be toggled with a select all button.
static _lookupObjId($a_id)
addMultiCommand($a_cmd, $a_text)
Add Command button.
$ilUser
Definition: imgupload.php:18
getSelectedColumns()
Get selected columns.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
static _lookupType($a_id, $a_reference=false)
lookup object type
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
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.
getPrintMode()
Get print mode.
setEnableHeader($a_enableheader)
Set Enable Header.
setEnableTitle($a_enabletitle)
Set Enable Title.
+ Here is the call graph for this function:

Member Function Documentation

◆ fillHeaderCSV()

ilTrObjectUsersPropsTableGUI::fillHeaderCSV (   $a_csv)
protected

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

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

423  {
424  $labels = $this->getSelectableColumns();
425  foreach ($this->getSelectedColumns() as $c) {
426  $a_csv->addColumn($labels[$c]["txt"]);
427  }
428 
429  $a_csv->addRow();
430  }
getSelectedColumns()
Get selected columns.
+ Here is the call graph for this function:

◆ fillHeaderExcel()

ilTrObjectUsersPropsTableGUI::fillHeaderExcel ( ilExcel  $a_excel,
$a_row 
)
protected

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

References $c, ilExcel\getColumnCoord(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), ilExcel\setBold(), and ilExcel\setCell().

399  {
400  $labels = $this->getSelectableColumns();
401  $cnt = 0;
402  foreach ($this->getSelectedColumns() as $c) {
403  $a_excel->setCell($a_row, $cnt++, $labels[$c]["txt"]);
404  }
405 
406  $a_excel->setBold("A" . $a_row . ":" . $a_excel->getColumnCoord($cnt - 1) . $a_row);
407  }
getColumnCoord($a_col)
Get column "name" from number.
setBold($a_coords)
Set cell(s) to bold.
getSelectedColumns()
Get selected columns.
setCell($a_row, $a_col, $a_value, $a_datatype=null)
Set cell value.
+ Here is the call graph for this function:

◆ fillRow()

ilTrObjectUsersPropsTableGUI::fillRow (   $data)
protected

Fill table row.

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

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

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

◆ fillRowCSV()

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

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

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

433  {
434  foreach ($this->getSelectedColumns() as $c) {
435  if ($c != 'status') {
436  $val = $this->parseValue($c, $a_set[$c], $this->type);
437  } else {
438  $val = ilLearningProgressBaseGUI::_getStatusText((int) $a_set[$c]);
439  }
440  $a_csv->addColumn($val);
441  }
442 
443  $a_csv->addRow();
444  }
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
parseValue($id, $value, $type)
getSelectedColumns()
Get selected columns.
+ Here is the call graph for this function:

◆ fillRowExcel()

ilTrObjectUsersPropsTableGUI::fillRowExcel ( ilExcel  $a_excel,
$a_row,
  $a_set 
)
protected

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

References $c, ilLearningProgressBaseGUI\_getStatusText(), ilTable2GUI\getSelectedColumns(), ilLPTableBaseGUI\parseValue(), and ilExcel\setCell().

410  {
411  $cnt = 0;
412  foreach ($this->getSelectedColumns() as $c) {
413  if ($c != 'status') {
414  $val = $this->parseValue($c, $a_set[$c], $this->type);
415  } else {
416  $val = ilLearningProgressBaseGUI::_getStatusText((int) $a_set[$c]);
417  }
418  $a_excel->setCell($a_row, $cnt++, $val);
419  }
420  }
static _getStatusText($a_status, $a_lng=null)
Get status alt text.
parseValue($id, $value, $type)
getSelectedColumns()
Get selected columns.
setCell($a_row, $a_col, $a_value, $a_datatype=null)
Set cell value.
+ Here is the call graph for this function:

◆ getItems()

ilTrObjectUsersPropsTableGUI::getItems ( )

Get user items.

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

References $DIC, $in_course, $in_group, ilTableGUI\$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().

152  {
153  global $DIC;
154 
155  $lng = $DIC['lng'];
156 
157  $this->determineOffsetAndOrder();
158 
159  include_once("./Services/Tracking/classes/class.ilTrQuery.php");
160 
161  $additional_fields = $this->getSelectedColumns();
162 
163  // only if object is [part of] course/group
164  $check_agreement = false;
165  if ($this->in_course) {
166  // privacy (if course agreement is activated)
167  include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
168  $privacy = ilPrivacySettings::_getInstance();
169  if ($privacy->courseConfirmationRequired()) {
170  $check_agreement = $this->in_course;
171  }
172  } elseif ($this->in_group) {
173  // privacy (if group agreement is activated)
174  include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
175  $privacy = ilPrivacySettings::_getInstance();
176  if ($privacy->groupConfirmationRequired()) {
177  $check_agreement = $this->in_group;
178  }
179  }
180 
182  $this->ref_id,
186  ilUtil::stripSlashes($this->getLimit()),
187  $this->getCurrentFilter(),
188  $additional_fields,
189  $check_agreement,
190  $this->user_fields
191  );
192 
193  if (count($tr_data["set"]) == 0 && $this->getOffset() > 0) {
194  $this->resetOffset();
196  $this->ref_id,
200  ilUtil::stripSlashes($this->getLimit()),
201  $this->getCurrentFilter(),
202  $additional_fields,
203  $check_agreement,
204  $this->user_fields
205  );
206  }
207 
208  $this->setMaxCount($tr_data["cnt"]);
209  $this->setData($tr_data["set"]);
210  }
global $DIC
Definition: saml.php:7
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.
resetOffset($a_in_determination=false)
Reset offset.
getOrderDirection()
Get order direction.
getOffset()
Get offset.
getSelectedColumns()
Get selected columns.
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
getLimit()
Get limit.
static _getInstance()
Get instance of ilPrivacySettings.
setMaxCount($a_max_count)
set max.
getCurrentFilter($as_query=false)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSelectableColumns()

ilTrObjectUsersPropsTableGUI::getSelectableColumns ( )

Get selectable columns.

Parameters

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

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

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

136  {
137  if ($this->selectable_columns) {
139  }
140 
141  $cols = $this->getSelectableUserColumns($this->in_course, $this->in_group);
142  $this->user_fields = $cols[1];
143  $this->selectable_columns = $cols[0];
144 
146  }
getSelectableUserColumns($a_in_course=false, $a_in_group=false)
$cols
Definition: xhr_table.php:11
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initFilter()

ilTrObjectUsersPropsTableGUI::initFilter ( )

Init filter.

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

References $c, $DIC, ilTableGUI\$lng, PHPMailer\PHPMailer\$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().

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