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 ()

	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

bool	$page_active = false

Protected Attributes inherited from ilTable2GUI
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_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 145 of file class.ilDclRecordListTableGUI.php.

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

Referenced by setRecordData().

                                              : void
     {
         if ($this->needsActionRow()) {
             $this->addColumn($this->lng->txt("actions"), "", "");
         }
     }

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 343 of file class.ilDclRecordListTableGUI.php.

References ILIAS\Repository\filter().

Referenced by initFilter().

     {
         if ($filter_value) {
             $this->filter["filter_" . $field_id] = $filter_value;
         }
     }

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 160 of file class.ilDclRecordListTableGUI.php.

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

Referenced by setRecordData().

                                 : void
     {
         $data = [];
         foreach ($this->object_data as $record) {
             $record_data = [];
             $record_data["_front"] = null;
             $record_data['_record'] = $record;
 
             foreach ($this->tableview->getVisibleFields() as $field) {
                 $title = $field->getTitle();
                 $record_data[$title] = $record->getRecordFieldHTML($field->getId(), ['tableview_id' => $this->tableview->getId()]);
 
                 // Additional column filled in ::fillRow() method, showing the learning progress
                 if ($field->getProperty(ilDclBaseFieldModel::PROP_LEARNING_PROGRESS)) {
                     $record_data["_status_" . $title] = $this->getStatus($record, $field);
                 }
 
                 if ($field->getId() == 'comments') {
                     $record_data['n_comments'] = $record->getNrOfComments();
                 }
             }
 
             $this->ctrl->setParameterByClass(ilDclFieldEditGUI::class, "record_id", $record->getId());
             $this->ctrl->setParameterByClass(ilDclDetailedViewGUI::class, "table_id", $record->getTableId());
             $this->ctrl->setParameterByClass(ilDclDetailedViewGUI::class, "record_id", $record->getId());
             $this->ctrl->setParameterByClass(ilDclDetailedViewGUI::class, "tableview_id", $this->tableview->getId());
             $this->ctrl->setParameterByClass(ilDclRecordEditGUI::class, "record_id", $record->getId());
             $this->ctrl->setParameterByClass(ilDclRecordEditGUI::class, "tableview_id", $this->tableview->getId());
             $this->ctrl->setParameterByClass(ilDclRecordEditGUI::class, "mode", $this->mode);
 
             $action_links = [];
 
             if ($this->page_active) {
                 $record_data["_front"] = $this->ctrl->getLinkTargetByClass(ilDclDetailedViewGUI::class, 'renderRecord');
                 $action_links[] = $this->ui->factory()->link()->standard(
                     $this->lng->txt('view'),
                     $this->ctrl->getLinkTargetByClass(ilDclDetailedViewGUI::class, 'renderRecord')
                 );
             }
 
             if ($record->hasPermissionToEdit($this->parent_obj->getRefId())) {
                 $action_links[] = $this->ui->factory()->link()->standard(
                     $this->lng->txt('edit'),
                     $this->ctrl->getLinkTargetByClass(ilDclRecordEditGUI::class, 'edit')
                 );
             }
 
             if ($record->hasPermissionToDelete($this->parent_obj->getRefId())) {
                 $action_links[] = $this->ui->factory()->link()->standard(
                     $this->lng->txt('delete'),
                     $this->ctrl->getLinkTargetByClass(ilDclRecordEditGUI::class, 'confirmDelete')
                 );
             }
 
             if ($this->table->getPublicCommentsEnabled()) {
                 $js_code = $this->getCommentJsLinkCode($record->getId());
                 $action_links[] = $this->ui->factory()->button()->shy(
                     $this->lng->txt('dcl_comments'),
                     "#"
                 )->withAdditionalOnLoadCode(function ($id) use ($js_code) {
                     return "document.getElementById('$id').addEventListener('click',function()
                         { 
                             $js_code
                         });";
                 });
             }
             $action_dropdown = $this->ui->factory()->dropdown()->standard($action_links)
                                         ->withLabel($this->lng->txt("actions"));
             $record_data["_actions"] = $this->ui->renderer()->render($action_dropdown);
 
             $data[] = $record_data;
         }
         $this->setData($data);
     }

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 383 of file class.ilDclRecordListTableGUI.php.

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

      : void {
         if ($this->dataExists()) {
             $exporter = new ilDclContentExporter(
                 $this->parent_obj->getRefId(),
                 $this->table->getId(),
                 $this->filter
             );
             $exporter->export(ilDclContentExporter::EXPORT_EXCEL, null, true);
         }
     }

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 366 of file class.ilDclRecordListTableGUI.php.

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

