Export table. More...

Inheritance diagram for ilExportTableGUI:

Collaboration diagram for ilExportTableGUI:

Public Member Functions
	__construct (object $a_parent_obj, string $a_parent_cmd, ilObject $a_exp_obj)
	Constructor. More...

	numericOrdering (string $a_field)

	addCustomColumn (string $a_txt, object $a_obj, string $a_func)

	addCustomMultiCommand (string $a_txt, string $a_cmd)

	getCustomColumns ()

	getExportFiles ()

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

	prepareOutput ()

	initMultiCommands ()

	fillRow (array $a_set)

	getRowId (array $row)

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
ilObject	$obj

array	$custom_columns = array()

array	$formats = array()

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

Export table.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilExportTableGUI::__construct	(	object	$a_parent_obj,
		string	$a_parent_cmd,
		ilObject	$a_exp_obj
	)

Constructor.

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), getExportFiles(), initColumns(), initMultiCommands(), ILIAS\Repository\lng(), ilTable2GUI\setData(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setFormAction(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setTitle().

     {
         global $DIC;
 
         $this->obj = $a_exp_obj;
 
         parent::__construct($a_parent_obj, $a_parent_cmd);
         $this->setData($this->getExportFiles());
         $this->setTitle($this->lng->txt('exp_export_files'));
 
         $this->initColumns();
 
         $this->setDefaultOrderField('timestamp');
         $this->setDefaultOrderDirection('desc');
 
         $this->setEnableHeader(true);
         $this->setFormAction($this->ctrl->getFormAction($a_parent_obj));
         $this->setRowTemplate('tpl.export_table_row.html', 'Services/Export');
         $this->initMultiCommands();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addCustomColumn()

ilExportTableGUI::addCustomColumn	(	string	$a_txt,
		object	$a_obj,
		string	$a_func
	)

Definition at line 83 of file class.ilExportTableGUI.php.

References ilTable2GUI\addColumn().

Referenced by ilDclExportTableGUI\__construct().

                                                                                  : void
     {
         $this->addColumn($a_txt);
         $this->custom_columns[] = array('txt' => $a_txt,
             'obj' => $a_obj,
             'func' => $a_func
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCustomMultiCommand()

ilExportTableGUI::addCustomMultiCommand	(	string	$a_txt,
		string	$a_cmd
	)

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

References ilTable2GUI\addMultiCommand().

     {
         $this->addMultiCommand($a_cmd, $a_txt);
     }

Here is the call graph for this function:

◆ fillRow()

ilExportTableGUI::fillRow ( array $a_set )

protected

Definition at line 116 of file class.ilExportTableGUI.php.

References $c, Vendor\Package\$f, $url, ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ilUtil\formatSize(), getCustomColumns(), ilTable2GUI\getParentObject(), getRowId(), IL_CAL_UNIX, and ILIAS\Repository\lng().

                                             : void
     {
         foreach ($this->getCustomColumns() as $c) {
             $this->tpl->setCurrentBlock('custom');
             $f = $c['func'];
             $this->tpl->setVariable('VAL_CUSTOM', $c['obj']->$f($a_set['type'], $a_set['file']) . ' ');
             $this->tpl->parseCurrentBlock();
         }
 
         $file_id = $this->getRowId($a_set);
         $this->tpl->setVariable('VAL_ID', $file_id);
 
         $type = (isset($this->formats[$a_set['type']]) && $this->formats[$a_set['type']] != "")
             ? $this->formats[$a_set['type']]
             : $a_set['type'];
         $this->tpl->setVariable('VAL_TYPE', $type);
         $this->tpl->setVariable('VAL_FILE', $a_set['file']);
         $this->tpl->setVariable('VAL_SIZE', ilUtil::formatSize($a_set['size']));
         $this->tpl->setVariable(
             'VAL_DATE',
             ilDatePresentation::formatDate(new ilDateTime($a_set['timestamp'], IL_CAL_UNIX))
         );
 
         $this->tpl->setVariable('TXT_DOWNLOAD', $this->lng->txt('download'));
 
         $this->ctrl->setParameter($this->getParentObject(), "file", $file_id);
         $url = $this->ctrl->getLinkTarget($this->getParentObject(), "download");
         $this->ctrl->setParameter($this->getParentObject(), "file", "");
         $this->tpl->setVariable('URL_DOWNLOAD', $url);
     }

Here is the call graph for this function:

◆ getCustomColumns()

ilExportTableGUI::getCustomColumns ( )

Definition at line 97 of file class.ilExportTableGUI.php.

References $custom_columns.

Referenced by ilDclExportTableGUI\fillRow(), and fillRow().

                                       : array
     {
         return $this->custom_columns;
     }

Here is the caller graph for this function:

◆ getExportFiles()

ilExportTableGUI::getExportFiles ( )

Definition at line 102 of file class.ilExportTableGUI.php.

References Vendor\Package\$f, and ilExport\_getExportFiles().

Referenced by __construct().

                                     : array
     {
         $types = array();
         foreach ($this->parent_obj->getFormats() as $f) {
             $types[] = $f['key'];
             $this->formats[$f['key']] = $f['txt'];
         }
         return ilExport::_getExportFiles(
             $this->obj->getId(),
             $types,
             $this->obj->getType()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRowId()

ilExportTableGUI::getRowId ( array $row )

protected

Definition at line 147 of file class.ilExportTableGUI.php.

Referenced by ilDclExportTableGUI\fillRow(), and fillRow().

                                            : string
     {
         return $row['type'] . ':' . $row['file'];
     }

Here is the caller graph for this function:

◆ initColumns()

ilExportTableGUI::initColumns ( )

protected

Definition at line 55 of file class.ilExportTableGUI.php.

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

Referenced by __construct().

                                     : void
     {
         $this->addColumn($this->lng->txt(''), '', '1', true);
         $this->addColumn($this->lng->txt('type'), 'type');
         $this->addColumn($this->lng->txt('file'), 'file');
         $this->addColumn($this->lng->txt('size'), 'size');
         $this->addColumn($this->lng->txt('date'), 'timestamp');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initMultiCommands()

ilExportTableGUI::initMultiCommands ( )

protected

Definition at line 78 of file class.ilExportTableGUI.php.

References ilTable2GUI\addMultiCommand(), and ILIAS\Repository\lng().

Referenced by __construct().

                                           : void
     {
         $this->addMultiCommand('confirmDeletion', $this->lng->txt('delete'));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ numericOrdering()

ilExportTableGUI::numericOrdering ( string $a_field )

Definition at line 64 of file class.ilExportTableGUI.php.

                                                     : bool
     {
         if ($a_field === 'size') {
             return true;
         }
         return false;
     }

◆ prepareOutput()

ilExportTableGUI::prepareOutput ( )

protected

Definition at line 72 of file class.ilExportTableGUI.php.

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

                                       : void
     {
         // append at last position (after custom columns)
         $this->addColumn($this->lng->txt('actions'));
     }

Here is the call graph for this function:

Field Documentation

◆ $custom_columns

array ilExportTableGUI::$custom_columns = array()

protected

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

Referenced by getCustomColumns().

◆ $formats

array ilExportTableGUI::$formats = array()

protected

Definition at line 29 of file class.ilExportTableGUI.php.

◆ $obj

ilObject ilExportTableGUI::$obj

protected

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

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

components/ILIAS/Export/classes/class.ilExportTableGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCustomColumn()

◆ addCustomMultiCommand()

◆ fillRow()

◆ getCustomColumns()

◆ getExportFiles()

◆ getRowId()

◆ initColumns()

◆ initMultiCommands()

◆ numericOrdering()

◆ prepareOutput()

Field Documentation

◆ $custom_columns

◆ $formats

◆ $obj