Inheritance diagram for ilAccessibilityTableGUI:

Collaboration diagram for ilAccessibilityTableGUI:

Public Member Functions

__construct ($a_parent_obj, $command='', $a_template_context='')

Parameters

object	$a_parent_obj	ob Mostly ILIAS-GUI-Classes
string	$a_parent_cmd
string	$a_template_context

More...

setProvider (ilAccessibilityTableDataProvider $provider)

getProvider ()

getSelectableColumns ()

populate ()

Public Member Functions inherited from ilTable2GUI

__construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")

ilTable2GUI constructor. More...

setOpenFormTag ($a_val)

Set open form tag. More...

getOpenFormTag ()

Get open form tag. More...

setCloseFormTag ($a_val)

Set close form tag. More...

getCloseFormTag ()

Get close form tag. More...

determineLimit ()

Determine the limit. More...

getSelectableColumns ()

Get selectable columns. More...

determineSelectedColumns ()

Determine selected columns. More...

isColumnSelected ($a_col)

Is given column selected? More...

getSelectedColumns ()

Get selected columns. More...

executeCommand ()

Execute command. More...

resetOffset ($a_in_determination=false)

Reset offset. More...

initFilter ()

Init filter. More...

getParentObject ()

Get parent object. More...

getParentCmd ()

Get parent command. More...

setTopAnchor ($a_val)

Set top anchor. More...

getTopAnchor ()

Get top anchor. More...

setNoEntriesText ($a_text)

Set text for an empty table. More...

getNoEntriesText ()

Get text for an empty table. More...

setIsDataTable ($a_val)

Set is data table. More...

getIsDataTable ()

Get is data table. More...

setEnableTitle ($a_enabletitle)

Set Enable Title. More...

getEnableTitle ()

Get Enable Title. More...

setEnableHeader ($a_enableheader)

Set Enable Header. More...

getEnableHeader ()

Get Enable Header. More...

setEnableNumInfo ($a_val)

Set enable num info. More...

getEnableNumInfo ()

Get enable num info. More...

setTitle ($a_title, $a_icon=0, $a_icon_alt=0)

Set title and title icon. More...

setDescription ($a_val)

Set description. More...

getDescription ()

Get description. More...

setOrderField ($a_order_field)

set order column More...

getOrderField ()

setData ($a_data)

set table data @access public More...

getData ()

dataExists ()

setPrefix ($a_prefix)

set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More...

getPrefix ()

addFilterItem ($a_input_item, $a_optional=false)

Add filter item. More...

addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null)

Add filter by standard type. More...

getFilterItems ($a_optionals=false)

Get filter items. More...

getFilterItemByPostVar ($a_post_var)

setFilterCols ($a_val)

Set filter columns. More...

getFilterCols ()

Get filter columns. More...

setDisableFilterHiding ($a_val=true)

Set disable filter hiding. More...

getDisableFilterHiding ()

Get disable filter hiding. More...

isFilterSelected ($a_col)

Is given filter selected? More...

getSelectedFilters ()

Get selected filters. More...

determineSelectedFilters ()

Determine selected filters. More...

setCustomPreviousNext ($a_prev_link, $a_next_link)

Set custom previous/next links. More...

setFormAction ($a_form_action, $a_multipart=false)

Set Form action parameter. More...

getFormAction ()

Get Form action parameter. More...

setFormName ($a_formname="")

Set Form name. More...

getFormName ()

Get Form name. More...

setId ($a_val)

Set id. More...

getId ()

Get element id. More...

setDisplayAsBlock ($a_val)

Set display as block. More...

getDisplayAsBlock ()

Get display as block. More...

getSelectAllCheckbox ()

Get the name of the checkbox that should be toggled with a select all button. More...

setSelectAllCheckbox ($a_select_all_checkbox, $a_select_all_on_top=false)

Set the name of the checkbox that should be toggled with a select all button. More...

setExternalSorting ($a_val)

Set external sorting. More...

getExternalSorting ()

Get external sorting. More...

setFilterCommand ($a_val, $a_caption=null)

Set filter command. More...

getFilterCommand ()

Get filter command. More...

setResetCommand ($a_val, $a_caption=null)

Set reset filter command. More...

getResetCommand ()

Get reset filter command. More...

