Inheritance diagram for ILIAS\WebDAV\Mount\DocumentTableGUI:

Collaboration diagram for ILIAS\WebDAV\Mount\DocumentTableGUI:

Public Member Functions
	__construct (UploadGUI $parent_obj, protected UriBuilder $webdav_uri_builder, string $command, protected Factory $ui_factory, protected Renderer $ui_renderer, protected RequestInterface $request, protected bool $is_editable=false)

	setProvider (TableDataProvider $provider)

	getProvider ()

	getSelectableColumns ()
	Get selectable columns. More...

	populate ()

	getHTML ()
	Get HTML. 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)
	Set table data. More...

	getData ()

	dataExists ()

	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...

	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 ()
	get the name of the parent form More...

	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)
	set max. More...

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
	isColumnVisible (int $index)

	fillRow (array $row)
	Standard Version of Fill Row. More...

	getColumnDefinition ()

	preProcessData (array &$data)

	formatCellValue (string $column, array $row)

	formatActions (string $column, array $row)

	formatTitle (string $column, array $row)

	formatSorting (string $column, 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
int	$factor = 10

int	$i = 1

int	$num_rendered_criteria = 0

array	$optional_columns

array	$visible_optional_columns

array	$ui_components = []

TableDataProvider	$provider = null

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

Definition at line 32 of file DocumentTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\WebDAV\Mount\DocumentTableGUI::__construct	(	UploadGUI	$parent_obj,
		protected UriBuilder	$webdav_uri_builder,
		string	$command,
		protected Factory	$ui_factory,
		protected Renderer	$ui_renderer,
		protected RequestInterface	$request,
		protected bool	$is_editable = `false`
	)

Definition at line 45 of file DocumentTableGUI.php.

      {
        $this->setId('mount_instructions_documents');
        $this->setFormName('mount_instructions_documents');
 
        parent::__construct($parent_obj, $command);
 
        $columns = $this->getColumnDefinition();
        $this->optional_columns = $this->getSelectableColumns();
        $this->visible_optional_columns = $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']
                );
            }
        }
 
        $this->setTitle($this->lng->txt('webdav_tbl_docs_title'));
        $this->setFormAction($this->ctrl->getFormAction($this->getParentObject(), $command));
 
        $this->setDefaultOrderDirection('ASC');
        $this->setDefaultOrderField('sorting');
        $this->setExternalSorting(true);
        $this->setExternalSegmentation(true);
        $this->setLimit(PHP_INT_MAX);
 
        $this->setRowTemplate('tpl.webdav_documents_row.html', 'components/ILIAS/WebDAV');
 
        if ($this->is_editable) {
            $this->addCommandButton('saveDocumentSorting', $this->lng->txt('sorting_save'));
        }
 
        ModalGUI::maybeRenderWebDAVModalInGlobalTpl();
    }

