Inheritance diagram for ilFileVersionsTableGUI:

Collaboration diagram for ilFileVersionsTableGUI:

Public Member Functions
	__construct (ilFileVersionsGUI $calling_gui_class, string $a_parent_cmd=ilFileVersionsGUI::CMD_DEFAULT)
	ilFileVersionsTableGUI constructor. More...

	getHTML ()
	Enables rendering modals OUTSIDE of the table. 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)

	getData ()

	dataExists ()

	setPrefix (string $a_prefix)

	getPrefix ()

	addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)

	addFilterItemByMetaType (string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
	Add filter by standard type. More...

	getFilterItems (bool $a_optionals=false)

	getFilterItemByPostVar (string $a_post_var)

	setFilterCols (int $a_val)

	getFilterCols ()

	setDisableFilterHiding (bool $a_val=true)

	getDisableFilterHiding ()

	isFilterSelected (string $a_col)
	Is given filter selected? More...

	getSelectedFilters ()

	determineSelectedFilters ()

	setCustomPreviousNext (string $a_prev_link, string $a_next_link)

	setFormAction (string $a_form_action, bool $a_multipart=false)

	getFormAction ()

	setFormName (string $a_name="")

	getFormName ()

	setId (string $a_val)

	getId ()

	setDisplayAsBlock (bool $a_val)

	getDisplayAsBlock ()

	setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)

	setExternalSorting (bool $a_val)

	getExternalSorting ()

	setFilterCommand (string $a_val, string $a_caption="")

	getFilterCommand ()

	setResetCommand (string $a_val, string $a_caption="")

	getResetCommand ()

	setExternalSegmentation (bool $a_val)

	getExternalSegmentation ()

	setRowTemplate (string $a_template, string $a_template_dir="")
	Set row template. More...

	setDefaultOrderField (string $a_defaultorderfield)

	getDefaultOrderField ()

	setDefaultOrderDirection (string $a_defaultorderdirection)

	getDefaultOrderDirection ()

	setDefaultFilterVisiblity (bool $a_status)

	getDefaultFilterVisibility ()

	clearCommandButtons ()

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

	addCommandButtonInstance (ilButtonBase $a_button)

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

	setCloseCommand (string $a_link)

	addMultiCommand (string $a_cmd, string $a_text)

	addHiddenInput (string $a_name, string $a_value)

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

	setTopCommands (bool $a_val)

	getTopCommands ()

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

	getNavParameter ()

	setOrderLink (string $key, string $order_dir)

	fillHeader ()

	determineOffsetAndOrder (bool $a_omit_offset=false)

	storeNavParameter ()

	getHTML ()
	Get HTML. More...

	numericOrdering (string $a_field)
	Should this field be sorted numeric? More...

	render ()

	writeFilterToSession ()

	resetFilter ()

	fillFooter ()

	getLinkbar (string $a_num)

	fillHiddenRow ()

	fillActionRow ()

	setHeaderHTML (string $html)

	storeProperty (string $type, string $value)

	loadProperty (string $type)

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

	setContext (string $id)

	getContext ()

	setShowRowsSelector (bool $a_value)
	Toggle rows-per-page selector. More...

	getShowRowsSelector ()

	getLimit ()

	getOffset ()

	setExportFormats (array $formats)
	Set available export formats. More...

	setPrintMode (bool $a_value=false)

	getPrintMode ()

	getExportMode ()

	exportData (int $format, bool $send=false)
	Export and optionally send current table data. More...

	setEnableAllCommand (bool $a_value)

	setRowSelectorLabel (string $row_selector_label)

	getRowSelectorLabel ()

	setPreventDoubleSubmission (bool $a_val)

	getPreventDoubleSubmission ()

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

