ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
ilDclRecordListTableGUI Class Reference

Class ilDclBaseFieldModel. More...

+ Inheritance diagram for ilDclRecordListTableGUI:
+ Collaboration diagram for ilDclRecordListTableGUI:

Public Member Functions

 getFilter ()
 @description Return array of fields that are currently stored in the filter. More...
 
 setRecordData ($data)
 
 numericOrdering ($field)
 Should this field be sorted numeric? More...
 
 initFilterFromTableView ()
 init filters with values from tableview More...
 
 initFilter ()
 normally initialize filters - used by applyFilter and resetFilter More...
 
 applyFilter ($field_id, $filter_value)
 
 loadProperty ($type)
 
 exportData ($format, $send=false, $filepath=null)
 Exports the table. 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)
 

Data Fields

const EXPORT_EXCEL_ASYNC = 10
 
- 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
 

Protected Member Functions

 getStatus (ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
 @description This adds the collumn for status. More...
 
 getCommentsAjaxLink ($recordId)
 @description Get the ajax link for displaying the comments in the right panel (to be wrapped in an onclick attr) 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

 $table
 
 $tableview
 
 $object_data
 
 $numeric_fields = array()
 
 $filter = array()
 
 $mode
 
- 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
 

Private Member Functions

 buildData ()
 @description Parse data from record objects to an array that is then set to this table with ::setData() More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 

Detailed Description

Member Function Documentation

◆ applyFilter()

ilDclRecordListTableGUI::applyFilter (   $field_id,
  $filter_value 
)

Definition at line 350 of file class.ilDclRecordListTableGUI.php.

351 {
352 if ($filter_value) {
353 $this->filter["filter_" . $field_id] = $filter_value;
354 }
355 }

Referenced by initFilter(), and initFilterFromTableView().

+ Here is the caller graph for this function:

◆ buildData()

ilDclRecordListTableGUI::buildData ( )
private

@description Parse data from record objects to an array that is then set to this table with ::setData()

Definition at line 157 of file class.ilDclRecordListTableGUI.php.

158 {
159 global $DIC;
160 $ilCtrl = $DIC['ilCtrl'];
161 $lng = $DIC['lng'];
162
163 $data = array();
164 foreach ($this->object_data as $record) {
165 $record_data = array();
166 $record_data["_front"] = null;
167 $record_data['_record'] = $record;
168
169 foreach ($this->tableview->getVisibleFields() as $field) {
170 $title = $field->getTitle();
171 $record_data[$title] = $record->getRecordFieldHTML($field->getId());
172
173 // Additional column filled in ::fillRow() method, showing the learning progress
174 if ($field->getProperty(ilDclBaseFieldModel::PROP_LEARNING_PROGRESS)) {
175 $record_data["_status_" . $title] = $this->getStatus($record, $field);
176 }
177
178 if ($field->getId() == 'comments') {
179 $record_data['n_comments'] = count($record->getComments());
180 }
181 }
182
183 $ilCtrl->setParameterByClass("ildclfieldeditgui", "record_id", $record->getId());
184 $ilCtrl->setParameterByClass("ilDclDetailedViewGUI", "record_id", $record->getId());
185 $ilCtrl->setParameterByClass("ilDclDetailedViewGUI", "tableview_id", $this->tableview->getId());
186 $ilCtrl->setParameterByClass("ildclrecordeditgui", "record_id", $record->getId());
187 $ilCtrl->setParameterByClass("ildclrecordeditgui", "tableview_id", $this->tableview->getId());
188 $ilCtrl->setParameterByClass("ildclrecordeditgui", "mode", $this->mode);
189
190 if (ilDclDetailedViewDefinition::isActive($this->tableview->getId())) {
191 $record_data["_front"] = $ilCtrl->getLinkTargetByClass("ilDclDetailedViewGUI", 'renderRecord');
192 }
193
194 $alist = new ilAdvancedSelectionListGUI();
195 $alist->setId($record->getId());
196 $alist->setListTitle($lng->txt("actions"));
197
198 if (ilDclDetailedViewDefinition::isActive($this->tableview->getId())) {
199 $alist->addItem($lng->txt('view'), 'view', $ilCtrl->getLinkTargetByClass("ilDclDetailedViewGUI", 'renderRecord'));
200 }
201
202 if ($record->hasPermissionToEdit($this->parent_obj->parent_obj->ref_id)) {
203 $alist->addItem($lng->txt('edit'), 'edit', $ilCtrl->getLinkTargetByClass("ildclrecordeditgui", 'edit'));
204 }
205
206 if ($record->hasPermissionToDelete($this->parent_obj->parent_obj->ref_id)) {
207 $alist->addItem($lng->txt('delete'), 'delete', $ilCtrl->getLinkTargetByClass("ildclrecordeditgui", 'confirmDelete'));
208 }
209
210 if ($this->table->getPublicCommentsEnabled()) {
211 $alist->addItem($lng->txt('dcl_comments'), 'comment', '', '', '', '', '', '', $this->getCommentsAjaxLink($record->getId()));
212 }
213
214 $record_data["_actions"] = $alist->getHTML();
215 $data[] = $record_data;
216 }
217 $this->setData($data);
218 }
User interface class for advanced drop-down selection lists.
getStatus(ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
@description This adds the collumn for status.
setData($a_data)
set table data @access public
global $ilCtrl
Definition: ilias.php:18
$DIC
Definition: xapitoken.php:46

References ilTableGUI\$data, $DIC, $ilCtrl, ilTableGUI\$lng, ilTableGUI\$title, getStatus(), ilDclDetailedViewDefinition\isActive(), ilDclBaseFieldModel\PROP_LEARNING_PROGRESS, and ilTable2GUI\setData().

Referenced by setRecordData().

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

◆ exportData()

ilDclRecordListTableGUI::exportData (   $format,
  $send = false,
  $filepath = null 
)

Exports the table.

Parameters
int$format
bool | false$send
null | string$filepath
Returns
null|string

Definition at line 400 of file class.ilDclRecordListTableGUI.php.

401 {
402 if ($this->dataExists()) {
403 // #9640: sort
404 /*if (!$this->getExternalSorting() && $this->enabled["sort"]) {
405 $this->determineOffsetAndOrder(true);
406
407 $this->row_data = ilUtil::sortArray($this->row_data, $this->getOrderField(), $this->getOrderDirection(), $this->numericOrdering($this->getOrderField()));
408 }*/
409
410 $exporter = new ilDclContentExporter($this->parent_obj->parent_obj->object->getRefId(), $this->table->getId(), $this->filter);
411 $exporter->export(ilDclContentExporter::EXPORT_EXCEL, null, true);
412 }
413 }
Hook-Class for exporting data-collections (used in SOAP-Class) This Class avoids duplicated code by r...

References ilTable2GUI\dataExists(), and ilDclContentExporter\EXPORT_EXCEL.

+ Here is the call graph for this function:

◆ getCommentsAjaxLink()

ilDclRecordListTableGUI::getCommentsAjaxLink (   $recordId)
protected

@description Get the ajax link for displaying the comments in the right panel (to be wrapped in an onclick attr)

Parameters
int$recordIdRecord-ID
Returns
string

Definition at line 383 of file class.ilDclRecordListTableGUI.php.

384 {
385 $ajax_hash = ilCommonActionDispatcherGUI::buildAjaxHash(1, $_GET['ref_id'], 'dcl', $this->parent_obj->obj_id, 'dcl', $recordId);
386
387 return ilNoteGUI::getListCommentsJSCall($ajax_hash, '');
388 }
$_GET["client_id"]
static buildAjaxHash( $a_node_type, $a_node_id, $a_obj_type, $a_obj_id, $a_sub_type=null, $a_sub_id=null, $a_news_id=0)
Build ajax hash.
static getListCommentsJSCall($a_hash, $a_update_code=null)
Get list comments js call.

References $_GET, ilCommonActionDispatcherGUI\buildAjaxHash(), and ilNoteGUI\getListCommentsJSCall().

+ Here is the call graph for this function:

◆ getFilter()

ilDclRecordListTableGUI::getFilter ( )

@description Return array of fields that are currently stored in the filter.

Return empty array if no filtering is required.

Returns
array

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

References $filter.

◆ getStatus()

ilDclRecordListTableGUI::getStatus ( ilDclBaseRecordModel  $record,
ilDclBaseFieldModel  $field 
)
protected

@description This adds the collumn for status.

Parameters
ilDclBaseRecordModel$record
ilDclBaseFieldModel$field
Returns
string

Definition at line 282 of file class.ilDclRecordListTableGUI.php.

283 {
284 $record_field = ilDclCache::getRecordFieldCache($record, $field);
285 $return = "";
286 if ($status = $record_field->getStatus()) {
287 $return = "<img src='" . ilLearningProgressBaseGUI::_getImagePathForStatus($status->status) . "'>";
288 }
289
290 return $return;
291 }
static getRecordFieldCache($record, $field)
static _getImagePathForStatus($a_status)
Get image path for status.

References ilLearningProgressBaseGUI\_getImagePathForStatus(), and ilDclCache\getRecordFieldCache().

Referenced by buildData().

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

◆ initFilter()

ilDclRecordListTableGUI::initFilter ( )

normally initialize filters - used by applyFilter and resetFilter

Reimplemented from ilTable2GUI.

Definition at line 325 of file class.ilDclRecordListTableGUI.php.

326 {
327 foreach ($this->tableview->getFilterableFieldSettings() as $field_set) {
328 $field = $field_set->getFieldObject();
329 $value = ilDclCache::getFieldRepresentation($field)->addFilterInputFieldToTable($this);
330
331 //Disable filters
332 $filter = &end($this->filters);
333 if (!$field_set->isFilterChangeable()) {
334 //always set tableview-filtervalue with disabled fields, so resetFilter won't reset it
335 $value = $field_set->getFilterValue();
336 $filter->setValueByArray($value);
337 $value = $filter->getValue();
338
339 $filter->setDisabled(true);
340 if ($filter instanceof ilCombinationInputGUI) {
341 $filter->__call('setDisabled', array(true));
342 }
343 }
344
345 $this->applyFilter($field->getId(), $value);
346 }
347 }
This class represents a number property in a property form.
static getFieldRepresentation(ilDclBaseFieldModel $field)
applyFilter($field_id, $filter_value)

References $filter, applyFilter(), and ilDclCache\getFieldRepresentation().

+ Here is the call graph for this function:

◆ initFilterFromTableView()

ilDclRecordListTableGUI::initFilterFromTableView ( )

init filters with values from tableview

Definition at line 297 of file class.ilDclRecordListTableGUI.php.

298 {
299 $this->filters = [];
300 $this->filter = [];
301 foreach ($this->tableview->getFilterableFieldSettings() as $field_set) {
302 $field = $field_set->getFieldObject();
303 ilDclCache::getFieldRepresentation($field)->addFilterInputFieldToTable($this);
304
305 //set filter values
306 $filter = &end($this->filters);
307 $value = $field_set->getFilterValue();
308 $filter->setValueByArray($value);
309 $this->applyFilter($field->getId(), empty(array_filter($value)) ? null : $filter->getValue());
310
311 //Disable filters
312 if (!$field_set->isFilterChangeable()) {
313 $filter->setDisabled(true);
314 if ($filter instanceof ilCombinationInputGUI) {
315 $filter->__call('setDisabled', array(true));
316 }
317 }
318 }
319 }

References $filter, applyFilter(), and ilDclCache\getFieldRepresentation().

+ Here is the call graph for this function:

◆ loadProperty()

ilDclRecordListTableGUI::loadProperty (   $type)
Parameters
string$type
Returns
mixed

Reimplemented from ilTable2GUI.

Definition at line 363 of file class.ilDclRecordListTableGUI.php.

364 {
365 global $DIC;
366 $ilUser = $DIC['ilUser'];
367
368 if ($ilUser instanceof ilObjUser and $this->getId()) {
369 $tab_prop = new ilTablePropertiesStorage();
370
371 return $tab_prop->getProperty($this->getId(), $ilUser->getId(), $type);
372 }
373 }
getId()
Get element id.
Saves (mostly asynchronously) user properties of tables (e.g.
$type
$ilUser
Definition: imgupload.php:18

References $DIC, $ilUser, $type, and ilTable2GUI\getId().

+ Here is the call graph for this function:

◆ numericOrdering()

ilDclRecordListTableGUI::numericOrdering (   $a_field)

Should this field be sorted numeric?

Returns
boolean numeric ordering; default is false

Reimplemented from ilTable2GUI.

Definition at line 148 of file class.ilDclRecordListTableGUI.php.

149 {
150 return in_array($field, $this->numeric_fields);
151 }

◆ setRecordData()

ilDclRecordListTableGUI::setRecordData (   $data)

Definition at line 141 of file class.ilDclRecordListTableGUI.php.

142 {
143 $this->object_data = $data;
144 $this->buildData($data);
145 }
buildData()
@description Parse data from record objects to an array that is then set to this table with ::setData...

References ilTableGUI\$data, and buildData().

+ Here is the call graph for this function:

Field Documentation

◆ $filter

ilDclRecordListTableGUI::$filter = array()
protected

◆ $mode

ilDclRecordListTableGUI::$mode
protected

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

◆ $numeric_fields

ilDclRecordListTableGUI::$numeric_fields = array()
protected

Definition at line 34 of file class.ilDclRecordListTableGUI.php.

◆ $object_data

ilDclRecordListTableGUI::$object_data
protected

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

◆ $table

ilDclRecordListTableGUI::$table
protected

Definition at line 22 of file class.ilDclRecordListTableGUI.php.

◆ $tableview

ilDclRecordListTableGUI::$tableview
protected

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

◆ EXPORT_EXCEL_ASYNC

const ilDclRecordListTableGUI::EXPORT_EXCEL_ASYNC = 10

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


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