ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilExParticipantTableGUI Class Reference

Exercise participant table. More...

+ Inheritance diagram for ilExParticipantTableGUI:
+ Collaboration diagram for ilExParticipantTableGUI:

Protected Member Functions

 initMode ($a_item_id)
 
 parseData ()
 
 parseModeColumns ()
 
 fillRow ($a_item)
 
- Protected Member Functions inherited from ilExerciseSubmissionTableGUI
 initMode ($a_item_id)
 
 parseData ()
 
 parseModeColumns ()
 
 parseColumns ()
 
 parseRow ($a_user_id, ilExAssignment $a_ass, array $a_row)
 
- 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
 
- Protected Attributes inherited from ilExerciseSubmissionTableGUI
 $exc
 
 $mode
 
 $filter
 
 $comment_modals = array()
 
 $cols_mandatory = array("name", "status")
 
 $cols_default = array("image", "login", "submission_date", "idl")
 
 $cols_order
 
- 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
 
 $default_filter_visibility = false
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 

Additional Inherited Members

- Public Member Functions inherited from ilExerciseSubmissionTableGUI
 __construct ($a_parent_obj, $a_parent_cmd, ilObjExercise $a_exc, $a_item_id)
 Constructor. More...
 
 initFilter ()
 
 getSelectableColumns ()
 
 render ()
 
- 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)
 
 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)
 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)
 
- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 
- Data Fields inherited from ilExerciseSubmissionTableGUI
const MODE_BY_ASSIGNMENT = 1
 
const MODE_BY_USER = 2
 
- 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

Exercise participant table.

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

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

Member Function Documentation

◆ fillRow()

ilExParticipantTableGUI::fillRow (   $a_item)
protected

Definition at line 154 of file class.ilExParticipantTableGUI.php.

References $ilCtrl, ilTable2GUI\getId(), ilExerciseSubmissionTableGUI\parseRow(), and user().

155  {
156  global $ilCtrl;
157 
158  $ilCtrl->setParameter($this->parent_obj, "member_id", $this->user->getId());
159  $ilCtrl->setParameter($this->parent_obj, "ass_id", $a_item["ass"]->getId());
160 
161  // multi-select id
162  $this->tpl->setVariable("NAME_ID", "ass");
163  $this->tpl->setVariable("VAL_ID", $a_item["ass"]->getId());
164 
165  $this->parseRow($this->user->getId(), $a_item["ass"], $a_item);
166 
167  $ilCtrl->setParameter($this->parent_obj, "ass_id", "");
168  $ilCtrl->setParameter($this->parent_obj, "member_id", $this->user->getId());
169  }
user()
Definition: user.php:4
global $ilCtrl
Definition: ilias.php:18
parseRow($a_user_id, ilExAssignment $a_ass, array $a_row)
getId()
Get element id.
+ Here is the call graph for this function:

◆ initMode()

ilExParticipantTableGUI::initMode (   $a_item_id)
protected

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

References $lng, ilObjUser\_lookupName(), ilTable2GUI\setId(), ilTable2GUI\setSelectAllCheckbox(), ilTable2GUI\setTitle(), and user().

19  {
20  global $lng;
21 
22  $this->mode = self::MODE_BY_USER;
23 
24  // global id for all exercises
25  $this->setId("exc_part");
26 
27  if($a_item_id > 0)
28  {
29  $name = ilObjUser::_lookupName($a_item_id);
30  if(trim($name["login"]))
31  {
32  $this->user = new ilObjUser($a_item_id);
33 
34  $this->setTitle($lng->txt("exc_participant").": ".
35  $name["lastname"].", ".$name["firstname"]." [".$name["login"]."]");
36  }
37  }
38 
39  $this->setSelectAllCheckbox("ass");
40  }
static _lookupName($a_user_id)
lookup user name
setId($a_val)
Set id.
user()
Definition: user.php:4
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
global $lng
Definition: privfeed.php:17
setSelectAllCheckbox($a_select_all_checkbox)
Set the name of the checkbox that should be toggled with a select all button.
+ Here is the call graph for this function:

◆ parseData()

ilExParticipantTableGUI::parseData ( )
protected

Definition at line 42 of file class.ilExParticipantTableGUI.php.

References ilTableGUI\$data, $ilCtrl, $info, $row, ilObjUser\_lookupFullname(), ilTable2GUI\addCommandButton(), array, ilExAssignmentTeam\getAssignmentTeamMap(), ilExAssignment\getInstancesByExercise(), ilTable2GUI\getParentCmd(), ilTable2GUI\getParentObject(), ilTable2GUI\setDescription(), and user().

