This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilAccessibilityTableGUI:

Collaboration diagram for ilAccessibilityTableGUI:

Public Member Functions
	__construct (object $a_parent_obj, string $command='', string $a_template_context='')

	setProvider (ilAccessibilityTableDataProvider $provider)

	getProvider ()

	getSelectableColumns ()

	populate ()

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
	onBeforeDataFetched (array &$params, array &$filter)

	prepareRow (array &$row)
	This method can be used to add some field values dynamically or manipulate existing values of the table row array. More...

	preProcessData (array &$data)

	formatCellValue (string $column, array $row)
	Define a final formatting for a cell value. More...

	isColumnVisible (int $index)

	fillRow (array $row)

	getColumnDefinition ()

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
ilAccessibilityTableDataProvider	$provider

array	$visibleOptionalColumns = []

array	$optionalColumns = []

array	$filter = []

array	$optional_filter = []

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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilAccessibilityTableGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilAccessibilityTableGUI::__construct	(	object	$a_parent_obj,
		string	$command = `''`,
		string	$a_template_context = `''`
	)

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

References ilTable2GUI\$column, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), getColumnDefinition(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), and isColumnVisible().

       {
         parent::__construct($a_parent_obj, $command, $a_template_context);
 
         $columns = $this->getColumnDefinition();
         $this->optionalColumns = (array) $this->getSelectableColumns();
         $this->visibleOptionalColumns = (array) $this->getSelectedColumns();
 
         foreach ($columns as $index => $column) {
             if ($this->isColumnVisible($index)) {
                 $this->addColumn(
                     $column['txt'],
                     isset($column['sortable']) && $column['sortable'] ? $column['field'] : '',
                     $column['width'] ?? '',
                     isset($column['is_checkbox']) && (bool) $column['is_checkbox']
                 );
             }
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilAccessibilityTableGUI::fillRow ( array $row )

finalprotected

Definition at line 120 of file class.ilAccessibilityTableGUI.php.

References ilTable2GUI\$column, formatCellValue(), getColumnDefinition(), isColumnVisible(), and prepareRow().

                                                 : void
     {
         $this->prepareRow($row);
 
         foreach ($this->getColumnDefinition() as $index => $column) {
             if (!$this->isColumnVisible($index)) {
                 continue;
             }
 
             $this->tpl->setCurrentBlock('column');
             $value = $this->formatCellValue($column['field'], $row);
             if ((string) $value === '') {
                 $this->tpl->touchBlock('column');
             } else {
                 $this->tpl->setVariable('COLUMN_VALUE', $value);
             }
 
             $this->tpl->parseCurrentBlock();
         }
     }

Here is the call graph for this function:

◆ formatCellValue()

ilAccessibilityTableGUI::formatCellValue	(	string	$column,
		array	$row
	)

protected

Define a final formatting for a cell value.

Definition at line 81 of file class.ilAccessibilityTableGUI.php.

Referenced by fillRow().

                                                                   : string
     {
         return trim($row[$column]);
     }

Here is the caller graph for this function:

◆ getColumnDefinition()

ilAccessibilityTableGUI::getColumnDefinition ( )

abstractprotected

Referenced by __construct(), fillRow(), getSelectableColumns(), and isColumnVisible().

Here is the caller graph for this function:

◆ getProvider()

ilAccessibilityTableGUI::getProvider ( )

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

References $provider.

Referenced by populate().

                                  : ?ilAccessibilityTableDataProvider
     {
         return $this->provider;
     }

Here is the caller graph for this function:

◆ getSelectableColumns()

ilAccessibilityTableGUI::getSelectableColumns ( )

Definition at line 86 of file class.ilAccessibilityTableGUI.php.

References ilTable2GUI\$column, and getColumnDefinition().

Referenced by __construct().

                                           : array
     {
         $optionalColumns = array_filter($this->getColumnDefinition(), function ($column) {
             return isset($column['optional']) && $column['optional'];
         });
 
         $columns = [];
         foreach ($optionalColumns as $index => $column) {
             $columns[$column['field']] = $column;
         }
 
         return $columns;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isColumnVisible()

ilAccessibilityTableGUI::isColumnVisible ( int $index )

protected

Definition at line 100 of file class.ilAccessibilityTableGUI.php.

References ilTable2GUI\$column, and getColumnDefinition().

Referenced by __construct(), and fillRow().

                                                   : bool
     {
         $columnDefinition = $this->getColumnDefinition();
         if (array_key_exists($index, $columnDefinition)) {
             $column = $columnDefinition[$index];
             if (isset($column['optional']) && !$column['optional']) {
                 return true;
             }
 
             if (
                 is_array($this->visibleOptionalColumns) &&
                 array_key_exists($column['field'], $this->visibleOptionalColumns)
             ) {
                 return true;
             }
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onBeforeDataFetched()

ilAccessibilityTableGUI::onBeforeDataFetched	(	array &	$params,
		array &	$filter
	)

protected

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

Referenced by populate().

                                                                           : void
     {
     }

Here is the caller graph for this function:

◆ populate()

ilAccessibilityTableGUI::populate ( )

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

References ilTableGUI\$data, $params, ilTable2GUI\determineOffsetAndOrder(), ilTable2GUI\determineSelectedFilters(), ILIAS\Repository\filter(), ilTable2GUI\getExternalSegmentation(), ilTable2GUI\getExternalSorting(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), getProvider(), ilTable2GUI\isFilterSelected(), onBeforeDataFetched(), preProcessData(), ilTable2GUI\resetOffset(), ilTable2GUI\setData(), and ilTableGUI\setMaxCount().

                               : void
     {
         if ($this->getExternalSegmentation() && $this->getExternalSorting()) {
             $this->determineOffsetAndOrder();
         } else {
             if (!$this->getExternalSegmentation() && $this->getExternalSorting()) {
                 $this->determineOffsetAndOrder(true);
             }
         }
 
         $params = [];
         if ($this->getExternalSegmentation()) {
             $params['limit'] = $this->getLimit();
             $params['offset'] = $this->getOffset();
         }
         if ($this->getExternalSorting()) {
             $params['order_field'] = $this->getOrderField();
             $params['order_direction'] = $this->getOrderDirection();
         }
 
         $this->determineSelectedFilters();
         $filter = (array) $this->filter;
 
         foreach ($this->optional_filter as $key => $value) {
             if ($this->isFilterSelected($key)) {
                 $filter[$key] = $value;
             }
         }
 
         $this->onBeforeDataFetched($params, $filter);
         $data = $this->getProvider()->getList($params, $filter);
 
         if (!count($data['items']) && $this->getOffset() > 0 && $this->getExternalSegmentation()) {
             $this->resetOffset();
             if ($this->getExternalSegmentation()) {
                 $params['limit'] = $this->getLimit();
                 $params['offset'] = $this->getOffset();
             }
             $data = $this->provider->getList($params, $filter);
         }
 
         $this->preProcessData($data);
 
         $this->setData($data['items']);
         if ($this->getExternalSegmentation()) {
             $this->setMaxCount($data['cnt']);
         }
     }

Here is the call graph for this function:

◆ prepareRow()

ilAccessibilityTableGUI::prepareRow ( array & $row )

protected

This method can be used to add some field values dynamically or manipulate existing values of the table row array.

Definition at line 70 of file class.ilAccessibilityTableGUI.php.

Referenced by fillRow().

                                               : void
     {
     }

Here is the caller graph for this function:

◆ preProcessData()

ilAccessibilityTableGUI::preProcessData ( array & $data )

protected

Definition at line 74 of file class.ilAccessibilityTableGUI.php.

Referenced by ilAccessibilityDocumentTableGUI\getColumnDefinition(), and populate().

                                                    : void
     {
     }

Here is the caller graph for this function:

◆ setProvider()

ilAccessibilityTableGUI::setProvider ( ilAccessibilityTableDataProvider $provider )

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

References $provider.

                                                                            : void
     {
         $this->provider = $provider;
     }

Field Documentation

◆ $filter

array ilAccessibilityTableGUI::$filter = []

protected

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

◆ $optional_filter

array ilAccessibilityTableGUI::$optional_filter = []

protected

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

◆ $optionalColumns

array ilAccessibilityTableGUI::$optionalColumns = []

protected

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

◆ $provider

ilAccessibilityTableDataProvider ilAccessibilityTableGUI::$provider

protected

Definition at line 24 of file class.ilAccessibilityTableGUI.php.

Referenced by getProvider(), and setProvider().

◆ $visibleOptionalColumns

array ilAccessibilityTableGUI::$visibleOptionalColumns = []

protected

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

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

components/ILIAS/Accessibility/classes/class.ilAccessibilityTableGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fillRow()

◆ formatCellValue()

◆ getColumnDefinition()

◆ getProvider()

◆ getSelectableColumns()

◆ isColumnVisible()

◆ onBeforeDataFetched()

◆ populate()

◆ prepareRow()

◆ preProcessData()

◆ setProvider()

Field Documentation

◆ $filter

◆ $optional_filter

◆ $optionalColumns

◆ $provider

◆ $visibleOptionalColumns