This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilPresentationListTableGUI:

Collaboration diagram for ilPresentationListTableGUI:

Public Member Functions
	__construct (object $a_parent_obj, string $a_parent_cmd, ilObjGlossary $a_glossary, bool $a_offline, int $a_tax_node, int $a_tax_id=0)

	initFilter ()

	numericOrdering (string $a_field)

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

	setShowTemplates (bool $a_value)

	getShowTemplates ()

	restoreTemplate (string $a_name)
	Restore state from template. More...

	saveTemplate (string $a_name)
	Save current state as template. More...

	deleteTemplate (string $a_name)

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

	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
ilAdvancedMDRecordGUI	$record_gui

array	$adv_fields

ILIAS Glossary Presentation PresentationGUIRequest	$request

int	$tax_id

int	$tax_node

ilObjGlossary	$glossary

array	$adv_cols_order = array()

bool	$offline

ilPageConfig	$page_config

array	$filter = []

Protected Attributes inherited from ilTable2GUI
string	$requested_tmpl_delete

string	$requested_tmpl_create

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_templates = false

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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Term list table for presentation mode

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

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

Constructor & Destructor Documentation

◆ __construct()

ilPresentationListTableGUI::__construct	(	object	$a_parent_obj,
		string	$a_parent_cmd,
		ilObjGlossary	$a_glossary,
		bool	$a_offline,
		int	$a_tax_node,
		int	$a_tax_id = `0`
	)

Definition at line 38 of file class.ilPresentationListTableGUI.php.

References Vendor\Package\$c, $DIC, $tax_node, ILIAS\MetaData\Repository\Validation\Data\__construct(), ilTable2GUI\addColumn(), ILIAS\Repository\ctrl(), ilTableGUI\disable(), ILIAS\Repository\filter(), ilGlossaryAdvMetaDataAdapter\getAllFields(), ilGlossaryAdvMetaDataAdapter\getColumnOrder(), ilTable2GUI\getData(), initFilter(), ILIAS\Repository\lng(), ilAdvancedMDRecordGUI\MODE_FILTER, ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setShowRowsSelector(), and ilAdvancedMDRecordGUI\setTableGUI().

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->ctrl = $DIC->ctrl();
 
         $this->glossary = $a_glossary;
         $this->offline = $a_offline;
         $this->tax_node = $a_tax_node;
         $this->tax_id = $a_tax_id;
         $this->setId("glopr" . $this->glossary->getId());
         $this->request = $DIC->glossary()
             ->internal()
             ->gui()
             ->presentation()
             ->request();
 
         $gdf = new ilGlossaryDefPage();
         $this->page_config = $gdf->getPageConfig();
 
         $adv_ad = new ilGlossaryAdvMetaDataAdapter($this->glossary->getRefId());
         $this->adv_fields = $adv_ad->getAllFields();
 
 
         parent::__construct($a_parent_obj, $a_parent_cmd);
         //$this->setTitle($this->lng->txt("cont_terms"));
 
         $adv_ap = new ilGlossaryAdvMetaDataAdapter($this->glossary->getRefId());
         $this->adv_cols_order = $adv_ap->getColumnOrder();
         foreach ($this->adv_cols_order as $c) {
             if ($c["id"] == 0) {
                 $this->addColumn($this->lng->txt("cont_term"), "term");
             } else {
                 $this->addColumn($c["text"], "md_" . $c["id"]);
             }
         }
 
 
         $this->addColumn($this->lng->txt("cont_definitions"));
         if ($this->glossary->isVirtual()) {
             $this->addColumn($this->lng->txt("obj_glo"));
         }
 
         $this->setEnableHeader(true);
         if (!$this->offline) {
             $this->setFormAction($this->ctrl->getFormAction($this->parent_obj));
         } else {
             $this->disable("footer");
         }
         $this->setRowTemplate("tpl.term_tbl_pres_row.html", "Modules/Glossary");
         $this->setEnableTitle(true);
 
         if (!$this->offline) {
             $this->initFilter();
             $this->setFilterCommand("applyFilter");
 
             $this->setShowRowsSelector(true);
         }
 
         // advanced metadata
         $this->record_gui = new ilAdvancedMDRecordGUI(
             ilAdvancedMDRecordGUI::MODE_FILTER,
             'glo',
             $this->glossary->getId(),
             'term'
         );
         $this->record_gui->setTableGUI($this);
         $this->record_gui->parse();
         //$this->setDefaultOrderField("login");
         //$this->setDefaultOrderDirection("asc");
         $this->setData($this->glossary->getTermList(
             $this->filter["term"] ?? "",
             $this->request->getLetter(),
             $this->filter["definition"] ?? "",
             $this->tax_node,
             false,
             true,
             $this->record_gui->getFilterElements(),
             false,
             true
         ));
         if ($this->offline) {
             $this->setLimit(count($this->getData()));
             $this->resetOffset();
         }
         //              $this->setData(array());
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilPresentationListTableGUI::fillRow ( array $a_set )

protected

Definition at line 172 of file class.ilPresentationListTableGUI.php.

