ilObjLearningSequenceContentTableGUI Class Reference
Inheritance diagram for ilObjLearningSequenceContentTableGUI:
Collaboration diagram for ilObjLearningSequenceContentTableGUI:
Public Member Functions | |
| __construct (ilObjLearningSequenceContentGUI $parent_gui, string $cmd, ilCtrl $ctrl, ilLanguage $lng, ilAccess $access, ilAdvancedSelectionListGUI $advanced_selection_list_gui, LSItemOnlineStatus $ls_item_online_status) | |
| Public Member Functions inherited from ilTable2GUI | |
| __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="") | |
| ilTable2GUI constructor. More... | |
| setOpenFormTag ($a_val) | |
| Set open form tag. More... | |
| getOpenFormTag () | |
| Get open form tag. More... | |
| setCloseFormTag ($a_val) | |
| Set close form tag. More... | |
| getCloseFormTag () | |
| Get close form tag. More... | |
| determineLimit () | |
| Determine the limit. More... | |
| getSelectableColumns () | |
| Get selectable columns. More... | |
| determineSelectedColumns () | |
| Determine selected columns. More... | |
| isColumnSelected ($a_col) | |
| Is given column selected? More... | |
| getSelectedColumns () | |
| Get selected columns. More... | |
| executeCommand () | |
| Execute command. More... | |
| resetOffset ($a_in_determination=false) | |
| Reset offset. More... | |
| initFilter () | |
| Init filter. More... | |
| getParentObject () | |
| Get parent object. More... | |
| getParentCmd () | |
| Get parent command. More... | |
| setTopAnchor ($a_val) | |
| Set top anchor. More... | |
| getTopAnchor () | |
| Get top anchor. More... | |
| setNoEntriesText ($a_text) | |
| Set text for an empty table. More... | |
| getNoEntriesText () | |
| Get text for an empty table. More... | |
| setIsDataTable ($a_val) | |
| Set is data table. More... | |
| getIsDataTable () | |
| Get is data table. More... | |
| setEnableTitle ($a_enabletitle) | |
| Set Enable Title. More... | |
| getEnableTitle () | |
| Get Enable Title. More... | |
| setEnableHeader ($a_enableheader) | |
| Set Enable Header. More... | |
| getEnableHeader () | |
| Get Enable Header. More... | |
| setEnableNumInfo ($a_val) | |
| Set enable num info. More... | |
| getEnableNumInfo () | |
| Get enable num info. More... | |
| setTitle ($a_title, $a_icon=0, $a_icon_alt=0) | |
| Set title and title icon. More... | |
| setDescription ($a_val) | |
| Set description. More... | |
| getDescription () | |
| Get description. More... | |
| setOrderField ($a_order_field) | |
| set order column More... | |
| getOrderField () | |
| setData ($a_data) | |
| set table data @access public More... | |
| getData () | |
| dataExists () | |
| setPrefix ($a_prefix) | |
| set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More... | |
| getPrefix () | |
| addFilterItem ($a_input_item, $a_optional=false) | |
| Add filter item. More... | |
| addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null) | |
| Add filter by standard type. More... | |
| getFilterItems ($a_optionals=false) | |
| Get filter items. More... | |
| getFilterItemByPostVar ($a_post_var) | |
| setFilterCols ($a_val) | |
| Set filter columns. More... | |
| getFilterCols () | |
| Get filter columns. More... | |
| setDisableFilterHiding ($a_val=true) | |
| Set disable filter hiding. More... | |
| getDisableFilterHiding () | |
| Get disable filter hiding. More... | |
| isFilterSelected ($a_col) | |
| Is given filter selected? More... | |
| getSelectedFilters () | |
| Get selected filters. More... | |
| determineSelectedFilters () | |
| Determine selected filters. More... | |
| setCustomPreviousNext ($a_prev_link, $a_next_link) | |
| Set custom previous/next links. More... | |
| setFormAction ($a_form_action, $a_multipart=false) | |
| Set Form action parameter. More... | |
| getFormAction () | |
| Get Form action parameter. More... | |
| setFormName ($a_formname="") | |
| Set Form name. More... | |
| getFormName () | |
| Get Form name. More... | |
| setId ($a_val) | |
| Set id. More... | |
| getId () | |
| Get element id. More... | |
| setDisplayAsBlock ($a_val) | |
| Set display as block. More... | |
| getDisplayAsBlock () | |
| Get display as block. More... | |
| getSelectAllCheckbox () | |
| Get the name of the checkbox that should be toggled with a select all button. More... | |
| setSelectAllCheckbox ($a_select_all_checkbox, $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 @access public More... | |
| writeFilterToSession () | |
| Write filter values to session. More... | |
| resetFilter () | |
| Reset filter. More... | |
| fillFooter () | |
| Fill footer row. More... | |
| getLinkbar ($a_num) | |
| Get previous/next linkbar. More... | |
| fillHiddenRow () | |
| fillActionRow () | |
| Fill Action Row. More... | |
| setHeaderHTML ($html) | |
| set header html More... | |
| storeProperty ($type, $value) | |
| Store table property. More... | |
| loadProperty ($type) | |
| Load table property. More... | |
| getCurrentState () | |
| get current settings for order, limit, columns and filter More... | |
| setContext ($id) | |
| Set context. More... | |
| getContext () | |
| Get context. More... | |
| setShowRowsSelector ($a_value) | |
| Toggle rows-per-page selector. More... | |
| getShowRowsSelector () | |
| Get rows-per-page selector state. More... | |
| setShowTemplates ($a_value) | |
| Toggle templates. More... | |
| getShowTemplates () | |
| Get template state. More... | |
| restoreTemplate ($a_name) | |
| Restore state from template. More... | |
| saveTemplate ($a_name) | |
| Save current state as template. More... | |
| deleteTemplate ($a_name) | |
| Delete template. More... | |
| getLimit () | |
| Get limit. More... | |
| getOffset () | |
| Get offset. More... | |
| setExportFormats (array $formats) | |
| Set available export formats. More... | |
| setPrintMode ($a_value=false) | |
| Toogle print mode. More... | |
| getPrintMode () | |
| Get print mode. More... | |
| getExportMode () | |
| Was export activated? More... | |
| exportData ($format, $send=false) | |
| Export and optionally send current table data. More... | |
| setEnableAllCommand ($a_value) | |
| Enable actions for all entries in current result. More... | |
| setRowSelectorLabel ($row_selector_label) | |
| getRowSelectorLabel () | |
| setPreventDoubleSubmission ($a_val) | |
| Set prevent double submission. More... | |
| getPreventDoubleSubmission () | |
| Get prevent double submission. More... | |
| setLimit ($a_limit=0, $a_default_limit=0) | |
| set max. More... | |
| Public Member Functions inherited from ilTableGUI | |
| __construct ($a_data=0, $a_global_tpl=true) | |
| Constructor. More... | |
| setTemplate ($a_tpl) | |
| set template @access public More... | |
| & | getTemplateObject () |
| setData ($a_data) | |
| set table data @access public More... | |
| getData () | |
| setTitle ($a_title, $a_icon=0, $a_icon_alt=0) | |
| set table title @access public More... | |
| setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0) | |
| set table help page @access public More... | |
| setHeaderNames ($a_header_names) | |
| set table header names @access public More... | |
| getColumnCount () | |
| Returns the column count based on the number of the header row columns @access public. More... | |
| setHeaderVars ($a_header_vars, $a_header_params=0) | |
| set table header vars @access public More... | |
| setColumnWidth ($a_column_width) | |
| set table column widths @access public More... | |
| setOneColumnWidth ($a_column_width, $a_column_number) | |
| set one table column width @access public More... | |
| setMaxCount ($a_max_count) | |
| set max. More... | |
| setLimit ($a_limit=0, $a_default_limit=0) | |
| set max. More... | |
| getLimit () | |
| Get limit. More... | |
| setPrefix ($a_prefix) | |
| set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More... | |
| setOffset ($a_offset) | |
| set dataset offset @access public More... | |
| getOffset () | |
| Get offset. More... | |
| setOrderColumn ($a_order_column=0, $a_default_column=0) | |
| set order column @access public More... | |
| getOrderColumn () | |
| Get order column. More... | |
| setOrderDirection ($a_order_direction) | |
| set order direction @access public More... | |
| getOrderDirection () | |
| Get order direction. More... | |
| setFooter ($a_style, $a_previous=0, $a_next=0) | |
| set order direction @access public More... | |
| enable ($a_module_name) | |
| enables particular modules of table More... | |
| disable ($a_module_name) | |
| diesables particular modules of table More... | |
| sortData () | |
| render () | |
| render table @access public More... | |
| renderHeader () | |
| setOrderLink ($key, $order_dir) | |
| setStyle ($a_element, $a_style) | |
| getStyle ($a_element) | |
| setBase ($a_base) | |
| Set Base script name (deprecated, only use this for workarounds). More... | |
| getBase () | |
| Get Base script name (deprecated, only use this for workarounds). More... | |
| getFormName () | |
| setFormName ($a_name="cmd") | |
| getSelectAllCheckbox () | |
| setSelectAllCheckbox ($a_select_all_checkbox) | |
| clearActionButtons () | |
| addActionButton ($btn_name, $btn_value) | |
Protected Member Functions | |
| fillRow ($set) | |
| Standard Version of Fill Row. More... | |
| getItemActionsMenu (int $ref_id, string $type) | |
| getActionMenuItems (int $ref_id, string $type) | |
| getEditLink (int $ref_id, string $type, array $action_items) | |
| getObjIdFor (int $ref_id) | |
| getListGuiFor (string $type) | |
| getStdLink (int $ref_id, string $type) | |
| 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... | |
Detailed Description
Definition at line 10 of file class.ilObjLearningSequenceContentTableGUI.php.
Constructor & Destructor Documentation
◆ __construct()
| ilObjLearningSequenceContentTableGUI::__construct | ( | ilObjLearningSequenceContentGUI | $parent_gui, |
| string | $cmd, | ||
| ilCtrl | $ctrl, | ||
| ilLanguage | $lng, | ||
| ilAccess | $access, | ||
| ilAdvancedSelectionListGUI | $advanced_selection_list_gui, | ||
| LSItemOnlineStatus | $ls_item_online_status | ||
| ) |
Definition at line 12 of file class.ilObjLearningSequenceContentTableGUI.php.
20 {
21 parent::__construct($parent_gui, $cmd);
22
23 $this->parent_gui = $parent_gui;
24 $this->ctrl = $ctrl;
25 $this->lng = $lng;
26 $this->access = $access;
27 $this->advanced_selection_list_gui = $advanced_selection_list_gui;
28 $this->ls_item_online_status = $ls_item_online_status;
29
32 $this->setFormAction($this->ctrl->getFormAction($this->parent_gui));
38
46
47 $this->setLimit(9999);
48 }
setTopCommands($a_val)
Set top commands (display command buttons on top of table, too)
Definition: class.ilTable2GUI.php:1306
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
Definition: class.ilTable2GUI.php:536
setEnableAllCommand($a_value)
Enable actions for all entries in current result.
Definition: class.ilTable2GUI.php:3319
setRowTemplate($a_template, $a_template_dir="")
Set row template.
Definition: class.ilTable2GUI.php:1127
addColumn( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
Add a column to the header.
Definition: class.ilTable2GUI.php:1328
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
Definition: class.ilTable2GUI.php:936
References ilTable2GUI\$ctrl, ilTableGUI\$lng, ilTable2GUI\addColumn(), ilTable2GUI\setEnableAllCommand(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFormAction(), ilTable2GUI\setLimit(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setShowRowsSelector(), ilTable2GUI\setTitle(), and ilTable2GUI\setTopCommands().
Here is the call graph for this function:
Member Function Documentation
◆ fillRow()
|
protected |
Standard Version of Fill Row.
Most likely to be overwritten by derived class.
- Parameters
-
array $a_set data array
Reimplemented from ilTable2GUI.
Definition at line 50 of file class.ilObjLearningSequenceContentTableGUI.php.
51 {
53 "",
54 $this->parent_gui->getFieldName($this->parent_gui::FIELD_ORDER, $set->getRefId())
55 );
56 $ni->setSize("3");
57 $ni->setDisabled($this->set_is_used);
58 $ni->setValue(($set->getOrderNumber() + 1) * 10);
59
60 if ($this->ls_item_online_status->hasOnlineStatus($set->getRefId())) {
62 "",
63 $this->parent_gui->getFieldName($this->parent_gui::FIELD_ONLINE, $set->getRefId())
64 );
65 $cb->setChecked($set->isOnline());
66 } else {
68 $cb->setChecked(true);
69 $cb->setDisabled(true);
70 }
71 $this->tpl->setVariable("ONLINE", $cb->render());
72
74 "",
75 $this->parent_gui->getFieldName($this->parent_gui::FIELD_POSTCONDITION_TYPE, $set->getRefId())
76 );
77 $options = $this->parent_gui->getPossiblePostConditionsForType($set->getType());
78
80 $si->setValue($set->getPostCondition()->getConditionOperator());
81
82 $action_items = $this->getActionMenuItems($set->getRefId(), $set->getType());
83 $obj_link = $this->getEditLink($set->getRefId(), $set->getType(), $action_items);
84
85 $title = $set->getTitle();
86 $title = sprintf(
87 '<a href="%s">%s</a>',
88 $obj_link,
89 $title
90 );
91
92 $this->tpl->setVariable("ID", $set->getRefId());
93 $this->tpl->setVariable("IMAGE", $set->getIconPath());
94 $this->tpl->setVariable("ORDER", $ni->render());
97 $this->tpl->setVariable("ACTIONS", $this->getItemActionsMenu($set->getRefId(), $set->getType()));
98 $this->tpl->setVariable("TYPE", $set->getType());
99 }
This class represents a checkbox property in a property form.
Definition: class.ilCheckboxInputGUI.php:34
This class represents a number property in a property form.
Definition: class.ilNumberInputGUI.php:15
getActionMenuItems(int $ref_id, string $type)
getItemActionsMenu(int $ref_id, string $type)
getEditLink(int $ref_id, string $type, array $action_items)
This class represents a selection list property in a property form.
Definition: class.ilSelectInputGUI.php:18
References PHPMailer\PHPMailer\$options, $si, ilTableGUI\$title, getActionMenuItems(), getEditLink(), and getItemActionsMenu().
Here is the call graph for this function:
◆ getActionMenuItems()
|
protected |
Definition at line 119 of file class.ilObjLearningSequenceContentTableGUI.php.
119 : array
120 {
121 $item_obj_id = $this->getObjIdFor($ref_id);
123 $item_list_gui->initItem($ref_id, $item_obj_id);
124 return $item_list_gui->getCommands();
125 }
getObjIdFor(int $ref_id)
getListGuiFor(string $type)
References getListGuiFor(), and getObjIdFor().
Referenced by fillRow().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getEditLink()
|
protected |
- Returns
- string|null
Definition at line 130 of file class.ilObjLearningSequenceContentTableGUI.php.
131 {
133 case $this->ls_item_online_status::S_LEARNMODULE_IL:
134 case $this->ls_item_online_status::S_LEARNMODULE_HTML:
135 case $this->ls_item_online_status::S_SURVEY:
136 $prop_for_type = 'properties';
137 break;
138
139 case $this->ls_item_online_status::S_SAHS:
140 case $this->ls_item_online_status::S_CONTENTPAGE:
141 case $this->ls_item_online_status::S_EXERCISE:
142 case $this->ls_item_online_status::S_FILE:
143 $prop_for_type = 'edit';
144 break;
145
146 case $this->ls_item_online_status::S_TEST:
147 $prop_for_type = 'ilObjTestSettingsGeneralGUI::showForm';
148 break;
149
150 case $this->ls_item_online_status::S_IND_ASSESSMENT:
151 default:
153 }
154
155 $props = array_filter(
156 $action_items,
157 function ($action_item) use ($prop_for_type) {
158 //var_dump($action_item['cmd']);
159 return $action_item['cmd'] === $prop_for_type;
160 }
161 );
162
163 if (count($props) > 0) {
164 return array_shift($props)['link'];
165 }
166 return null;
167 }
getStdLink(int $ref_id, string $type)
References $type, and getStdLink().
Referenced by fillRow().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getItemActionsMenu()
|
protected |
Definition at line 102 of file class.ilObjLearningSequenceContentTableGUI.php.
102 : string
103 {
104 $item_obj_id = $this->getObjIdFor($ref_id);
106 $item_list_gui->initItem($ref_id, $item_obj_id);
107
108 $item_list_gui->enableCut(true);
109 $item_list_gui->enableDelete(true);
110 $item_list_gui->enableLink(true);
111 $item_list_gui->enableTimings(false);
112
113 $lso_gui = $this->parent_gui->parent_gui;
114 $item_list_gui->setContainerObject($lso_gui);
115
116 return $item_list_gui->getCommandsHTML();
117 }
References getListGuiFor(), and getObjIdFor().
Referenced by fillRow().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getListGuiFor()
|
protected |
Definition at line 174 of file class.ilObjLearningSequenceContentTableGUI.php.
174 : ilObjectListGUI
175 {
177 }
static _getListGUIByType($a_type, $a_context=ilObjectListGUI::CONTEXT_REPOSITORY)
Definition: class.ilObjectListGUIFactory.php:16
References $type, and ilObjectListGUIFactory\_getListGUIByType().
Referenced by getActionMenuItems(), and getItemActionsMenu().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getObjIdFor()
|
protected |
Definition at line 169 of file class.ilObjLearningSequenceContentTableGUI.php.
169 : int
170 {
172 }
References ilObject\_lookupObjId().
Referenced by getActionMenuItems(), and getItemActionsMenu().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getStdLink()
|
protected |
Definition at line 179 of file class.ilObjLearningSequenceContentTableGUI.php.
179 : string
180 {
182 }
static _getLink($a_ref_id, $a_type='', $a_params=array(), $append="")
Definition: class.ilLink.php:17
References $type, and ilLink\_getLink().
Referenced by getEditLink().
Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following file:
- Modules/LearningSequence/classes/Content/class.ilObjLearningSequenceContentTableGUI.php