setExternalSegmentation ($a_val)

Set external segmentation. More...

getExternalSegmentation ()

Get external segmentation. More...

setRowTemplate ($a_template, $a_template_dir="")

Set row template. More...

setDefaultOrderField ($a_defaultorderfield)

Set Default order field. More...

getDefaultOrderField ()

Get Default order field. More...

setDefaultOrderDirection ($a_defaultorderdirection)

Set Default order direction. More...

getDefaultOrderDirection ()

Get Default order direction. More...

setDefaultFilterVisiblity ($a_status)

Set default filter visiblity. More...

getDefaultFilterVisibility ()

Get default filter visibility. More...

clearCommandButtons ()

addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)

Add Command button. More...

addCommandButtonInstance (ilButtonBase $a_button)

Add Command button instance. More...

addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')

Add Selection List + Command button. More...

addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')

Add Selection List + Command button for selected items. More...

setCloseCommand ($a_link)

Add command for closing table. More...

addMultiCommand ($a_cmd, $a_text)

Add Command button. More...

addHiddenInput ($a_name, $a_value)

Add Hidden Input field. More...

addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")

Add Header Command (Link) (Image needed for now) More...

setTopCommands ($a_val)

Set top commands (display command buttons on top of table, too) More...

getTopCommands ()

Get top commands (display command buttons on top of table, too) More...

addColumn ( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)

Add a column to the header. More...

getNavParameter ()

setOrderLink ($sort_field, $order_dir)

fillHeader ()

determineOffsetAndOrder ($a_omit_offset=false)

Determine offset and order. More...

storeNavParameter ()

getHTML ()

Get HTML. More...

numericOrdering ($a_field)

Should this field be sorted numeric? More...

render ()

render table @access public More...

writeFilterToSession ()

Write filter values to session. More...

resetFilter ()

Reset filter. More...

fillFooter ()

Fill footer row. More...

getLinkbar ($a_num)

Get previous/next linkbar. More...

fillHiddenRow ()

fillActionRow ()

Fill Action Row. More...

setHeaderHTML ($html)

set header html More...

storeProperty ($type, $value)

Store table property. More...

loadProperty ($type)

Load table property. More...

getCurrentState ()

get current settings for order, limit, columns and filter More...

setContext ($id)

Set context. More...

getContext ()

Get context. More...

setShowRowsSelector ($a_value)

Toggle rows-per-page selector. More...

getShowRowsSelector ()

Get rows-per-page selector state. More...

setShowTemplates ($a_value)

Toggle templates. More...

getShowTemplates ()

Get template state. More...

restoreTemplate ($a_name)

Restore state from template. More...

saveTemplate ($a_name)

Save current state as template. More...

deleteTemplate ($a_name)

Delete template. More...

getLimit ()

Get limit. More...

getOffset ()

Get offset. More...

setExportFormats (array $formats)

Set available export formats. More...

setPrintMode ($a_value=false)

Toogle print mode. More...

getPrintMode ()

Get print mode. More...

getExportMode ()

Was export activated? More...

exportData ($format, $send=false)

Export and optionally send current table data. More...

setEnableAllCommand ($a_value)

Enable actions for all entries in current result. More...

setRowSelectorLabel ($row_selector_label)

getRowSelectorLabel ()

setPreventDoubleSubmission ($a_val)

Set prevent double submission. More...

getPreventDoubleSubmission ()

Get prevent double submission. More...

setLimit ($a_limit=0, $a_default_limit=0)

set max. More...

Public Member Functions inherited from ilTableGUI

__construct ($a_data=0, $a_global_tpl=true)

Constructor. More...

setTemplate ($a_tpl)

set template @access public More...

& getTemplateObject ()

setData ($a_data)

set table data @access public More...

getData ()

setTitle ($a_title, $a_icon=0, $a_icon_alt=0)

set table title @access public More...

setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)

set table help page @access public More...

setHeaderNames ($a_header_names)

set table header names @access public More...

getColumnCount ()

Returns the column count based on the number of the header row columns @access public. More...

setHeaderVars ($a_header_vars, $a_header_params=0)

set table header vars @access public More...

setColumnWidth ($a_column_width)

set table column widths @access public More...

setOneColumnWidth ($a_column_width, $a_column_number)