Referenced by buildData().

                                                           : string
     {
         $ajax_hash = ilCommonActionDispatcherGUI::buildAjaxHash(
             1,
             $this->parent_obj->getRefId(),
             'dcl',
             $this->parent_obj->getObjId(),
             'dcl',
             $recordId
         );
 
         return ilNoteGUI::getListCommentsJSCall($ajax_hash, '');
     }

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 133 of file class.ilDclRecordListTableGUI.php.

References $filter.

                                : array
     {
         return $this->filter;
     }

◆ getStatus()

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

protected

This adds the column for status.

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

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

Referenced by buildData().

                                                                                           : string
     {
         $record_field = ilDclCache::getRecordFieldCache($record, $field);
         $return = "";
         if ($status = $record_field->getStatus()) {
             $icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_LONG);
             $return = $icons->renderIconForStatus($status->status);
         }
 
         return $return;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFilter()

ilDclRecordListTableGUI::initFilter ( )

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

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

                                 : void
     {
         foreach ($this->tableview->getFilterableFieldSettings() as $field_set) {
             $field = $field_set->getFieldObject();
             $value = ilDclCache::getFieldRepresentation($field)->addFilterInputFieldToTable($this);
             $filter = $this->getFilterItemByPostVar('filter_' . $field->getId());
 
             $isset = ilSession::has("form_" . $filter->getParentTable()->getId() . "_" . $filter->getFieldId());
             if (!$field_set->isFilterChangeable() || !$isset) {
                 $value = $field_set->getFilterValue();
                 $filter->setValueByArray($value);
                 $value = $filter->getValue();
 
                 if (!$field_set->isFilterChangeable()) {
                     $filter->setDisabled(true);
                     if ($filter instanceof ilCombinationInputGUI) {
                         $filter->__call('setDisabled', [true]);
                     }
                 }
             }
 
             $this->applyFilter($field->getId(), $value);
         }
     }

Here is the call graph for this function:

◆ loadProperty()

ilDclRecordListTableGUI::loadProperty ( string $type )

Parameters

string $type

Returns: string

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

References ilTable2GUI\getId().

                                               : string
     {
         if ($this->getId() && $this->userId > 0) {
             $tab_prop = new ilTablePropertiesStorageGUI();
             return $tab_prop->getProperty($this->getId(), $this->userId, $type);
         }
         return "";
     }

Here is the call graph for this function:

◆ needsActionRow()

ilDclRecordListTableGUI::needsActionRow ( )

protected

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

References $page_active.

Referenced by addActionRowIfNeeded().

                                        : bool
     {
         if ($this->table->getPublicCommentsEnabled() || $this->page_active) {
             return true;
         }
 
         foreach ($this->object_data as $record) {
             if ($record->hasPermissionToEdit($this->parent_obj->getRefId()) ||
                 $record->hasPermissionToDelete($this->parent_obj->getRefId())) {
                 return true;
             }
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ numericOrdering()

ilDclRecordListTableGUI::numericOrdering ( string $a_field )

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

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

◆ setRecordData()

ilDclRecordListTableGUI::setRecordData ( array $data )

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

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

                                               : void
     {
         $this->object_data = $data;
         $this->buildData();
         $this->addActionRowIfNeeded();
     }