ilRegistrationCodesTableGUI Class Reference
TableGUI class for registration codes. More...
Inheritance diagram for ilRegistrationCodesTableGUI:
Collaboration diagram for ilRegistrationCodesTableGUI:
Public Member Functions | |
| __construct ($a_parent_obj, $a_parent_cmd) | |
| Constructor. More... | |
| getItems () | |
| Get user items. More... | |
| initFilter () | |
| Init filter. More... | |
| getSelectedColumns () | |
| Get selected columns. More... | |
| 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 ($code) | |
| Standard Version of Fill Row. 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... | |
Detailed Description
TableGUI class for registration codes.
- Version
- $Id$
@ilCtrl_Calls ilRegistrationCodesTableGUI:
Definition at line 15 of file class.ilRegistrationCodesTableGUI.php.
Constructor & Destructor Documentation
◆ __construct()
| ilRegistrationCodesTableGUI::__construct | ( | $a_parent_obj, | |
| $a_parent_cmd | |||
| ) |
Constructor.
Reimplemented from ilTableGUI.
Definition at line 21 of file class.ilRegistrationCodesTableGUI.php.
22 {
23 global $DIC;
24
27
29
30 parent::__construct($a_parent_obj, $a_parent_cmd);
31
36 }
38 }
39
46 $this->initFilter();
51
55
57
58 $this->getItems();
59 }
setTopCommands($a_val)
Set top commands (display command buttons on top of table, too)
Definition: class.ilTable2GUI.php:1306
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.
Definition: class.ilTable2GUI.php:1031
setResetCommand($a_val, $a_caption=null)
Set reset filter command.
Definition: class.ilTable2GUI.php:1085
setRowTemplate($a_template, $a_template_dir="")
Set row template.
Definition: class.ilTable2GUI.php:1127
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
Definition: class.ilTable2GUI.php:1138
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
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
Definition: class.ilTable2GUI.php:1158
addCommandButton($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
Add Command button.
Definition: class.ilTable2GUI.php:1207
References $c, $DIC, $ilCtrl, ilTableGUI\$lng, ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), getItems(), getSelectedColumns(), initFilter(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setResetCommand(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), 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 256 of file class.ilRegistrationCodesTableGUI.php.
257 {
261 }
262 }
References $c, $code, and getSelectedColumns().
Here is the call graph for this function:
◆ getItems()
| ilRegistrationCodesTableGUI::getItems | ( | ) |
Get user items.
Definition at line 64 of file class.ilRegistrationCodesTableGUI.php.
65 {
66 global $DIC;
67
70
71 $this->determineOffsetAndOrder();
72
73 include_once("./Services/Registration/classes/class.ilRegistrationCode.php");
74
75 // #12737
78 }
79
80 $codes_data = ilRegistrationCode::getCodesData(
85 $this->filter["code"],
86 $this->filter["role"],
87 $this->filter["generated"],
88 $this->filter["alimit"]
89 );
90
92 $this->resetOffset();
93 $codes_data = ilRegistrationCode::getCodesData(
98 $this->filter["code"],
99 $this->filter["role"],
100 $this->filter["generated"],
101 $this->filter["alimit"]
102 );
103 }
104
105 include_once './Services/AccessControl/classes/class.ilObjRole.php';
106 $options = array();
107 foreach ($rbacreview->getGlobalRoles() as $role_id) {
108 if (!in_array($role_id, array(SYSTEM_ROLE_ID, ANONYMOUS_ROLE_ID))) {
109 $role_map[$role_id] = $ilObjDataCache->lookupTitle($role_id);
110 }
111 }
112
113 $result = array();
117
118 $result[$k]["generated"] = ilDatePresentation::formatDate(new ilDateTime($code["generated"], IL_CAL_UNIX));
119
121 $result[$k]["used"] = ilDatePresentation::formatDate(new ilDateTime($code["used"], IL_CAL_UNIX));
122 }
123
126 }
127
129 $local = array();
131 $role = ilObject::_lookupTitle($role_id);
132 if ($role) {
133 $local[] = $role;
134 }
135 }
136 if (sizeof($local)) {
137 sort($local);
139 }
140 }
141
144 case "unlimited":
146 break;
147
148 case "absolute":
151 break;
152
153 case "relative":
154 $limit_caption = array();
158 }
161 }
164 }
165 if (sizeof($limit_caption)) {
167 ": " . implode(", ", $limit_caption);
168 }
169 break;
170 }
171 }
172 }
173
176 }
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false, $include_seconds=false)
Format a date @access public.
Definition: class.ilDatePresentation.php:127
static getCodesData($order_field, $order_direction, $offset, $limit, $filter_code, $filter_role, $filter_generated, $filter_access_limitation)
Definition: class.ilRegistrationCode.php:70
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
Definition: class.ilTable2GUI.php:1535
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
Definition: class.ilUtil.php:2406
References $code, $DIC, ilTableGUI\$limit, PHPMailer\PHPMailer\$options, $result, ilObject\_lookupTitle(), ilTable2GUI\determineOffsetAndOrder(), ilDatePresentation\formatDate(), ilRegistrationCode\getCodesData(), ilTable2GUI\getDefaultOrderField(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), getSelectedColumns(), IL_CAL_DATE, IL_CAL_UNIX, ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), ilTable2GUI\setOrderField(), and ilUtil\stripSlashes().
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getSelectedColumns()
| ilRegistrationCodesTableGUI::getSelectedColumns | ( | ) |
Get selected columns.
- Parameters
-
return
Reimplemented from ilTable2GUI.
Definition at line 246 of file class.ilRegistrationCodesTableGUI.php.
247 {
248 return array("code" => "registration_code",
249 "role" => "registration_codes_roles",
250 "role_local" => "registration_codes_roles_local",
251 "alimit" => "reg_access_limitations",
252 "generated" => "registration_generated",
253 "used" => "registration_used");
254 }
Referenced by __construct(), fillRow(), and getItems().
Here is the caller graph for this function:
◆ initFilter()
| ilRegistrationCodesTableGUI::initFilter | ( | ) |
Init filter.
Reimplemented from ilTable2GUI.
Definition at line 182 of file class.ilRegistrationCodesTableGUI.php.
183 {
184 global $DIC;
185
190
191 include_once("./Services/Registration/classes/class.ilRegistrationCode.php");
192
193 // code
194 include_once("./Services/Form/classes/class.ilTextInputGUI.php");
196 $ti->setMaxLength(ilRegistrationCode::CODE_LENGTH);
197 $ti->setSize(20);
198 $ti->setSubmitFormOnEnter(true);
199 $this->addFilterItem($ti);
200 $ti->readFromSession();
201 $this->filter["code"] = $ti->getValue();
202
203 // role
204
205 $this->role_map = array();
206 foreach ($rbacreview->getGlobalRoles() as $role_id) {
207 if (!in_array($role_id, array(SYSTEM_ROLE_ID, ANONYMOUS_ROLE_ID))) {
208 $this->role_map[$role_id] = $ilObjDataCache->lookupTitle($role_id);
209 }
210 }
211
212 include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
213 include_once './Services/AccessControl/classes/class.ilObjRole.php';
215 $this->role_map;
219 $si->readFromSession();
221
222 // access limitation
224 "unlimited" => $this->lng->txt("reg_access_limitation_none"),
225 "absolute" => $this->lng->txt("reg_access_limitation_mode_absolute"),
226 "relative" => $this->lng->txt("reg_access_limitation_mode_relative"));
230 $si->readFromSession();
232
233 // generated
234 include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
238 }
242 $si->readFromSession();
244 }
static getGenerationDates()
Definition: class.ilRegistrationCode.php:131
This class represents a selection list property in a property form.
Definition: class.ilSelectInputGUI.php:18
addFilterItem($a_input_item, $a_optional=false)
Add filter item.
Definition: class.ilTable2GUI.php:637
This class represents a text property in a property form.
Definition: class.ilTextInputGUI.php:17
References $DIC, $ilUser, ilTableGUI\$lng, PHPMailer\PHPMailer\$options, $si, ilTable2GUI\addFilterItem(), ilRegistrationCode\CODE_LENGTH, ilDatePresentation\formatDate(), ilRegistrationCode\getGenerationDates(), and IL_CAL_UNIX.
Referenced by __construct().
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:
- Services/Registration/classes/class.ilRegistrationCodesTableGUI.php