set one table column width @access public More...

setMaxCount ($a_max_count)

set max. More...

setLimit ($a_limit=0, $a_default_limit=0)

set max. More...

getLimit ()

Get limit. More...

setPrefix ($a_prefix)

set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More...

setOffset ($a_offset)

set dataset offset @access public More...

getOffset ()

Get offset. More...

setOrderColumn ($a_order_column=0, $a_default_column=0)

set order column @access public More...

getOrderColumn ()

Get order column. More...

setOrderDirection ($a_order_direction)

set order direction @access public More...

getOrderDirection ()

Get order direction. More...

setFooter ($a_style, $a_previous=0, $a_next=0)

set order direction @access public More...

enable ($a_module_name)

enables particular modules of table More...

disable ($a_module_name)

diesables particular modules of table More...

sortData ()

render ()

render table @access public More...

renderHeader ()

setOrderLink ($key, $order_dir)

setStyle ($a_element, $a_style)

getStyle ($a_element)

setBase ($a_base)

Set Base script name (deprecated, only use this for workarounds). More...

getBase ()

Get Base script name (deprecated, only use this for workarounds). More...

getFormName ()

setFormName ($a_name="cmd")

getSelectAllCheckbox ()

setSelectAllCheckbox ($a_select_all_checkbox)

clearActionButtons ()

addActionButton ($btn_name, $btn_value)

Protected Member Functions
	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 ($row)

	getColumnDefinition ()

Protected Member Functions inherited from ilTable2GUI
	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, $a_element)
	Check if filter element is based on adv md. More...

	fillRow ($a_set)
	Standard Version of Fill Row. More...

	getFilterValue (ilFormPropertyGUI $a_item)
	Get current filter value. More...

	SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
	Set current filter value. More...

	fillMetaExcel (ilExcel $a_excel, &$a_row)
	Add meta information to excel export. More...

	fillHeaderExcel (ilExcel $a_excel, &$a_row)
	Excel Version of Fill Header. More...

	fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
	Excel Version of Fill Row. More...

	fillMetaCSV ($a_csv)
	Add meta information to csv export. More...

	fillHeaderCSV ($a_csv)
	CSV Version of Fill Header. More...

	fillRowCSV ($a_csv, $a_set)
	CSV Version of Fill Row. More...

Protected Attributes
	$provider

	$visibleOptionalColumns = []

	$optionalColumns = []

	$filter = []

	$optional_filter = []

Protected Attributes inherited from ilTable2GUI
	$ctrl

	$tpl

	$parent_obj

	$parent_cmd

	$close_command = ""

	$top_anchor = "il_table_top"

	$filters = array()

	$optional_filters = array()

	$filter_cmd = 'applyFilter'

	$reset_cmd = 'resetFilter'

	$filter_cols = 5

	$ext_sort = false

	$ext_seg = false

	$context = ""

	$mi_sel_buttons = []

	$disable_filter_hiding = false

	$selected_filter = false

	$top_commands = true

	$selectable_columns = array()

	$selected_column = array()

	$show_templates = false

	$show_rows_selector = true

	$rows_selector_off = false

	$nav_determined = false

	$limit_determined = false

	$filters_determined = false

	$columns_determined = false

	$open_form_tag = true

	$close_form_tag = true

	$export_formats = []

	$export_mode

	$print_mode

	$enable_command_for_all

	$restore_filter

	$restore_filter_values

	$default_filter_visibility = false

	$sortable_fields = array()

	$prevent_double_submission = true

	$row_selector_label

	$select_all_on_top = false

	$sel_buttons = []

Protected Attributes inherited from ilTableGUI
	$tpl

	$lng

Additional Inherited Members
Static Public Member Functions inherited from ilTable2GUI
static	getAllCommandLimit ()
	Get maximum number of entries to enable actions for all. More...

Data Fields inherited from ilTable2GUI
const	FILTER_TEXT = 1

const	FILTER_SELECT = 2

const	FILTER_DATE = 3

const	FILTER_LANGUAGE = 4

const	FILTER_NUMBER_RANGE = 5

const	FILTER_DATE_RANGE = 6

const	FILTER_DURATION_RANGE = 7

const	FILTER_DATETIME_RANGE = 8

const	FILTER_CHECKBOX = 9

