Settings for LO courses. More...

Inheritance diagram for ilObjectTableGUI:

Collaboration diagram for ilObjectTableGUI:

Public Member Functions
	__construct (?object $parent_obj, string $parent_cmd, string $id)

	enableObjectPath (bool $status)

	enabledObjectPath ()

	customizePath (ilPathGUI $path)

	enableRowSelectionInput (bool $stat)

	enabledRowSelectionInput ()

	fillRowSelectionInput (array $set)

	setObjects (array $ref_ids)
	set table content objects More...

	getObjects ()
	get object ref_ids More...

	init ()

	parse ()

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)

Protected Member Functions
	fillRow (array $set)

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
array	$objects = []

bool	$show_path = false

bool	$row_selection_input = false

UIServices	$ui

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

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='')

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

Detailed Description

Settings for LO courses.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 28 of file class.ilObjectTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectTableGUI::__construct	(	?object	$parent_obj,
		string	$parent_cmd,
		string	$id
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\setId(), and ILIAS\Repository\ui().

     {
         global $DIC;
         $this->ui = $DIC->ui();
         $this->setId('obj_table_' . $id);
         parent::__construct($parent_obj, $parent_cmd);
     }

Here is the call graph for this function:

Member Function Documentation

◆ customizePath()

ilObjectTableGUI::customizePath ( ilPathGUI $path )

Definition at line 53 of file class.ilObjectTableGUI.php.

References $path.

Referenced by fillRow().

                                                   : ilPathGUI
     {
         return $path;
     }

Here is the caller graph for this function:

◆ enabledObjectPath()

ilObjectTableGUI::enabledObjectPath ( )

Definition at line 48 of file class.ilObjectTableGUI.php.

References $show_path.

Referenced by fillRow().

                                        : bool
     {
         return $this->show_path;
     }

Here is the caller graph for this function:

◆ enabledRowSelectionInput()

ilObjectTableGUI::enabledRowSelectionInput ( )

Definition at line 63 of file class.ilObjectTableGUI.php.

References $row_selection_input.

Referenced by fillRow(), ilLTIProviderReleasedObjectsTableGUI\init(), and init().

                                               : bool
     {
         return $this->row_selection_input;
     }

Here is the caller graph for this function:

◆ enableObjectPath()

ilObjectTableGUI::enableObjectPath ( bool $status )

Definition at line 43 of file class.ilObjectTableGUI.php.

Referenced by ilObjectCopyCourseGroupSelectionTableGUI\init().

                                                   : void
     {
         $this->show_path = $status;
     }

Here is the caller graph for this function:

◆ enableRowSelectionInput()

ilObjectTableGUI::enableRowSelectionInput ( bool $stat )

Definition at line 58 of file class.ilObjectTableGUI.php.

Referenced by ilObjectCopyCourseGroupSelectionTableGUI\init().

                                                        : void
     {
         $this->row_selection_input = $stat;
     }

Here is the caller graph for this function:

◆ fillRow()

ilObjectTableGUI::fillRow ( array $set )

protected

Definition at line 105 of file class.ilObjectTableGUI.php.

References ilObject\_getIcon(), customizePath(), enabledObjectPath(), enabledRowSelectionInput(), fillRowSelectionInput(), ILIAS\Repository\lng(), ROOT_FOLDER_ID, and ILIAS\Repository\ui().

                                           : void
     {
         if ($this->enabledRowSelectionInput()) {
             $this->fillRowSelectionInput($set);
         }
 
         $type_icon = $this->ui->factory()->symbol()->icon()->custom(
             ilObject::_getIcon($set['obj_id'], 'big', $set['type']),
             $this->lng->txt('obj_' . $set['type'])
         );
 
         $this->tpl->setVariable('OBJ_LINK', ilLink::_getLink($set['ref_id'], $set['type']));
         $this->tpl->setVariable('OBJ_LINKED_TITLE', $set['title']);
         $this->tpl->setVariable('TYPE_IMG', $this->ui->renderer()->render($type_icon));
 
         if ($this->enabledObjectPath()) {
             $path_gui = new ilPathGUI();
             $path_gui = $this->customizePath($path_gui);
 
             $this->tpl->setCurrentBlock('path');
             $this->tpl->setVariable('OBJ_PATH', $path_gui->getPath(ROOT_FOLDER_ID, (int) $set['ref_id']));
             $this->tpl->parseCurrentBlock();
         }
     }

Here is the call graph for this function:

◆ fillRowSelectionInput()

ilObjectTableGUI::fillRowSelectionInput ( array $set )

Definition at line 68 of file class.ilObjectTableGUI.php.

Referenced by fillRow().

                                                      : void
     {
         $this->tpl->setCurrentBlock('row_selection_input');
         $this->tpl->setVariable('OBJ_INPUT_TYPE', 'checkbox');
         $this->tpl->setVariable('OBJ_INPUT_NAME', 'id[]');
         $this->tpl->setVariable('OBJ_INPUT_VALUE', $set['ref_id']);
     }

Here is the caller graph for this function:

◆ getObjects()

ilObjectTableGUI::getObjects ( )

get object ref_ids

Definition at line 87 of file class.ilObjectTableGUI.php.

References $objects.

Referenced by parse().

                                 : array
     {
         return $this->objects;
     }

Here is the caller graph for this function:

◆ init()

ilObjectTableGUI::init ( )

Definition at line 92 of file class.ilObjectTableGUI.php.

References ilTable2GUI\addColumn(), enabledRowSelectionInput(), ILIAS\Repository\lng(), ilTableGUI\setOrderColumn(), and ilTable2GUI\setRowTemplate().

                           : void
     {
         if ($this->enabledRowSelectionInput()) {
             $this->addColumn('', 'id', '5px');
         }
 
         $this->addColumn($this->lng->txt('type'), 'type', '30px');
         $this->addColumn($this->lng->txt('title'), 'title');
 
         $this->setOrderColumn('title');
         $this->setRowTemplate('tpl.object_table_row.html', 'components/ILIAS/ILIASObject');
     }

Here is the call graph for this function:

◆ parse()

ilObjectTableGUI::parse ( )

Definition at line 130 of file class.ilObjectTableGUI.php.

References $ref_id, ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), getObjects(), and ilTable2GUI\setData().

                            : void
     {
         $counter = 0;
         $set = [];
         foreach ($this->getObjects() as $ref_id) {
             $type = ilObject::_lookupType(ilObject::_lookupObjId($ref_id));
             if ($type == 'rolf') {
                 continue;
             }
 
             $set[$counter]['ref_id'] = $ref_id;
             $set[$counter]['obj_id'] = ilObject::_lookupObjId($ref_id);
             $set[$counter]['type'] = ilObject::_lookupType(ilObject::_lookupObjId($ref_id));
             $set[$counter]['title'] = ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id));
             $counter++;
         }
         $this->setData($set);
     }

Here is the call graph for this function:

◆ setObjects()

ilObjectTableGUI::setObjects ( array $ref_ids )

set table content objects

Definition at line 79 of file class.ilObjectTableGUI.php.

                                               : void
     {
         $this->objects = $ref_ids;
     }

Field Documentation

◆ $objects

array ilObjectTableGUI::$objects = []

protected

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

Referenced by getObjects().

◆ $row_selection_input

bool ilObjectTableGUI::$row_selection_input = false

protected

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

Referenced by enabledRowSelectionInput().

◆ $show_path

bool ilObjectTableGUI::$show_path = false

protected

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

Referenced by enabledObjectPath().

◆ $ui

UIServices ilObjectTableGUI::$ui

protected

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

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

components/ILIAS/ILIASObject/classes/class.ilObjectTableGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ customizePath()

◆ enabledObjectPath()

◆ enabledRowSelectionInput()

◆ enableObjectPath()

◆ enableRowSelectionInput()

◆ fillRow()

◆ fillRowSelectionInput()

◆ getObjects()

◆ init()

◆ parse()

◆ setObjects()

Field Documentation

◆ $objects

◆ $row_selection_input

◆ $show_path

◆ $ui