ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilDataCollectionRecordListTableGUI Class Reference

Class ilDataCollectionField. More...

+ Inheritance diagram for ilDataCollectionRecordListTableGUI:
+ Collaboration diagram for ilDataCollectionRecordListTableGUI:

Public Member Functions

 getFilter ()
 @description Return array of fields that are currently stored in the filter. More...
 
 setRecordData ($data)
 
 fillHeaderExcel ($worksheet, &$row)
 
 numericOrdering ($field)
 Should this field be sorted numeric? More...
 
 sortByNComments ($a, $b)
 
 fillRowExcel ($worksheet, &$row, $record)
 
 initFilter ()
 Init filter. More...
 
 loadProperty ($type)
 
- 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)
 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)
 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...
 
 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
 ilTableGUI ($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

 getStatus (ilDataCollectionRecord $record, ilDataCollectionField $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...
 
 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 ($worksheet, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel ($a_worksheet, &$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
 
 $object_data
 
 $numeric_fields = array()
 
 $filter = array()
 
 $mode
 
- 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
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 

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...
 
- 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

Member Function Documentation

◆ buildData()

ilDataCollectionRecordListTableGUI::buildData ( )
private

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

Definition at line 183 of file class.ilDataCollectionRecordListTableGUI.php.

183 {
184 global $ilCtrl, $lng;
185
186 $data = array();
187 foreach ($this->object_data as $record) {
188 $record_data = array();
189 $record_data["_front"] = NULL;
190 $record_data['_record'] = $record;
191
192 foreach ($this->table->getVisibleFields() as $field) {
193 $title = $field->getTitle();
194 $record_data[$title] = $record->getRecordFieldHTML($field->getId());
195
196 // Additional column filled in ::fillRow() method, showing the learning progress
197 if ($field->getLearningProgress()) {
198 $record_data["_status_" . $title] = $this->getStatus($record, $field);
199 }
200 if ($field->getId() == 'comments') {
201 $record_data['n_comments'] = count($record->getComments());
202 }
203 }
204
205 $ilCtrl->setParameterByClass("ildatacollectionfieldeditgui", "record_id", $record->getId());
206 $ilCtrl->setParameterByClass("ildatacollectionrecordviewgui", "record_id", $record->getId());
207 $ilCtrl->setParameterByClass("ildatacollectionrecordeditgui", "record_id", $record->getId());
208 $ilCtrl->setParameterByClass("ildatacollectionrecordeditgui", "mode", $this->mode);
209
211 $record_data["_front"] = $ilCtrl->getLinkTargetByClass("ildatacollectionrecordviewgui", 'renderRecord');
212 }
213
214 $alist = new ilAdvancedSelectionListGUI();
215 $alist->setId($record->getId());
216 $alist->setListTitle($lng->txt("actions"));
217
219 $alist->addItem($lng->txt('view'), 'view', $ilCtrl->getLinkTargetByClass("ildatacollectionrecordviewgui", 'renderRecord'));
220 }
221
222 if ($record->hasPermissionToEdit($this->parent_obj->parent_obj->ref_id)) {
223 $alist->addItem($lng->txt('edit'), 'edit', $ilCtrl->getLinkTargetByClass("ildatacollectionrecordeditgui", 'edit'));
224 }
225
226 if ($record->hasPermissionToDelete($this->parent_obj->parent_obj->ref_id)) {
227 $alist->addItem($lng->txt('delete'), 'delete', $ilCtrl->getLinkTargetByClass("ildatacollectionrecordeditgui", 'confirmDelete'));
228 }
229
230 if ($this->table->getPublicCommentsEnabled()) {
231 $alist->addItem($lng->txt('dcl_comments'), 'comment', '', '', '', '', '', '', $this->getCommentsAjaxLink($record->getId()));
232 }
233
234 $record_data["_actions"] = $alist->getHTML();
235 $data[] = $record_data;
236 }
237
238 //sort by comments
239 if($this->getOrderField() == 'comments') {
240 usort($data, array($this, 'sortByNComments'));
241 }
242
243 $this->setData($data);
244 }
User interface class for advanced drop-down selection lists.
getStatus(ilDataCollectionRecord $record, ilDataCollectionField $field)
@description This adds the collumn for status.
static hasTableValidViewDefinition(ilDataCollectionTable $table)
setData($a_data)
set table data @access public
global $ilCtrl
Definition: ilias.php:18
global $lng
Definition: privfeed.php:40

References ilTableGUI\$data, $ilCtrl, $lng, ilTableGUI\$title, ilTable2GUI\getOrderField(), getStatus(), ilDataCollectionRecordViewGUI\hasTableValidViewDefinition(), and ilTable2GUI\setData().

Referenced by setRecordData().

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

◆ fillHeaderExcel()

ilDataCollectionRecordListTableGUI::fillHeaderExcel (   $worksheet,
$row 
)
Parameters
$worksheet
int$row

Reimplemented from ilTable2GUI.

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

154 {
155 $this->writeFilterToSession();
156 $this->initFilter();
157 $col = 0;
158
159 foreach ($this->table->getFields() as $field) {
160 if ($field->getExportable()) {
161 $worksheet->writeString($row, $col, $field->getTitle());
162 $col++;
163 if ($field->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_TEXT) {
164 $properties = $field->getProperties();
165 if ($properties[ilDataCollectionField::PROPERTYID_URL]) {
166 $worksheet->writeString($row, $col, $field->getTitle() . '_title');
167 $col++;
168 }
169 }
170 }
171 }
172 }
writeFilterToSession()
Write filter values to session.

References $row, initFilter(), ilDataCollectionDatatype\INPUTFORMAT_TEXT, ilDataCollectionField\PROPERTYID_URL, and ilTable2GUI\writeFilterToSession().

+ Here is the call graph for this function:

◆ fillRowExcel()

ilDataCollectionRecordListTableGUI::fillRowExcel (   $worksheet,
$row,
  $record 
)
Parameters
object$worksheet
int$row
ilDataCollectionRecord[]$record

Reimplemented from ilTable2GUI.

Definition at line 260 of file class.ilDataCollectionRecordListTableGUI.php.

260 {
261 $col = 0;
262 foreach ($this->table->getFields() as $field) {
263 if ($field->getExportable()) {
264 $record["_record"]->fillRecordFieldExcelExport($worksheet, $row, $col, $field->getId());
265 }
266 }
267 }

References $row.

◆ getCommentsAjaxLink()

ilDataCollectionRecordListTableGUI::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 389 of file class.ilDataCollectionRecordListTableGUI.php.

389 {
390 $ajax_hash = ilCommonActionDispatcherGUI::buildAjaxHash(1, $_GET['ref_id'], 'dcl', $this->parent_obj->obj_id, 'dcl', $recordId);
391
392 return ilNoteGUI::getListCommentsJSCall($ajax_hash, '');
393 }
$_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)
Build ajax hash.
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()

ilDataCollectionRecordListTableGUI::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 139 of file class.ilDataCollectionRecordListTableGUI.php.

References $filter.

◆ getStatus()

ilDataCollectionRecordListTableGUI::getStatus ( ilDataCollectionRecord  $record,
ilDataCollectionField  $field 
)
protected

@description This adds the collumn for status.

Parameters
ilDataCollectionRecord$record
ilDataCollectionField$field
Returns
string

Definition at line 336 of file class.ilDataCollectionRecordListTableGUI.php.

336 {
337 $record_field = ilDataCollectionCache::getRecordFieldCache($record, $field);
338 $return = "";
339 if ($status = $record_field->getStatus()) {
340 $return = "<img src='" . ilLearningProgressBaseGUI::_getImagePathForStatus($status->status) . "'>";
341 }
342
343 return $return;
344 }
static getRecordFieldCache($record, $field)
_getImagePathForStatus($a_status)
Get image path for status.

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

Referenced by buildData().

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

◆ initFilter()

ilDataCollectionRecordListTableGUI::initFilter ( )

Init filter.

Overwrite this to initialize all filter input property objects.

Reimplemented from ilTable2GUI.

Definition at line 347 of file class.ilDataCollectionRecordListTableGUI.php.

347 {
348
349 foreach ($this->table->getFilterableFields() as $field) {
351 $input->readFromSession();
352 $value = $input->getValue();
353 if (is_array($value)) {
354 if ($value['from'] || $value['to']) {
355 $this->filter["filter_" . $field->getId()] = $value;
356 }
357 } else {
358 if ($value != '') {
359 $this->filter["filter_" . $field->getId()] = $value;
360 }
361 }
362 }
363 }
static addFilterInputFieldToTable(ilDataCollectionField $field, ilTable2GUI &$table)
addFilterInputFieldToTable This function adds the according filter item to the table gui passed as ar...

References ilDataCollectionDatatype\addFilterInputFieldToTable().

Referenced by fillHeaderExcel().

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

◆ loadProperty()

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

Reimplemented from ilTable2GUI.

Definition at line 371 of file class.ilDataCollectionRecordListTableGUI.php.

371 {
372 global $ilUser;
373
374 if ($ilUser instanceof ilObjUser AND $this->getId()) {
375 $tab_prop = new ilTablePropertiesStorage();
376
377 return $tab_prop->getProperty($this->getId(), $ilUser->getId(), $type);
378 }
379 }
getId()
Get element id.
Saves (mostly asynchronously) user properties of tables (e.g.
global $ilUser
Definition: imgupload.php:15

References $ilUser, and ilTable2GUI\getId().

+ Here is the call graph for this function:

◆ numericOrdering()

ilDataCollectionRecordListTableGUI::numericOrdering (   $a_field)

Should this field be sorted numeric?

Returns
boolean numeric ordering; default is false

Reimplemented from ilTable2GUI.

Definition at line 175 of file class.ilDataCollectionRecordListTableGUI.php.

175 {
176 return in_array($field, $this->numeric_fields);
177 }

◆ setRecordData()

ilDataCollectionRecordListTableGUI::setRecordData (   $data)

Definition at line 144 of file class.ilDataCollectionRecordListTableGUI.php.

144 {
145 $this->object_data = $data;
146 $this->buildData($data);
147 }
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:

◆ sortByNComments()

ilDataCollectionRecordListTableGUI::sortByNComments (   $a,
  $b 
)

Definition at line 246 of file class.ilDataCollectionRecordListTableGUI.php.

246 {
247 if ($this->getOrderDirection() == 'asc') {
248 return $a['n_comments'] > $b['n_comments'] ? -1 : 1;
249 }
250 return $a['n_comments'] < $b['n_comments'] ? -1 : 1;
251
252 }
getOrderDirection()
Get order direction.

References ilTableGUI\getOrderDirection().

+ Here is the call graph for this function:

Field Documentation

◆ $filter

ilDataCollectionRecordListTableGUI::$filter = array()
protected

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

Referenced by getFilter().

◆ $mode

ilDataCollectionRecordListTableGUI::$mode
protected

Definition at line 46 of file class.ilDataCollectionRecordListTableGUI.php.

◆ $numeric_fields

ilDataCollectionRecordListTableGUI::$numeric_fields = array()
protected

Definition at line 38 of file class.ilDataCollectionRecordListTableGUI.php.

◆ $object_data

ilDataCollectionRecordListTableGUI::$object_data
protected

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

◆ $table

ilDataCollectionRecordListTableGUI::$table
protected

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


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