const	EXPORT_EXCEL = 1

const	EXPORT_CSV = 2

const	ACTION_ALL_LIMIT = 1000

Data Fields inherited from ilTableGUI
	$title

	$icon

	$icon_alt

	$help_page

	$help_icon

	$help_icon_alt

	$header_names

	$header_vars

	$linkbar_vars

	$data

	$column_count

	$column_width

	$max_count

	$limit

	$max_limit = false

	$offset

	$order_column

	$order_direction

	$footer_style

	$footer_previous

	$footer_next

	$lang_support = true

	$global_tpl

	$form_name

	$select_all_checkbox

	$action_buttons

	$prefix

	$base = ""

	$enabled

	$styles

Detailed Description

Class ilAccessibilityTableGUI.

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

Constructor & Destructor Documentation

◆ __construct()

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

ilTable2GUI constructor.

Parameters

object	$a_parent_obj	ob Mostly ILIAS-GUI-Classes
string	$a_parent_cmd
string	$a_template_context

Reimplemented from ilTable2GUI.

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

    {
        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'] : '',
                    isset($column['width']) ? $column['width'] : '',
                    isset($column['is_checkbox']) ? (bool) $column['is_checkbox'] : false
                );
            }
        }
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilAccessibilityTableGUI::fillRow ( $row )

finalprotected

Parameters

array $row

Reimplemented from ilTable2GUI.

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

    {
        $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();
        }
    }

References $index, formatCellValue(), getColumnDefinition(), isColumnVisible(), and prepareRow().

Here is the call graph for this function:

◆ formatCellValue()

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

protected

Define a final formatting for a cell value.

Parameters

string	$column
array	$row

Returns: string

Reimplemented in ilAccessibilityDocumentTableGUI.

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

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

Referenced by fillRow().

Here is the caller graph for this function:

◆ getColumnDefinition()

ilAccessibilityTableGUI::getColumnDefinition ( )

abstractprotected

Returns: array

Reimplemented in ilAccessibilityDocumentTableGUI.

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

Here is the caller graph for this function:

◆ getProvider()

ilAccessibilityTableGUI::getProvider ( )

Returns: ilAccessibilityTableDataProvider|null

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

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

References $provider.

Referenced by populate().

Here is the caller graph for this function:

◆ getSelectableColumns()

ilAccessibilityTableGUI::getSelectableColumns ( )

Returns: array

Reimplemented from ilTable2GUI.

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

    {
        $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;
    }

References $columns, $index, $optionalColumns, and getColumnDefinition().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isColumnVisible()

ilAccessibilityTableGUI::isColumnVisible ( int $index )

protected

Parameters

int $index

Returns: bool

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

                                                   : 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;
    }

References $index, and getColumnDefinition().

Referenced by __construct(), and fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onBeforeDataFetched()

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

protected

Parameters

array	$params
array	$filter

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

                                                                           : void
    {
    }

Referenced by populate().

Here is the caller graph for this function:

◆ populate()

ilAccessibilityTableGUI::populate ( )

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

                               : 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']);
        }
    }

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

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.

Parameters

array $row

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

                                               : void
    {
    }

Referenced by fillRow().

Here is the caller graph for this function:

◆ preProcessData()

ilAccessibilityTableGUI::preProcessData ( array & $data )

protected

Parameters

array $data

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

                                                    : void
    {
    }

Referenced by populate().

Here is the caller graph for this function:

◆ setProvider()

ilAccessibilityTableGUI::setProvider ( ilAccessibilityTableDataProvider $provider )

Parameters

ilAccessibilityTableDataProvider $provider

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

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

References $provider.

Field Documentation

◆ $filter

ilAccessibilityTableGUI::$filter = []

protected

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

Referenced by populate().

◆ $optional_filter

ilAccessibilityTableGUI::$optional_filter = []

protected

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

◆ $optionalColumns

ilAccessibilityTableGUI::$optionalColumns = []

protected

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

Referenced by getSelectableColumns().

◆ $provider

ilAccessibilityTableGUI::$provider

protected

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

Referenced by getProvider(), and setProvider().

◆ $visibleOptionalColumns

ilAccessibilityTableGUI::$visibleOptionalColumns = []

protected

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

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

Services/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