ILIAS  release_9 Revision v9.13-25-g2c18ec4c24f
ilDclRecordListTableGUI Class Reference
+ Inheritance diagram for ilDclRecordListTableGUI:
+ Collaboration diagram for ilDclRecordListTableGUI:

Public Member Functions

 getFilter ()
 Return array of fields that are currently stored in the filter. More...
 
 setRecordData (array $data)
 
 numericOrdering (string $a_field)
 
 initFilter ()
 
 applyFilter ($field_id, $filter_value)
 
 loadProperty (string $type)
 
 exportData (int $format, bool $send=false)
 Exports the table. More...
 
- Public Member Functions inherited from ilTable2GUI
 __construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")
 
 setOpenFormTag (bool $a_val)
 
 getOpenFormTag ()
 
 setCloseFormTag (bool $a_val)
 
 getCloseFormTag ()
 
 determineLimit ()
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 
 isColumnSelected (string $col)
 
 getSelectedColumns ()
 
 resetOffset (bool $a_in_determination=false)
 
 initFilter ()
 
 getParentObject ()
 
 getParentCmd ()
 
 setTopAnchor (string $a_val)
 
 getTopAnchor ()
 
 setNoEntriesText (string $a_text)
 
 getNoEntriesText ()
 
 setIsDataTable (bool $a_val)
 
 getIsDataTable ()
 
 setEnableTitle (bool $a_enabletitle)
 
 getEnableTitle ()
 
 setEnableHeader (bool $a_enableheader)
 
 getEnableHeader ()
 
 setEnableNumInfo (bool $a_val)
 
 getEnableNumInfo ()
 
 setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
 
 setDescription (string $a_val)
 
 getDescription ()
 
 setOrderField (string $a_order_field)
 
 getOrderField ()
 
 setData (array $a_data)
 
 getData ()
 
 dataExists ()
 
 setPrefix (string $a_prefix)
 
 getPrefix ()
 
 addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)
 
 addFilterItemByMetaType (string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
 Add filter by standard type. More...
 
 getFilterItems (bool $a_optionals=false)
 
 getFilterItemByPostVar (string $a_post_var)
 
 setFilterCols (int $a_val)
 
 getFilterCols ()
 
 setDisableFilterHiding (bool $a_val=true)
 
 getDisableFilterHiding ()
 
 isFilterSelected (string $a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 
 determineSelectedFilters ()
 
 setCustomPreviousNext (string $a_prev_link, string $a_next_link)
 
 setFormAction (string $a_form_action, bool $a_multipart=false)
 
 getFormAction ()
 
 setFormName (string $a_name="")
 
 getFormName ()
 
 setId (string $a_val)
 
 getId ()
 
 setDisplayAsBlock (bool $a_val)
 
 getDisplayAsBlock ()
 
 setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)
 
 setExternalSorting (bool $a_val)
 
 getExternalSorting ()
 
 setFilterCommand (string $a_val, string $a_caption="")
 
 getFilterCommand ()
 
 setResetCommand (string $a_val, string $a_caption="")
 
 getResetCommand ()
 
 setExternalSegmentation (bool $a_val)
 
 getExternalSegmentation ()
 
 setRowTemplate (string $a_template, string $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField (string $a_defaultorderfield)
 
 getDefaultOrderField ()
 
 setDefaultOrderDirection (string $a_defaultorderdirection)
 
 getDefaultOrderDirection ()
 
 setDefaultFilterVisiblity (bool $a_status)
 
 getDefaultFilterVisibility ()
 
 clearCommandButtons ()
 
 addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")
 
 addCommandButtonInstance (ilButtonBase $a_button)
 
 addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')
 
 setCloseCommand (string $a_link)
 
 addMultiCommand (string $a_cmd, string $a_text)
 
 addHiddenInput (string $a_name, string $a_value)
 
 addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")
 
 setTopCommands (bool $a_val)
 
 getTopCommands ()
 
 addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)
 
 getNavParameter ()
 
 setOrderLink (string $key, string $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder (bool $a_omit_offset=false)
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering (string $a_field)
 Should this field be sorted numeric? More...
 
 render ()
 
 writeFilterToSession ()
 
 resetFilter ()
 
 fillFooter ()
 
 getLinkbar (string $a_num)
 
 fillHiddenRow ()
 
 fillActionRow ()
 
 setHeaderHTML (string $html)
 
 storeProperty (string $type, string $value)
 
 loadProperty (string $type)
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext (string $id)
 
 getContext ()
 
 setShowRowsSelector (bool $a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 
 setShowTemplates (bool $a_value)
 
 getShowTemplates ()
 
 restoreTemplate (string $a_name)
 Restore state from template. More...
 
 saveTemplate (string $a_name)
 Save current state as template. More...
 
 deleteTemplate (string $a_name)
 
 getLimit ()
 
 getOffset ()
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode (bool $a_value=false)
 
 getPrintMode ()
 
 getExportMode ()
 
 exportData (int $format, bool $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand (bool $a_value)
 
 setRowSelectorLabel (string $row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission (bool $a_val)
 
 getPreventDoubleSubmission ()
 
 setLimit (int $a_limit=0, int $a_default_limit=0)
 
- Public Member Functions inherited from ilTableGUI
 __construct (array $a_data=[], bool $a_global_tpl=true)
 
 setTemplate (ilTemplate $a_tpl)
 
 getTemplateObject ()
 
 setData (array $a_data)
 Set table data. More...
 
 getData ()
 
 setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
 
 setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")
 
 setHeaderNames (array $a_header_names)
 
 getColumnCount ()
 
 setHeaderVars (array $a_header_vars, array $a_header_params=[])
 
 setColumnWidth (array $a_column_width)
 set table column widths More...
 
 setOneColumnWidth (string $a_column_width, int $a_column_number)
 
 setMaxCount (int $a_max_count)
 set max. More...
 
 setLimit (int $a_limit=0, int $a_default_limit=0)
 set max. More...
 
 getLimit ()
 
 setPrefix (string $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) More...
 
 setOffset (int $a_offset)
 set dataset offset More...
 
 getOffset ()
 
 setOrderColumn (string $a_order_column="", string $a_default_column="")
 
 getOrderColumn ()
 
 setOrderDirection (string $a_order_direction)
 
 getOrderDirection ()
 
 setFooter (string $a_style, string $a_previous="", string $a_next="")
 
 enable (string $a_module_name)
 
 disable (string $a_module_name)
 
 sortData ()
 
 render ()
 
 renderHeader ()
 
 setOrderLink (string $key, string $order_dir)
 
 setStyle (string $a_element, string $a_style)
 
 getStyle (string $a_element)
 
 setBase (string $a_base)
 
 getBase ()
 
 getFormName ()
 get the name of the parent form More...
 
 setFormName (string $a_name="cmd")
 
 getSelectAllCheckbox ()
 get the name of the checkbox that should be toggled with a select all button More...
 
 setSelectAllCheckbox (string $a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton (string $btn_name, string $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
string $title = ""
 
string $icon = ""
 
string $icon_alt = ""
 
string $help_page = ""
 
string $help_icon = ""
 
string $help_icon_alt = ""
 
array $header_names = []
 
array $header_vars = []
 
array $linkbar_vars = []
 
array $data = []
 
int $column_count = 0
 
array $column_width = []
 
int $max_count = 0
 
int $limit = 0
 
bool $max_limit = false
 
int $offset = 0
 
string $order_column = ""
 
string $order_direction = ""
 
string $footer_style = ""
 
string $footer_previous = ""
 
string $footer_next = ""
 
bool $lang_support = true
 
bool $global_tpl = false
 
string $form_name = ""
 
string $select_all_checkbox = ""
 
array $action_buttons = []
 
string $prefix = ""
 
string $base = ""
 
array $enabled
 
array $styles
 

Protected Member Functions

 addActionRowIfNeeded ()
 
 needsActionRow ()
 
 getStatus (ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
 This adds the column for status. More...
 
 getCommentJsLinkCode (int $recordId)
 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
 getRequestedValues ()
 
 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, ilTableFilterItem $a_element)
 Check if filter element is based on adv md. More...
 
 fillRow (array $a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilTableFilterItem $a_item)
 Get current filter value. More...
 
 setFilterValue (ilTableFilterItem $a_item, $a_value)
 
 fillMetaExcel (ilExcel $a_excel, int &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel (ilExcel $a_excel, int &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV (ilCSVWriter $a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV (ilCSVWriter $a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV (ilCSVWriter $a_csv, array $a_set)
 CSV Version of Fill Row. More...
 

Protected Attributes

object $parent_obj
 
ilDclTable $table
 
ilDclTableView $tableview
 
array $object_data
 
array $numeric_fields = []
 
array $filter = []
 
string $mode
 
int $userId
 
ilCtrl $ctrl
 
ilLanguage $lng
 
ILIAS DI UIServices $ui
 
- Protected Attributes inherited from ilTable2GUI
string $requested_tmpl_delete
 
string $requested_tmpl_create
 
string $requested_nav_par2 = ""
 
string $requested_nav_par = ""
 
string $requested_nav_par1 = ""
 
ILIAS Table TableGUIRequest $table_request = null
 
array $selected_columns = []
 
ilCtrl $ctrl
 
object $parent_obj = null
 
string $parent_cmd = ""
 
string $close_command = ""
 
string $top_anchor = "il_table_top"
 
array $filters = array()
 
array $optional_filters = array()
 
string $filter_cmd = 'applyFilter'
 
string $reset_cmd = 'resetFilter'
 
int $filter_cols = 5
 
bool $ext_sort = false
 
bool $ext_seg = false
 
string $context = ""
 
array $mi_sel_buttons = []
 
bool $disable_filter_hiding = false
 
bool $top_commands = true
 
array $selectable_columns = array()
 
array $selected_column = array()
 
bool $show_templates = false
 
bool $show_rows_selector = true
 
bool $rows_selector_off = false
 
bool $nav_determined = false
 
bool $limit_determined = false
 
bool $filters_determined = false
 
bool $columns_determined = false
 
bool $open_form_tag = true
 
bool $close_form_tag = true
 
array $export_formats = []
 
int $export_mode = 0
 
bool $print_mode = false
 
bool $enable_command_for_all = false
 
bool $restore_filter = false
 
array $restore_filter_values = []
 
bool $default_filter_visibility = false
 
array $sortable_fields = array()
 
bool $prevent_double_submission = true
 
string $row_selector_label = ""
 
bool $select_all_on_top = false
 
array $sel_buttons = []
 
string $nav_value = ''
 
string $noentriestext = ''
 
string $css_row = ''
 
bool $display_as_block = false
 
string $description = ''
 
string $id = ""
 
bool $custom_prev_next = false
 
string $reset_cmd_txt = ""
 
string $defaultorderfield = ""
 
string $defaultorderdirection = ""
 
array $column = []
 
bool $datatable = false
 
bool $num_info = false
 
bool $form_multipart = false
 
array $row_data = []
 
string $order_field = ""
 
array $selected_filter = []
 
string $form_action = ""
 
string $formname = ""
 
string $sort_order = ""
 
array $buttons = []
 
array $multi = []
 
array $hidden_inputs = []
 
array $header_commands = []
 
string $row_template = ""
 
string $row_template_dir = ""
 
string $filter_cmd_txt = ""
 
string $custom_prev = ""
 
string $custom_next = ""
 
array $raw_post_data = null
 
ilGlobalTemplateInterface $main_tpl
 
- Protected Attributes inherited from ilTableGUI
string $sort_order
 
string $link_params
 
array $header_params
 
 $tpl
 
ilLanguage $lng
 

Private Member Functions

 buildData ()
 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 ()
 
- Static Public Member Functions inherited from ilTableGUI
static linkbar (string $AScript, int $AHits, int $ALimit, int $AOffset, array $AParams=array(), array $ALayout=array(), string $prefix='')
 

Detailed Description

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

Member Function Documentation

◆ addActionRowIfNeeded()

ilDclRecordListTableGUI::addActionRowIfNeeded ( )
protected

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

References ilTable2GUI\addColumn(), ILIAS\Repository\lng(), and needsActionRow().

Referenced by setRecordData().

143  : void
144  {
145  if ($this->needsActionRow()) {
146  $this->addColumn($this->lng->txt("actions"), "", "");
147  }
148  }
addColumn(string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ applyFilter()

ilDclRecordListTableGUI::applyFilter (   $field_id,
  $filter_value 
)

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

References ILIAS\Repository\filter().

Referenced by initFilter().

346  {
347  if ($filter_value) {
348  $this->filter["filter_" . $field_id] = $filter_value;
349  }
350  }
filter(string $filter_id, $class_path, string $cmd, bool $activated=true, bool $expanded=true)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ buildData()

ilDclRecordListTableGUI::buildData ( )
private

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

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

References ilTableGUI\$data, ilTable2GUI\$id, ilTableGUI\$title, ILIAS\Repository\ctrl(), ilTable2GUI\fillRow(), getCommentJsLinkCode(), getStatus(), ilDclDetailedViewDefinition\isActive(), ILIAS\Repository\lng(), ilDclRecordListGUI\MODE_MANAGE, ilDclBaseFieldModel\PROP_LEARNING_PROGRESS, ilTable2GUI\setData(), ILIAS\Repository\ui(), and ILIAS\UI\Implementation\Component\withAdditionalOnLoadCode().

Referenced by setRecordData().

158  : void
159  {
160  $data = [];
161  foreach ($this->object_data as $record) {
162  $record_data = [];
163  $record_data["_front"] = null;
164  $record_data['_record'] = $record;
165 
166  foreach ($this->tableview->getVisibleFields() as $field) {
167  $title = $field->getTitle();
168  $record_data[$title] = $record->getRecordFieldHTML($field->getId(), ['tableview_id' => $this->tableview->getId()]);
169 
170  // Additional column filled in ::fillRow() method, showing the learning progress
171  if ($field->getProperty(ilDclBaseFieldModel::PROP_LEARNING_PROGRESS)) {
172  $record_data["_status_" . $title] = $this->getStatus($record, $field);
173  }
174 
175  if ($field->getId() == 'comments') {
176  $record_data['n_comments'] = $record->getNrOfComments();
177  }
178  }
179 
180  $this->ctrl->setParameterByClass(ilDclFieldEditGUI::class, "record_id", $record->getId());
181  $this->ctrl->setParameterByClass(ilDclDetailedViewGUI::class, "table_id", $record->getTableId());
182  $this->ctrl->setParameterByClass(ilDclDetailedViewGUI::class, "record_id", $record->getId());
183  $this->ctrl->setParameterByClass(ilDclDetailedViewGUI::class, "tableview_id", $this->tableview->getId());
184  $this->ctrl->setParameterByClass(ilDclRecordEditGUI::class, "record_id", $record->getId());
185  $this->ctrl->setParameterByClass(ilDclRecordEditGUI::class, "tableview_id", $this->tableview->getId());
186  $this->ctrl->setParameterByClass(ilDclRecordEditGUI::class, "mode", $this->mode);
187 
188  if (ilDclDetailedViewDefinition::isActive($this->tableview->getId())) {
189  $record_data["_front"] = $this->ctrl->getLinkTargetByClass(ilDclDetailedViewGUI::class, 'renderRecord');
190  }
191 
192  $action_links = [];
193 
194  if (ilDclDetailedViewDefinition::isActive($this->tableview->getId())) {
195  $action_links[] = $this->ui->factory()->link()->standard(
196  $this->lng->txt('view'),
197  $this->ctrl->getLinkTargetByClass(ilDclDetailedViewGUI::class, 'renderRecord')
198  );
199  }
200 
201  if ($record->hasPermissionToEdit($this->parent_obj->getRefId())) {
202  $action_links[] = $this->ui->factory()->link()->standard(
203  $this->lng->txt('edit'),
204  $this->ctrl->getLinkTargetByClass(ilDclRecordEditGUI::class, 'edit')
205  );
206  }
207 
208  if ($record->hasPermissionToDelete($this->parent_obj->getRefId())) {
209  $action_links[] = $this->ui->factory()->link()->standard(
210  $this->lng->txt('delete'),
211  $this->ctrl->getLinkTargetByClass(ilDclRecordEditGUI::class, 'confirmDelete')
212  );
213  }
214 
215  if ($this->table->getPublicCommentsEnabled()) {
216  $js_code = $this->getCommentJsLinkCode($record->getId());
217  $action_links[] = $this->ui->factory()->button()->shy(
218  $this->lng->txt('dcl_comments'),
219  "#"
220  )->withAdditionalOnLoadCode(function ($id) use ($js_code) {
221  return "document.getElementById('$id').addEventListener('click',function()
222  {
223  $js_code
224  });";
225  });
226  }
227  $action_dropdown = $this->ui->factory()->dropdown()->standard($action_links)
228  ->withLabel($this->lng->txt("actions"));
229  $record_data["_actions"] = $this->ui->renderer()->render($action_dropdown);
230 
231  $data[] = $record_data;
232  }
233  $this->setData($data);
234  }
setData(array $a_data)
getStatus(ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
This adds the column for status.
getCommentJsLinkCode(int $recordId)
Get the ajax link for displaying the comments in the right panel (to be wrapped in an onclick attr) ...
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ exportData()

ilDclRecordListTableGUI::exportData ( int  $format,
bool  $send = false 
)

Exports the table.

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

References $filter, ilTable2GUI\dataExists(), ilDclContentExporter\export(), and ilDclContentExporter\EXPORT_EXCEL.

388  : void {
389  if ($this->dataExists()) {
390  $exporter = new ilDclContentExporter(
391  $this->parent_obj->getRefId(),
392  $this->table->getId(),
394  );
395  $exporter->export(ilDclContentExporter::EXPORT_EXCEL, null, true);
396  }
397  }
export(string $format=self::EXPORT_EXCEL, string $filepath=null, bool $send=false)
Creates an export of a specific data collection table.
Hook-Class for exporting data-collections (used in SOAP-Class) This Class avoids duplicated code by r...
+ Here is the call graph for this function:

◆ getCommentJsLinkCode()

ilDclRecordListTableGUI::getCommentJsLinkCode ( int  $recordId)
protected

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

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

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

Referenced by buildData().

368  : string
369  {
371  1,
372  $this->parent_obj->getRefId(),
373  'dcl',
374  $this->parent_obj->getObjId(),
375  'dcl',
376  $recordId
377  );
378 
379  return ilNoteGUI::getListCommentsJSCall($ajax_hash, '');
380  }
static buildAjaxHash(int $node_type, ?int $node_id, string $obj_type, int $obj_id, string $sub_type=null, int $sub_id=null, int $news_id=0)
Build ajax hash.
static getListCommentsJSCall(string $a_hash, string $a_update_code=null)
Get list comments js call.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getFilter()

ilDclRecordListTableGUI::getFilter ( )

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

Return empty array if no filtering is required.

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

References $filter.

131  : array
132  {
133  return $this->filter;
134  }

◆ getStatus()

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

This adds the column for status.

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

References ilLPStatusIcons\getInstance(), ilDclCache\getRecordFieldCache(), and ilLPStatusIcons\ICON_VARIANT_LONG.

Referenced by buildData().

308  : string
309  {
310  $record_field = ilDclCache::getRecordFieldCache($record, $field);
311  $return = "";
312  if ($status = $record_field->getStatus()) {
314  $return = $icons->renderIconForStatus($status->status);
315  }
316 
317  return $return;
318  }
static getInstance(int $variant=ilLPStatusIcons::ICON_VARIANT_DEFAULT, ?\ILIAS\UI\Renderer $renderer=null, ?\ILIAS\UI\Factory $factory=null)
static getRecordFieldCache(object $record, object $field)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initFilter()

ilDclRecordListTableGUI::initFilter ( )

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

References applyFilter(), ilDclCache\getFieldRepresentation(), ilTable2GUI\getFilterItemByPostVar(), and ilSession\has().

320  : void
321  {
322  foreach ($this->tableview->getFilterableFieldSettings() as $field_set) {
323  $field = $field_set->getFieldObject();
324  $value = ilDclCache::getFieldRepresentation($field)->addFilterInputFieldToTable($this);
325  $filter = $this->getFilterItemByPostVar('filter_' . $field->getId());
326 
327  $isset = ilSession::has("form_" . $filter->getParentTable()->getId() . "_" . $filter->getFieldId());
328  if (!$field_set->isFilterChangeable() || !$isset) {
329  $value = $field_set->getFilterValue();
330  $filter->setValueByArray($value);
331  $value = $filter->getValue();
332 
333  if (!$field_set->isFilterChangeable()) {
334  $filter->setDisabled(true);
335  if ($filter instanceof ilCombinationInputGUI) {
336  $filter->__call('setDisabled', [true]);
337  }
338  }
339  }
340 
341  $this->applyFilter($field->getId(), $value);
342  }
343  }
applyFilter($field_id, $filter_value)
getFilterItemByPostVar(string $a_post_var)
static getFieldRepresentation(ilDclBaseFieldModel $field)
static has($a_var)
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
+ Here is the call graph for this function:

◆ loadProperty()

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

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

References ilTable2GUI\getId().

356  : string
357  {
358  if ($this->getId() && $this->userId > 0) {
359  $tab_prop = new ilTablePropertiesStorageGUI();
360  return $tab_prop->getProperty($this->getId(), $this->userId, $type);
361  }
362  return "";
363  }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
+ Here is the call graph for this function:

◆ needsActionRow()

ilDclRecordListTableGUI::needsActionRow ( )
protected

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

References ilDclDetailedViewDefinition\isActive().

Referenced by addActionRowIfNeeded().

288  : bool
289  {
290  if ($this->table->getPublicCommentsEnabled() ||
291  ilDclDetailedViewDefinition::isActive($this->tableview->getId())) {
292  return true;
293  }
294 
295  foreach ($this->object_data as $record) {
296  if ($record->hasPermissionToEdit($this->parent_obj->getRefId()) ||
297  $record->hasPermissionToDelete($this->parent_obj->getRefId())) {
298  return true;
299  }
300  }
301 
302  return false;
303  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ numericOrdering()

ilDclRecordListTableGUI::numericOrdering ( string  $a_field)

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

150  : bool
151  {
152  return in_array($a_field, $this->numeric_fields);
153  }

◆ setRecordData()

ilDclRecordListTableGUI::setRecordData ( array  $data)

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

References ilTableGUI\$data, addActionRowIfNeeded(), and buildData().

136  : void
137  {
138  $this->object_data = $data;
139  $this->buildData();
140  $this->addActionRowIfNeeded();
141  }
buildData()
Parse data from record objects to an array that is then set to this table with ::setData() ...
+ Here is the call graph for this function:

Field Documentation

◆ $ctrl

ilCtrl ilDclRecordListTableGUI::$ctrl
protected

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

◆ $filter

array ilDclRecordListTableGUI::$filter = []
protected

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

Referenced by exportData(), and getFilter().

◆ $lng

ilLanguage ilDclRecordListTableGUI::$lng
protected

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

◆ $mode

string ilDclRecordListTableGUI::$mode
protected

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

◆ $numeric_fields

array ilDclRecordListTableGUI::$numeric_fields = []
protected

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

◆ $object_data

array ilDclRecordListTableGUI::$object_data
protected

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

◆ $parent_obj

object ilDclRecordListTableGUI::$parent_obj
protected

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

◆ $table

ilDclTable ilDclRecordListTableGUI::$table
protected

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

◆ $tableview

ilDclTableView ilDclRecordListTableGUI::$tableview
protected

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

◆ $ui

ILIAS DI UIServices ilDclRecordListTableGUI::$ui
protected

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

◆ $userId

int ilDclRecordListTableGUI::$userId
protected

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

◆ EXPORT_EXCEL_ASYNC

const ilDclRecordListTableGUI::EXPORT_EXCEL_ASYNC = 10

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


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