43  {
44  global $ilAccess, $ilCtrl;
45 
46  $this->addCommandButton("saveStatusParticipant", $this->lng->txt("save"));
47 
48  // #14650 - invalid user
49  if(!$this->user)
50  {
51  $ilCtrl->setParameter($this->getParentObject(), "member_id", "");
52  $ilCtrl->setParameter($this->getParentObject(), "part_id", ""); // #20073
53  $ilCtrl->redirect($this->getParentObject(), $this->getParentCmd());
54  }
55 
56  // #18327
57  if(!$ilAccess->checkAccessOfUser($this->user->getId(), "read","", $this->exc->getRefId()) &&
58  is_array($info = $ilAccess->getInfo()))
59  {
60  $this->setDescription('<span class="warning">'.$info[0]['text'].'</span>');
61  }
62 
63  $data = array();
64  foreach(ilExAssignment::getInstancesByExercise($this->exc->getId()) as $ass)
65  {
66  // ilExAssignment::getMemberListData()
67 
68  $member_status = $ass->getMemberStatus($this->user->getId());
69 
70  // filter
71  if($this->filter["status"] &&
72  $member_status->getStatus() != $this->filter["status"])
73  {
74  continue;
75  }
76 
77  $submission = new ilExSubmission($ass, $this->user->getId());
78  $idl = $ass->getIndividualDeadlines();
79 
80  if($this->filter["subm"])
81  {
82  if($this->filter["subm"] == "y" &&
83  !$submission->getLastSubmission())
84  {
85  continue;
86  }
87  else if($this->filter["subm"] == "n" &&
88  $submission->getLastSubmission())
89  {
90  continue;
91  }
92  }
93 
94  $row = array(
95  "ass" => $ass,
96  "submission_obj" => $submission,
97  "name" => $ass->getTitle(),
98  "status" => $member_status->getStatus(),
99  "mark" => $member_status->getMark(),
100  "sent_time" => $member_status->getSentTime(),
101  "status_time" => $member_status->getStatusTime(),
102  "feedback_time" => $member_status->getFeedbackTime(),
103  "submission" => $submission->getLastSubmission(),
104  "notice" => $member_status->getNotice(),
105  "comment" => $member_status->getComment()
106  );
107 
108  if($ass->hasTeam())
109  {
110  $team_map = ilExAssignmentTeam::getAssignmentTeamMap($ass->getId());
111 
112  $row["team"] = array();
113  foreach($submission->getTeam()->getMembers() as $user_id)
114  {
115  $row["team"][$user_id] = ilObjUser::_lookupFullname($user_id);
116  }
117  asort($row["team"]);
118 
119  $team_id = $team_map[$this->user->getId()];
120  if(is_numeric($team_id))
121  {
122  $idl_team_id = "t".$team_id;
123  if(array_key_exists($idl_team_id, $idl))
124  {
125  $row["idl"] = $idl[$idl_team_id];
126  }
127  }
128  }
129  else
130  {
131  if(array_key_exists($this->user->getId(), $idl))
132  {
133  $row["idl"] = $idl[$this->user->getId()];
134  }
135  }
136 
137  $data[] = $row;
138  }
139 
140  return $data;
141  }
addCommandButton($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
Add Command button.
setDescription($a_val)
Set description.
static getAssignmentTeamMap($a_ass_id)
Get team structure for assignment.
static _lookupFullname($a_user_id)
Lookup Full Name.
getParentCmd()
Get parent command.
getParentObject()
Get parent object.
user()
Definition: user.php:4
global $ilCtrl
Definition: ilias.php:18
$info
Definition: example_052.php:80
static getInstancesByExercise($a_exc_id)
Create styles array
The data for the language used.
Exercise submission.
+ Here is the call graph for this function:

◆ parseModeColumns()

ilExParticipantTableGUI::parseModeColumns ( )
protected

Definition at line 143 of file class.ilExParticipantTableGUI.php.

References array.

144  {
145  $cols = array();
146 
147  $cols["name"] = array($this->lng->txt("exc_assignment"), "name");
148  $cols["team_members"] = array($this->lng->txt("exc_tbl_team"));
149  $cols["idl"] = array($this->lng->txt("exc_tbl_individual_deadline"), "idl");
150 
151  return $cols;
152  }
Create styles array
The data for the language used.

Field Documentation

◆ $user

ilExParticipantTableGUI::$user
protected

Definition at line 16 of file class.ilExParticipantTableGUI.php.


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