References ilTable2GUI\$column, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ILIAS\Repository\ctrl(), ILIAS\WebDAV\Mount\DocumentTableGUI\getColumnDefinition(), ILIAS\WebDAV\Mount\DocumentTableGUI\getSelectableColumns(), ilTable2GUI\getSelectedColumns(), ILIAS\WebDAV\Mount\DocumentTableGUI\isColumnVisible(), ILIAS\Repository\lng(), ILIAS\WebDAV\Mount\ModalGUI\maybeRenderWebDAVModalInGlobalTpl(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setTitle().

Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ILIAS\WebDAV\Mount\DocumentTableGUI::fillRow ( array $a_set )

finalprotected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters

array<string,mixed> $a_set data array

Reimplemented from ilTable2GUI.

Definition at line 139 of file DocumentTableGUI.php.

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

References ilTable2GUI\$column, ILIAS\WebDAV\Mount\DocumentTableGUI\formatCellValue(), ILIAS\WebDAV\Mount\DocumentTableGUI\getColumnDefinition(), and ILIAS\WebDAV\Mount\DocumentTableGUI\isColumnVisible().

Here is the call graph for this function:

◆ formatActions()

ILIAS\WebDAV\Mount\DocumentTableGUI::formatActions	(	string	$column,
		array	$row
	)

protected

Definition at line 286 of file DocumentTableGUI.php.

                                                                : string
    {
        if (!$this->is_editable) {
            return '';
        }
 
        $this->ctrl->setParameter($this->getParentObject(), 'document_id', $row['id']);
 
        $edit_btn = $this->ui_factory
            ->button()
            ->shy(
                $this->lng->txt('edit'),
                $this->ctrl->getLinkTarget($this->getParentObject(), 'showEditDocumentForm')
            );
 
        $delete_modal = $this->ui_factory
            ->modal()
            ->interruptive(
                $this->lng->txt('webdav_doc_delete'),
                $this->lng->txt('webdav_sure_delete_documents_s') . ' ' . $row['title'],
                $this->ctrl->getFormAction($this->getParentObject(), 'deleteDocument')
            );
 
        $delete_btn = $this->ui_factory
            ->button()
            ->shy($this->lng->txt('delete'), '#')
            ->withOnClick($delete_modal->getShowSignal());
 
        $this->ui_components[] = $delete_modal;
 
        $this->ctrl->setParameter($this->getParentObject(), 'document_id', null);
 
        $drop_down = $this->ui_factory
            ->dropdown()
            ->standard([$edit_btn, $delete_btn])
            ->withLabel($this->lng->txt('actions'));
 
        return $this->ui_renderer->render($drop_down);
    }

References ILIAS\Repository\ctrl(), ilTable2GUI\getParentObject(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ formatCellValue()

ILIAS\WebDAV\Mount\DocumentTableGUI::formatCellValue	(	string	$column,
		array	$row
	)

protected

Definition at line 273 of file DocumentTableGUI.php.

                                                                  : string
    {
        $function = 'format' . ucfirst($column);
        if (method_exists($this, $function)) {
            return $this->{$function}($column, $row);
        }
        if (in_array($column, ['creation_ts', 'modification_ts'], true)) {
            return ilDatePresentation::formatDate(new ilDateTime($row[$column], IL_CAL_DATETIME));
        }
 
        return trim((string) $row[$column]);
    }

References ilTable2GUI\$column, ilDatePresentation\formatDate(), and IL_CAL_DATETIME.

Referenced by ILIAS\WebDAV\Mount\DocumentTableGUI\fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ formatSorting()

ILIAS\WebDAV\Mount\DocumentTableGUI::formatSorting	(	string	$column,
		array	$row
	)

protected

Definition at line 341 of file DocumentTableGUI.php.

                                                                : string
    {
        $value = (string) (($this->i++) * $this->factor);
        if (!$this->is_editable) {
            return $value;
        }
 
        $sorting_field = new ilNumberInputGUI('', 'sorting[' . $row['id'] . ']');
        $sorting_field->setValue($value);
        $sorting_field->setMaxLength(4);
        $sorting_field->setSize(2);
 
        return $sorting_field->render();
    }

References ILIAS\WebDAV\Mount\DocumentTableGUI\$factor.

◆ formatTitle()

ILIAS\WebDAV\Mount\DocumentTableGUI::formatTitle	(	string	$column,
		array	$row
	)

protected

Definition at line 326 of file DocumentTableGUI.php.

                                                              : string
    {
        if ($row['processed_text'] === null) {
            $row['processed_text'] = '';
        }
 
        $url = $this->webdav_uri_builder->getUriToMountInstructionModalByLanguage($row['language']);
        $title_link = $this->ui_factory
            ->button()
            ->shy($row[$column], '#')
            ->withAdditionalOnLoadCode(fn($id): string => "$('#$id').click(function(){ triggerWebDAVModal('$url');});");
 
        return $this->ui_renderer->render([$title_link]);
    }

References ilTable2GUI\$column, ilTable2GUI\$id, and $url.

◆ getColumnDefinition()

ILIAS\WebDAV\Mount\DocumentTableGUI::getColumnDefinition ( )

protected

Definition at line 158 of file DocumentTableGUI.php.

                                            : array
    {
        $i = 0;
 
        $columns = [];
 
        $columns[++$i] = [
            'field' => 'sorting',
            'txt' => $this->lng->txt('meta_order', 'meta'),
            'default' => true,
            'optional' => false,
            'sortable' => false,
            'width' => '5%',
        ];
 
        $columns[++$i] = [
            'field' => 'title',
            'txt' => $this->lng->txt('webdav_tbl_docs_head_title'),
            'default' => true,
            'optional' => false,
            'sortable' => false,
            'width' => '25%',
        ];
 
        $columns[++$i] = [
            'field' => 'creation_ts',
            'txt' => $this->lng->txt('created'),
            'default' => true,
            'optional' => true,
            'sortable' => false,
        ];
 
        $columns[++$i] = [
            'field' => 'modification_ts',
            'txt' => $this->lng->txt('last_change'),
            'default' => true,
            'optional' => true,
            'sortable' => false,
        ];
 
        $columns[++$i] = [
            'field' => 'language',
            'txt' => $this->lng->txt('language'),
            'default' => true,
            'optional' => false,
            'sortable' => false,
        ];
 
        if ($this->is_editable) {
            $columns[++$i] = [
                'field' => 'actions',
                'txt' => $this->lng->txt('actions'),
                'default' => true,
                'optional' => false,
                'sortable' => false,
                'width' => '10%',
            ];
        }
 
        return $columns;
    }

References ILIAS\WebDAV\Mount\DocumentTableGUI\$i, and ILIAS\Repository\lng().

Referenced by ILIAS\WebDAV\Mount\DocumentTableGUI\__construct(), ILIAS\WebDAV\Mount\DocumentTableGUI\fillRow(), ILIAS\WebDAV\Mount\DocumentTableGUI\getSelectableColumns(), and ILIAS\WebDAV\Mount\DocumentTableGUI\isColumnVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ILIAS\WebDAV\Mount\DocumentTableGUI::getHTML ( )

Get HTML.

Reimplemented from ilTable2GUI.

Definition at line 357 of file DocumentTableGUI.php.

                             : string
    {
        return parent::getHTML() . $this->ui_renderer->render($this->ui_components);
    }

◆ getProvider()

ILIAS\WebDAV\Mount\DocumentTableGUI::getProvider ( )

Definition at line 97 of file DocumentTableGUI.php.

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

References ILIAS\WebDAV\Mount\DocumentTableGUI\$provider.

Referenced by ILIAS\WebDAV\Mount\DocumentTableGUI\populate().

Here is the caller graph for this function:

◆ getSelectableColumns()

ILIAS\WebDAV\Mount\DocumentTableGUI::getSelectableColumns ( )

Get selectable columns.

Returns: array key: column id, val: true/false -> default on/off

Reimplemented from ilTable2GUI.

Definition at line 103 of file DocumentTableGUI.php.

                                          : array
    {
        $optional_columns = array_filter(
            $this->getColumnDefinition(),
            static fn(array $column): bool => isset($column['optional']) && $column['optional']
        );
 
        $columns = [];
        foreach ($optional_columns as $column) {
            $columns[$column['field']] = $column;
        }
 
        return $columns;
    }

References ilTable2GUI\$column, ILIAS\WebDAV\Mount\DocumentTableGUI\$optional_columns, and ILIAS\WebDAV\Mount\DocumentTableGUI\getColumnDefinition().

Referenced by ILIAS\WebDAV\Mount\DocumentTableGUI\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isColumnVisible()

ILIAS\WebDAV\Mount\DocumentTableGUI::isColumnVisible ( int $index )

protected

Definition at line 118 of file DocumentTableGUI.php.

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

References ilTable2GUI\$column, and ILIAS\WebDAV\Mount\DocumentTableGUI\getColumnDefinition().

Referenced by ILIAS\WebDAV\Mount\DocumentTableGUI\__construct(), and ILIAS\WebDAV\Mount\DocumentTableGUI\fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populate()

ILIAS\WebDAV\Mount\DocumentTableGUI::populate ( )

Definition at line 220 of file DocumentTableGUI.php.

                              : void
    {
        if ($this->getExternalSegmentation() && $this->getExternalSorting()) {
            $this->determineOffsetAndOrder();
        } elseif (!$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();
        $data = $this->getProvider()->getList();
 
        if (!count($data['items']) && $this->getOffset() > 0 && $this->getExternalSegmentation()) {
            $this->resetOffset();
            if ($this->getExternalSegmentation()) {
                $params['limit'] = $this->getLimit();
                $params['offset'] = $this->getOffset();
            }
            $data = $this->getProvider()->getList();
        }
 
        $this->preProcessData($data);
 
        $this->setData($data['items']);
        if ($this->getExternalSegmentation()) {
            $this->setMaxCount($data['cnt']);
        }
    }

References ilTableGUI\$data, $params, ilTable2GUI\determineOffsetAndOrder(), ilTable2GUI\determineSelectedFilters(), ilTable2GUI\getExternalSegmentation(), ilTable2GUI\getExternalSorting(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ILIAS\WebDAV\Mount\DocumentTableGUI\getProvider(), ILIAS\WebDAV\Mount\DocumentTableGUI\preProcessData(), ilTable2GUI\resetOffset(), ilTable2GUI\setData(), and ilTableGUI\setMaxCount().

Here is the call graph for this function:

◆ preProcessData()

ILIAS\WebDAV\Mount\DocumentTableGUI::preProcessData ( array & $data )

protected

Definition at line 258 of file DocumentTableGUI.php.

                                                   : void
    {
        foreach ($data['items'] as $key => $document) {
            $data['items'][$key] = [
                'id' => $document->getId(),
                'title' => $document->getTitle(),
                'creation_ts' => $document->getCreationTs(),
                'modification_ts' => $document->getModificationTs(),
                'raw_text' => $document->getUploadedInstructions(),
                'processed_text' => $document->getProcessedInstructions(),
                'language' => $document->getLanguage(),
            ];
        }
    }

References ilTableGUI\$data.

Referenced by ILIAS\WebDAV\Mount\DocumentTableGUI\populate().

Here is the caller graph for this function:

◆ setProvider()

ILIAS\WebDAV\Mount\DocumentTableGUI::setProvider ( TableDataProvider $provider )

Definition at line 92 of file DocumentTableGUI.php.

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

References ILIAS\WebDAV\Mount\DocumentTableGUI\$provider.

Field Documentation

◆ $factor

int ILIAS\WebDAV\Mount\DocumentTableGUI::$factor = 10

protected

Definition at line 34 of file DocumentTableGUI.php.

Referenced by ILIAS\WebDAV\Mount\DocumentTableGUI\formatSorting().

◆ $i

int ILIAS\WebDAV\Mount\DocumentTableGUI::$i = 1

protected

Definition at line 35 of file DocumentTableGUI.php.

Referenced by ILIAS\WebDAV\Mount\DocumentTableGUI\getColumnDefinition().

◆ $num_rendered_criteria

int ILIAS\WebDAV\Mount\DocumentTableGUI::$num_rendered_criteria = 0

protected

Definition at line 36 of file DocumentTableGUI.php.

◆ $optional_columns

array ILIAS\WebDAV\Mount\DocumentTableGUI::$optional_columns

protected

Definition at line 37 of file DocumentTableGUI.php.

Referenced by ILIAS\WebDAV\Mount\DocumentTableGUI\getSelectableColumns().

◆ $provider

TableDataProvider ILIAS\WebDAV\Mount\DocumentTableGUI::$provider = null

protected

Definition at line 43 of file DocumentTableGUI.php.

Referenced by ILIAS\WebDAV\Mount\DocumentTableGUI\getProvider(), and ILIAS\WebDAV\Mount\DocumentTableGUI\setProvider().

◆ $ui_components

array ILIAS\WebDAV\Mount\DocumentTableGUI::$ui_components = []

protected

Definition at line 41 of file DocumentTableGUI.php.

◆ $visible_optional_columns

array ILIAS\WebDAV\Mount\DocumentTableGUI::$visible_optional_columns

protected

Definition at line 38 of file DocumentTableGUI.php.

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

components/ILIAS/WebDAV/src/Mount/DocumentTableGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fillRow()

◆ formatActions()

◆ formatCellValue()

◆ formatSorting()

◆ formatTitle()

◆ getColumnDefinition()

◆ getHTML()

◆ getProvider()

◆ getSelectableColumns()

◆ isColumnVisible()

◆ populate()

◆ preProcessData()

◆ setProvider()

Field Documentation

◆ $factor

◆ $i

◆ $num_rendered_criteria

◆ $optional_columns

◆ $provider

◆ $ui_components

◆ $visible_optional_columns