TableGUI class for characteristics. More...

Inheritance diagram for ILIAS\Style\Content\CharacteristicTableGUI:

Collaboration diagram for ILIAS\Style\Content\CharacteristicTableGUI:

Public Member Functions
	__construct (InternalGUIService $gui_service, object $a_parent_obj, string $a_parent_cmd, string $a_super_type, ilObjStyleSheet $a_style, Style\Content\CharacteristicManager $manager, Access\StyleAccessManager $access_manager)

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

	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
Style Content CharacteristicManager	$manager

Access StyleAccessManager	$access_manager

ilObjStyleSheet	$style

string	$super_type

bool	$hideable

int	$order_cnt = 0

bool	$expandable = false

InternalGUIService	$gui_service

array	$core_styles = []

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

TableGUI class for characteristics.

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

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

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Style\Content\CharacteristicTableGUI::__construct	(	InternalGUIService	$gui_service,
		object	$a_parent_obj,
		string	$a_parent_cmd,
		string	$a_super_type,
		ilObjStyleSheet	$a_style,
		Style\Content\CharacteristicManager	$manager,
		Access\StyleAccessManager	$access_manager
	)

Definition at line 46 of file class.CharacteristicTableGUI.php.

References ILIAS\Style\Content\CharacteristicTableGUI\$access_manager, ilTable2GUI\$ctrl, ILIAS\Style\Content\CharacteristicTableGUI\$gui_service, ILIAS\Style\Content\CharacteristicTableGUI\$manager, ILIAS\Style\Content\CharacteristicTableGUI\$super_type, $txt, ILIAS\GlobalScreen\Provider\__construct(), ilObjStyleSheet\_getCoreStyles(), ilObjStyleSheet\_getStyleSuperTypes(), ilObjStyleSheet\_isExpandable(), ilObjStyleSheet\_isHideable(), ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), ilTableGUI\disable(), ILIAS\UI\examples\Tree\Expandable\expandable(), ilCtrl\getFormAction(), ILIAS\Style\Content\CharacteristicTableGUI\getItems(), ILIAS\Repository\lng(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFormAction(), ilTable2GUI\setLimit(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setTitle().

       {
         $this->gui_service = $gui_service;
         $this->manager = $manager;
         $this->access_manager = $access_manager;
         $this->super_type = $a_super_type;
         $this->style = $a_style;
 
         $ctrl = $this->gui_service->ctrl();
 
         parent::__construct($a_parent_obj, $a_parent_cmd);
         $this->setExternalSorting(true);
         $this->core_styles = ilObjStyleSheet::_getCoreStyles();
         $this->getItems();
         $this->setTitle($this->lng->txt("sty_" . $a_super_type . "_char"));
         $this->setLimit(9999);
 
         // check, whether any of the types is expandable
         $this->expandable = false;
         $this->hideable = false;
         $all_super_types = ilObjStyleSheet::_getStyleSuperTypes();
         $types = $all_super_types[$this->super_type];
         foreach ($types as $t) {
             if (ilObjStyleSheet::_isExpandable($t)) {
                 $this->expandable = true;
             }
             if (ilObjStyleSheet::_isHideable($t)) {
                 $this->hideable = true;
             }
         }
 
         $this->addColumn("", "", "1");  // checkbox
         if ($this->expandable) {
             $this->addColumn($this->lng->txt("sty_order"));
         }
         $this->addColumn($this->lng->txt("sty_class_name"));
         $this->addColumn($this->lng->txt("title"));
         $this->addColumn($this->lng->txt("sty_type"));
         $this->addColumn($this->lng->txt("sty_example"));
         if ($this->hideable) {
             $this->addColumn($this->lng->txt("sty_hide"));      // hide checkbox
         }
         $this->addColumn($this->lng->txt("sty_outdated"));
         $this->addColumn($this->lng->txt("actions"));
         $this->setEnableHeader(true);
         $this->setFormAction($ctrl->getFormAction($a_parent_obj));
         $this->setRowTemplate("tpl.style_row.html", "components/ILIAS/Style/Content/Characteristic");
         $this->disable("footer");
 
         if ($this->access_manager->checkWrite()) {
             // action commands
             if ($this->hideable || $this->expandable) {
                 $txt = $this->lng->txt("sty_save_hide_status");
                 if ($this->hideable && $this->expandable) {
                     $txt = $this->lng->txt("sty_save_hide_order_status");
                 } elseif (!$this->hideable) {
                     $txt = $this->lng->txt("sty_save_order_status");
                 }
 
                 $this->addCommandButton("saveStatus", $txt);
             }
 
             $this->addMultiCommand("copyCharacteristics", $this->lng->txt("copy"));
             $this->addMultiCommand("setOutdated", $this->lng->txt("sty_set_outdated"));
             $this->addMultiCommand("removeOutdated", $this->lng->txt("sty_remove_outdated"));
 
             // action commands
             if ($this->expandable) {
                 $this->addMultiCommand("deleteCharacteristicConfirmation", $this->lng->txt("delete"));
             }
         }
 
         $this->setEnableTitle(true);
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ILIAS\Style\Content\CharacteristicTableGUI::fillRow ( array $a_set )

protected

Definition at line 139 of file class.CharacteristicTableGUI.php.

References ilTableGUI\$lng, ilTable2GUI\$ui, ilObjStyleSheet\_determineTag(), ilObjStyleSheet\_isHideable(), ILIAS\UI\examples\Tree\Expandable\expandable(), ilObjStyleSheetGUI\getStyleExampleHTML(), ilObjStyleSheet\isCoreStyle(), ILIAS\Repository\lng(), and ilLanguage\txt().

                                             : void
     {
         $lng = $this->lng;
         $ilCtrl = $this->gui_service->ctrl();
         $ui = $this->gui_service->ui();
 
         $char = $a_set["obj"];
 
         if ($this->expandable) {
             $this->order_cnt = $this->order_cnt + 10;
             $this->tpl->setCurrentBlock("order");
             $this->tpl->setVariable("OCHAR", $char->getType() . "." .
                 ilObjStyleSheet::_determineTag($char->getType()) .
                 "." . $char->getCharacteristic());
             $this->tpl->setVariable("ORDER", $this->order_cnt);
             $this->tpl->parseCurrentBlock();
         }
 
 
         $this->tpl->setCurrentBlock("checkbox");
         $this->tpl->setVariable("CHAR", $char->getType() . "." .
             ilObjStyleSheet::_determineTag($char->getType()) .
                     "." . $char->getCharacteristic());
         $this->tpl->parseCurrentBlock();
 
         if ($this->hideable) {
             if (!ilObjStyleSheet::_isHideable($char->getType()) ||
                 (!empty($this->core_styles[$char->getType() . "." .
                 ilObjStyleSheet::_determineTag($char->getType()) .
                 "." . $char->getCharacteristic()]))) {
                 $this->tpl->touchBlock("no_hide_checkbox");
             } else {
                 $this->tpl->setCurrentBlock("hide_checkbox");
                 $this->tpl->setVariable("CHAR", $char->getType() . "." .
                     ilObjStyleSheet::_determineTag($char->getType()) .
                     "." . $char->getCharacteristic());
                 if ($this->style->getHideStatus($char->getType(), $char->getCharacteristic())) {
                     $this->tpl->setVariable("CHECKED", "checked='checked'");
                 }
                 $this->tpl->parseCurrentBlock();
             }
         }
 
         // example
         $this->tpl->setVariable(
             "EXAMPLE",
             ilObjStyleSheetGUI::getStyleExampleHTML($char->getType(), $char->getCharacteristic())
         );
         $tag_str = ilObjStyleSheet::_determineTag($char->getType()) . "." . $char->getCharacteristic();
         $this->tpl->setVariable("TXT_TAG", $char->getCharacteristic());
         $this->tpl->setVariable("TXT_TYPE", $lng->txt("sty_type_" . $char->getType()));
 
         $this->tpl->setVariable("TITLE", $this->manager->getPresentationTitle(
             $char->getType(),
             $char->getCharacteristic(),
             false
         ));
 
         if ($this->access_manager->checkWrite()) {
             $ilCtrl->setParameter($this->parent_obj, "tag", $tag_str);
             $ilCtrl->setParameter($this->parent_obj, "style_type", $char->getType());
             $ilCtrl->setParameter($this->parent_obj, "char", $char->getCharacteristic());
 
             $links = [];
             $links[] = $ui->factory()->link()->standard(
                 $this->lng->txt("edit"),
                 $ilCtrl->getLinkTargetByClass("ilStyleCharacteristicGUI", "editTagStyle")
             );
 
             if (!ilObjStyleSheet::isCoreStyle($char->getType(), $char->getCharacteristic())) {
                 if ($char->isOutdated()) {
                     $this->tpl->setVariable("OUTDATED", $lng->txt("yes"));
                     $links[] = $ui->factory()->link()->standard(
                         $this->lng->txt("sty_remove_outdated"),
                         $ilCtrl->getLinkTargetByClass("ilStyleCharacteristicGUI", "removeOutdated")
                     );
                 } else {
                     $this->tpl->setVariable("OUTDATED", $lng->txt("no"));
                     $links[] = $ui->factory()->link()->standard(
                         $this->lng->txt("sty_set_outdated"),
                         $ilCtrl->getLinkTargetByClass("ilStyleCharacteristicGUI", "setOutdated")
                     );
                 }
             }
 
             $dd = $ui->factory()->dropdown()->standard($links);
 
             $this->tpl->setVariable(
                 "ACTIONS",
                 $ui->renderer()->render($dd)
             );
         }
     }

Here is the call graph for this function:

◆ getItems()

ILIAS\Style\Content\CharacteristicTableGUI::getItems ( )

protected

Definition at line 128 of file class.CharacteristicTableGUI.php.

References ilTableGUI\$data, and ilTable2GUI\setData().

Referenced by ILIAS\Style\Content\CharacteristicTableGUI\__construct().

                                  : void
     {
         $data = [];
         foreach ($this->manager->getBySuperType($this->super_type) as $char) {
             $data[] = [
                 "obj" => $char
             ];
         }
         $this->setData($data);
     }