References Vendor\Package\$c, ilTable2GUI\$id, ilGlossaryTerm\_lookShortText(), ilGlossaryTerm\_lookShortTextDirty(), ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), ilMathJax\getInstance(), ilStr\shortenTextExtended(), and ilPCParagraph\xml2output().

                                             : void
     {
         $term_id = $a_set["id"];
         $this->ctrl->setParameter($this->parent_obj, "term_id", $term_id);
 
         // check dirty short texts
         $this->tpl->setCurrentBlock("definition");
         if (ilGlossaryTerm::_lookShortTextDirty($term_id)) {
             // #18022
             $term_obj = new ilGlossaryTerm($term_id);
             $term_obj->updateShortText();
             $short_str = $term_obj->getShortText();
         } else {
             $short_str = ilGlossaryTerm::_lookShortText($term_id);
         }
 
         if (!$this->page_config->getPreventHTMLUnmasking()) {
             $short_str = str_replace(["&lt;", "&gt;"], ["<", ">"], $short_str);
         }
 
         // replace tex
         // if a tex end tag is missing a tex end tag
         $ltexs = strrpos($short_str, "[tex]");
         $ltexe = strrpos($short_str, "[/tex]");
         if ($ltexs > $ltexe) {
             $page = new ilGlossaryDefPage($term_id);
             $page->buildDom();
             $short_str = $page->getFirstParagraphText();
             $short_str = strip_tags($short_str, "<br>");
             $ltexe = strpos($short_str, "[/tex]", $ltexs);
             $short_str = ilStr::shortenTextExtended($short_str, $ltexe + 6, true);
         }
 
         if (!$this->offline) {
             $short_str = ilMathJax::getInstance()->insertLatexImages($short_str);
         } else {
             $short_str = ilMathJax::getInstance()->insertLatexImages(
                 $short_str,
                 '[tex]',
                 '[/tex]'
             );
         }
 
         $short_str = ilPCParagraph::xml2output($short_str, false, true, false);
 
         $this->tpl->setVariable("DEF_SHORT", $short_str);
         $this->tpl->parseCurrentBlock();
 
         $this->tpl->setCurrentBlock("definition_row");
         $this->tpl->parseCurrentBlock();
 
         // display additional column 'glossary' for meta glossaries
         if ($this->glossary->isVirtual()) {
             $this->tpl->setCurrentBlock("glossary_row");
             $glo_title = ilObject::_lookupTitle($a_set["glo_id"]);
             $this->tpl->setVariable("GLO_TITLE", $glo_title);
             $this->tpl->parseCurrentBlock();
         }
 
         $this->ctrl->clearParameters($this->parent_obj);
 
         // advanced metadata
         foreach ($this->adv_cols_order as $c) {
             if ($c["id"] == 0) {
                 $this->tpl->setCurrentBlock("link_start");
                 if (!$this->offline) {
                     $this->ctrl->setParameter($this->parent_obj, "term_id", $term_id);
                     $this->tpl->setVariable(
                         "LINK_VIEW_TERM",
                         $this->ctrl->getLinkTarget($this->parent_obj, "listDefinitions")
                     );
 
                     $this->ctrl->clearParameters($this->parent_obj);
                 } else {
                     $this->tpl->setVariable("LINK_VIEW_TERM", "term_" . $term_id . ".html");
                 }
                 $this->tpl->parseCurrentBlock();
 
                 $this->tpl->setCurrentBlock("link_end");
                 $this->tpl->setVariable("ANCHOR_TERM", "term_" . $term_id);
                 $this->tpl->parseCurrentBlock();
 
                 $this->tpl->setCurrentBlock("td");
                 $this->tpl->setVariable("TEXT", $a_set["term"]);
             } else {
                 $id = $c["id"];
 
                 $val = " ";
                 if (isset($a_set["md_" . $id . "_presentation"])) {
                     $pb = $a_set["md_" . $id . "_presentation"]->getList();
                     if ($pb) {
                         $val = $pb;
                     }
                 }
 
                 $this->tpl->setCurrentBlock("td");
                 $this->tpl->setVariable("TEXT", $val);
             }
             $this->tpl->parseCurrentBlock();
         }
     }

Here is the call graph for this function:

◆ getAdvMDRecordGUI()

ilPresentationListTableGUI::getAdvMDRecordGUI ( )

protected

Definition at line 133 of file class.ilPresentationListTableGUI.php.

References $record_gui.

                                           : ilAdvancedMDRecordGUI
     {
         return $this->record_gui;
     }

◆ initFilter()

ilPresentationListTableGUI::initFilter ( )

Definition at line 138 of file class.ilPresentationListTableGUI.php.

References ilTable2GUI\addFilterItem(), ILIAS\Repository\filter(), and ILIAS\Repository\lng().

Referenced by __construct().

                                 : void
     {
         // term
         $ti = new ilTextInputGUI($this->lng->txt("cont_term"), "term");
         $ti->setMaxLength(64);
         $ti->setSize(20);
         $ti->setSubmitFormOnEnter(true);
         $this->addFilterItem($ti);
         $ti->readFromSession();
         $this->filter["term"] = $ti->getValue();
 
         // definition
         if ($this->glossary->supportsLongTextQuery()) {
             $ti = new ilTextInputGUI($this->lng->txt("cont_definition"), "defintion");
             $ti->setMaxLength(64);
             $ti->setSize(20);
             $ti->setSubmitFormOnEnter(true);
             $this->addFilterItem($ti);
             $ti->readFromSession();
             $this->filter["definition"] = $ti->getValue();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ numericOrdering()

ilPresentationListTableGUI::numericOrdering ( string $a_field )

Definition at line 161 of file class.ilPresentationListTableGUI.php.

References ILIAS\Repository\int(), and ilAdvancedMDFieldDefinition\TYPE_DATE.

                                                     : bool
     {
         if (strpos($a_field, "md_") === 0) {
             $md_id = (int) substr($a_field, 3);
             if ($this->adv_fields[$md_id]["type"] == ilAdvancedMDFieldDefinition::TYPE_DATE) {
                 return true;
             }
         }
         return false;
     }