Public Member Functions inherited from ilTableGUI
	__construct (array $a_data=[], bool $a_global_tpl=true)

	setTemplate (ilTemplate $a_tpl)

	getTemplateObject ()

	setData (array $a_data)
	Set table data. More...

	getData ()

	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")

	setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")

	setHeaderNames (array $a_header_names)

	getColumnCount ()

	setHeaderVars (array $a_header_vars, array $a_header_params=[])

	setColumnWidth (array $a_column_width)
	set table column widths More...

	setOneColumnWidth (string $a_column_width, int $a_column_number)

	setMaxCount (int $a_max_count)
	set max. More...

	setLimit (int $a_limit=0, int $a_default_limit=0)
	set max. More...

	getLimit ()

	setPrefix (string $a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...

	setOffset (int $a_offset)
	set dataset offset More...

	getOffset ()

	setOrderColumn (string $a_order_column="", string $a_default_column="")

	getOrderColumn ()

	setOrderDirection (string $a_order_direction)

	getOrderDirection ()

	setFooter (string $a_style, string $a_previous="", string $a_next="")

	enable (string $a_module_name)

	disable (string $a_module_name)

	sortData ()

	render ()

	renderHeader ()

	setOrderLink (string $key, string $order_dir)

	setStyle (string $a_element, string $a_style)

	getStyle (string $a_element)

	setBase (string $a_base)

	getBase ()

	getFormName ()
	get the name of the parent form More...

	setFormName (string $a_name="cmd")

	getSelectAllCheckbox ()
	get the name of the checkbox that should be toggled with a select all button More...

	setSelectAllCheckbox (string $a_select_all_checkbox)

	clearActionButtons ()

	addActionButton (string $btn_name, string $btn_value)

Protected Member Functions
	fillRow (array $a_set)

Protected Member Functions inherited from ilTable2GUI
	getRequestedValues ()

	prepareOutput ()
	Anything that must be done before HTML is generated. More...

	isFilterVisible ()
	Check if filter is visible: manually shown (session, db) or default value set. More...

	isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, ilTableFilterItem $a_element)
	Check if filter element is based on adv md. More...

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

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

	setFilterValue (ilTableFilterItem $a_item, $a_value)

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

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

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

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

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

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

Protected Attributes
UIServices	$ui

bool	$has_been_migrated = false

array	$modals = []

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

Private Member Functions
	initData ()

Private Attributes
Container	$dic

int	$current_version

ilObjFile	$file

Services	$irss

bool	$current_version_is_draft

int	$amount_of_versions

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

Class ilFileVersionsTableGUI.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

◆ __construct()

ilFileVersionsTableGUI::__construct	(	ilFileVersionsGUI	$calling_gui_class,
		string	$a_parent_cmd = `ilFileVersionsGUI::CMD_DEFAULT`
	)

ilFileVersionsTableGUI constructor.

Definition at line 49 of file class.ilFileVersionsTableGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ilFileVersionsGUI\CMD_DELETE_VERSIONS, ilFileVersionsGUI\CMD_ROLLBACK_VERSION, ilTableGUI\disable(), ILIAS\ResourceStorage\Revision\DRAFT, ilFileVersionsGUI\getFile(), initData(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setPrefix(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), ilTable2GUI\setTitle(), and ILIAS\Repository\ui().

       {
         global $DIC;
         $this->dic = $DIC;
         $this->ui = $DIC->ui();
         $this->irss = $DIC->resourceStorage();
         $this->setId(self::class);
         parent::__construct($calling_gui_class, $a_parent_cmd, "");
         $this->file = $calling_gui_class->getFile();
         $this->current_version = $this->file->getVersion(true);
         $rid = $this->irss->manage()->find(
             $this->file->getResourceId()
         );
         $revision = $this->irss->manage()->getCurrentRevisionIncludingDraft(
             $rid
         );
         $this->amount_of_versions = count(
             $this->irss->manage()->getResource($rid)->getAllRevisionsIncludingDraft()
         );
         $this->current_version_is_draft = $revision->getStatus() === RevisionStatus::DRAFT;
 
         // General
         $this->setPrefix("versions");
         $this->dic->language()->loadLanguageModule('file');
 
         // Appearance
         $this->setRowTemplate("tpl.file_version_row.html", "components/ILIAS/File");
         $this->setLimit(9999);
         $this->setEnableHeader(true);
         $this->disable("footer");
         $this->setTitle($this->dic->language()->txt("versions"));
 
         // Form
 
         $this->setFormAction($this->dic->ctrl()->getFormAction($calling_gui_class));
         $this->setSelectAllCheckbox("hist_id[]");
         //TODO: Use ilFileVersionsGUI::CMD_RENDER_DELETE_SELECTED_VERSIONS_MODAL instead of ilFileVersionsGUI::CMD_DELETE_VERSIONS as soon as new table gui is introduced.
         // ilFileVersionsGUI::CMD_DELETE_VERSIONS and its deprecated ilConfirmationGUI are only needed because the old ilTable2GUI doesn't support calling modals from its MultiCommands
         $this->addMultiCommand(ilFileVersionsGUI::CMD_DELETE_VERSIONS, $this->dic->language()->txt("delete"));
         $this->addMultiCommand(
             ilFileVersionsGUI::CMD_ROLLBACK_VERSION,
             $this->dic->language()->txt("file_rollback")
         );
 
         // Columns
         $this->addColumn("", "", "1", true);
         $this->addColumn($this->dic->language()->txt("version"), "", "auto");
         $this->addColumn($this->dic->language()->txt("filename"));
         $this->addColumn($this->dic->language()->txt("date"));
         $this->addColumn($this->dic->language()->txt("file_uploaded_by"));
         $this->addColumn($this->dic->language()->txt("versionname"));
         $this->addColumn($this->dic->language()->txt("filesize"), "", "", false);
         $this->addColumn($this->dic->language()->txt("status"));
         $this->addColumn($this->dic->language()->txt("action"));
         $this->addColumn("", "", "1");
 
         $this->initData();
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilFileVersionsTableGUI::fillRow ( array $a_set )

protected

Definition at line 123 of file class.ilFileVersionsTableGUI.php.

References ilTable2GUI\$buttons, $filename, $version, ilObjUser\_lookupName(), ilFileVersionsGUI\CMD_DOWNLOAD_VERSION, ilFileVersionsGUI\CMD_PUBLISH, ilFileVersionsGUI\CMD_RENDER_DELETE_SELECTED_VERSIONS_MODAL, ilFileVersionsGUI\CMD_ROLLBACK_VERSION, ilFileVersionsGUI\CMD_UNPUBLISH, ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ilFileVersionsGUI\HIST_ID, IL_CAL_DATETIME, ILIAS\Repository\lng(), null, and ILIAS\Repository\ui().

                                             : void
     {
         $action_entries = [];
         $hist_id = $a_set["hist_entry_id"];
 
         // split params
         $filename = $a_set["filename"];
         $version = $a_set["version"];
         $rollback_version = $a_set["rollback_version"];
         $rollback_user_id = $a_set["rollback_user_id"];
 
         // get user name
         $name = ilObjUser::_lookupName($a_set["user_id"]);
         $username = trim($name["title"] . " " . $name["firstname"] . " " . $name["lastname"]);
 
         // get file size
         $data_size = new DataSize(
             (int) ($a_set["size"] ?? 0),
             DataSize::KB
         );
         $filesize = (string) $data_size;
 
         // get action text
         $action = $this->dic->language()->txt(
             "file_version_" . $a_set["action"]
         ); // create, replace, new_version, rollback
         if ($a_set["action"] == "rollback") {
             $name = ilObjUser::_lookupName($rollback_user_id);
             $rollback_username = trim($name["title"] . " " . $name["firstname"] . " " . $name["lastname"]);
             $action = sprintf($action, $rollback_version, $rollback_username);
         }
 
         // get download link
         $this->dic->ctrl()->setParameter($this->parent_obj, ilFileVersionsGUI::HIST_ID, $hist_id);
         $link = $this->dic->ctrl()->getLinkTarget($this->parent_obj, ilFileVersionsGUI::CMD_DOWNLOAD_VERSION);
 
         // build actions
         $pseudo_modal = $this->ui->factory()->modal()->interruptive('', '', '')->withAsyncRenderUrl(
             $this->ctrl->getLinkTargetByClass(
                 ilFileVersionsGUI::class,
                 ilFileVersionsGUI::CMD_RENDER_DELETE_SELECTED_VERSIONS_MODAL,
                 null,
                 true
             )
         );
 
         $this->modals[] = $pseudo_modal;
         $buttons = $this->dic->ui()->factory()->button();
 
 
         if (!$this->current_version_is_draft) {
             $action_entries['delete'] = $buttons
                 ->shy(
                     $this->dic->language()->txt("delete"),
                     ''
                 )
                 ->withOnClick(
                     $pseudo_modal->getShowSignal()
                 );
 
 
             if ($this->current_version !== (int) $version) {
                 $action_entries['file_rollback'] = $buttons
                     ->shy(
                         $this->dic->language()->txt("file_rollback"),
                         $this->dic->ctrl()->getLinkTarget($this->parent_obj, ilFileVersionsGUI::CMD_ROLLBACK_VERSION)
                     );
             } elseif ($this->amount_of_versions > 1) {
                 $action_entries['unpublish'] = $buttons
                     ->shy(
                         $this->dic->language()->txt("file_unpublish"),
                         $this->dic->ctrl()->getLinkTarget($this->parent_obj, ilFileVersionsGUI::CMD_UNPUBLISH)
                     );
             }
         } elseif ($this->current_version === (int) $version) {
             $action_entries['publish'] = $buttons
                 ->shy(
                     $this->dic->language()->txt("file_publish"),
                     $this->dic->ctrl()->getLinkTarget($this->parent_obj, ilFileVersionsGUI::CMD_PUBLISH)
                 );
         }
 
 
         $actions = $this->dic->ui()->renderer()->render(
             $this->dic->ui()->factory()->dropdown()
                       ->standard($action_entries)
                       ->withLabel($this->lng->txt('actions'))
         );
 
         // reset history parameter
         $this->dic->ctrl()->setParameter($this->parent_obj, ilFileVersionsGUI::HIST_ID, "");
 
         // fill template
         $this->tpl->setVariable("TXT_VERSION", $version);
         $this->tpl->setVariable(
             "TXT_DATE",
             ilDatePresentation::formatDate(new ilDateTime($a_set['date'], IL_CAL_DATETIME))
         );
         $this->tpl->setVariable("TXT_UPLOADED_BY", $username);
         $this->tpl->setVariable("DL_LINK", $link);
         $this->tpl->setVariable("TXT_FILENAME", $filename);
         $this->tpl->setVariable("TXT_VERSIONNAME", $a_set['title']);
         $this->tpl->setVariable("TXT_FILESIZE", $data_size);
 
         // columns depending on confirmation
         $this->tpl->setCurrentBlock("version_selection");
         $this->tpl->setVariable("OBJ_ID", $hist_id);
         $this->tpl->parseCurrentBlock();
 
         $this->tpl->setCurrentBlock("version_txt_actions");
         $this->tpl->setVariable("TXT_ACTION", $action);
         $this->tpl->parseCurrentBlock();
 
         $this->tpl->setCurrentBlock("version_actions");
 
         $this->tpl->setVariable("ACTIONS", $actions);
 
         $this->tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ getHTML()

ilFileVersionsTableGUI::getHTML ( )

Enables rendering modals OUTSIDE of the table.

This is required because this table uses multi-actions, which will render the table inside a form. Since modals can contain forms as well, this would lead to invalid HTML markup.

Definition at line 250 of file class.ilFileVersionsTableGUI.php.

References ILIAS\Repository\ui().

                              : string
     {
         return parent::getHTML() . $this->ui->renderer()->render($this->modals);
     }

Here is the call graph for this function:

◆ initData()

ilFileVersionsTableGUI::initData ( )

private

Definition at line 110 of file class.ilFileVersionsTableGUI.php.

References $version, ilTable2GUI\setData(), and ilTableGUI\setMaxCount().

Referenced by __construct().

                                : void
     {
         $versions = [];
         foreach ($this->file->getVersions() as $version) {
             $versions[] = $version->getArrayCopy();
         }
         usort($versions, static fn(array $i1, array $i2): int => $i2['version'] - $i1['version']);
 
         $this->setData($versions);
         $this->setMaxCount(is_array($versions) ? count($versions) : 0);
     }