Description of ilDidacticTemplateSettingsTableGUI. More...

Inheritance diagram for ilDidacticTemplateSettingsTableGUI:

Collaboration diagram for ilDidacticTemplateSettingsTableGUI:

Public Member Functions
	__construct (object $a_parent_obj, string $a_parent_cmd, int $ref_id)

	init ()
	Init table. More...

	parse (ilDidacticTemplateSettingsTableFilter $filter)
	Parse didactic templates. 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 ()

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

Private Attributes
	$ref_id

ilAccessHandler	$access

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

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

Detailed Description

Description of ilDidacticTemplateSettingsTableGUI.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 11 of file class.ilDidacticTemplateSettingsTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilDidacticTemplateSettingsTableGUI::__construct	(	object	$a_parent_obj,
		string	$a_parent_cmd,
		int	$ref_id
	)

Definition at line 17 of file class.ilDidacticTemplateSettingsTableGUI.php.

References $DIC, $ref_id, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), and ilTable2GUI\setId().

     {
         global $DIC;
         $this->ref_id = $ref_id;
         parent::__construct($a_parent_obj, $a_parent_cmd);
         $this->setId('tbl_didactic_tpl_settings');
 
         $this->access = $DIC->access();
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilDidacticTemplateSettingsTableGUI::fillRow ( array $a_set )

protected

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

References $ref_id, ilLink\_getLink(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilUtil\getImagePath(), ilTable2GUI\getParentObject(), and ILIAS\Repository\lng().

                                             : void
     {
         if ($this->access->checkAccess('write', '', $this->ref_id)) {
             $this->tpl->setVariable('VAL_ID', $a_set['id']);
         }
 
         $this->tpl->setVariable('VAL_TITLE', $a_set['title']);
         $this->tpl->setVariable('VAL_DESC', $a_set['description']);
 
         if (($a_set['icon'] ?? '') !== '') {
             $this->tpl->setVariable('ICON_SRC', $a_set['icon']);
             foreach ((array) $a_set['assignments'] as $obj_type) {
                 $this->tpl->setVariable('ICON_ALT', $this->lng->txt('objs_' . $obj_type));
             }
         }
 
         foreach ((array) explode("\n", $a_set['info']) as $info) {
             $trimmed_info = trim($info);
             if ($trimmed_info) {
                 $this->tpl->setCurrentBlock('info');
                 $this->tpl->setVariable('VAL_INFO', $trimmed_info);
                 $this->tpl->parseCurrentBlock();
             }
         }
 
         if ($a_set['automatic_generated']) {
             $this->tpl->setVariable("VAL_AUTOMATIC_GENERATED", $this->lng->txt("didactic_auto_generated"));
         }
 
         $this->tpl->setVariable(
             'VAL_IMAGE',
             $a_set['enabled'] ?
                 ilUtil::getImagePath('icon_ok.svg') :
                 ilUtil::getImagePath('icon_not_ok.svg')
         );
         $this->tpl->setVariable(
             'VAL_ENABLED_TXT',
             $a_set['enabled'] ?
                 $this->lng->txt('active') :
                 $this->lng->txt('inactive')
         );
 
         $atxt = '';
         foreach ((array) $a_set['assignments'] as $obj_type) {
             $atxt .= ($this->lng->txt('objs_' . $obj_type) . '<br/>');
         }
         $this->tpl->setVariable('VAL_APPLICABLE', $atxt);
 
         $this->ctrl->setParameterByClass(
             get_class($this->getParentObject()),
             'tplid',
             $a_set['id']
         );
 
         if (count($a_set['scope'])) {
             $this->tpl->setCurrentBlock('scope_txt');
             $this->tpl->setVariable('LOCAL_OR_GLOBAL', $this->lng->txt('didactic_scope_list_header'));
             $this->tpl->parseCurrentBlock();
 
             foreach ($a_set['scope'] as $ref_id) {
                 $this->tpl->setCurrentBlock('scope_entry');
                 $this->tpl->setVariable('LINK_HREF', ilLink::_getLink($ref_id));
                 $this->tpl->setVariable('LINK_NAME', ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id)));
                 $this->tpl->parseCurrentBlock();
             }
         } else {
             $this->tpl->setCurrentBlock('scope_txt');
             $this->tpl->setVariable(
                 'LOCAL_OR_GLOBAL',
                 isset($a_set['local']) ? $this->lng->txt('meta_local') : $this->lng->txt('meta_global')
             );
             $this->tpl->parseCurrentBlock();
         }
 
         if ($this->access->checkAccess('write', '', $this->ref_id)) {
             $actions = new ilAdvancedSelectionListGUI();
             $actions->setId((string) $a_set['id']);
             $actions->setListTitle($this->lng->txt("actions"));
             // Edit
             $actions->addItem(
                 $this->lng->txt('settings'),
                 '',
                 $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'editTemplate')
             );
 
             // Copy
             $actions->addItem(
                 $this->lng->txt('copy'),
                 '',
                 $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'copyTemplate')
             );
 
             // Export
             if (!$a_set['automatic_generated']) {
                 $actions->addItem(
                     $this->lng->txt('didactic_do_export'),
                     '',
                     $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'exportTemplate')
                 );
             }
             $this->tpl->setVariable('ACTION_DROPDOWN', $actions->getHTML());
         } elseif (!$a_set['automatic_generated']) {
             //don't use dropdown if just one item is given ...
             // Export
             $this->tpl->setCurrentBlock('action_link');
             $this->tpl->setVariable(
                 'A_LINK',
                 $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'exportTemplate')
             );
             $this->tpl->setVariable('A_TEXT', $this->lng->txt('didactic_do_export'));
             $this->tpl->parseCurrentBlock();
         } else {
             $this->tpl->touchBlock('action_link');
         }
     }

Here is the call graph for this function:

◆ init()

ilDidacticTemplateSettingsTableGUI::init ( )

Init table.

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

References ILIAS\Repository\access(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setFormAction(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setTitle().

                           : void
     {
         $this->addColumn('', 'f', '1px');
         $this->lng->loadLanguageModule('search');
         $this->lng->loadLanguageModule('meta');
         $this->addColumn($this->lng->txt('icon'), '', '5%');
         $this->addColumn($this->lng->txt('search_title_description'), 'title', '30%');
         $this->addColumn($this->lng->txt('didactic_applicable_for'), 'applicable', '20%');
         $this->addColumn($this->lng->txt('didactic_scope'), 'scope', '20%');
         $this->addColumn($this->lng->txt('active'), 'active', '10%');
         $this->addColumn($this->lng->txt('actions'), '', '15%');
 
         $this->setTitle($this->lng->txt('didactic_available_templates'));
 
         if ($this->access->checkAccess('write', '', $this->ref_id)) {
             $this->addMultiCommand('activateTemplates', $this->lng->txt('activate'));
             $this->addMultiCommand('deactivateTemplates', $this->lng->txt('deactivate'));
             $this->addMultiCommand('confirmDelete', $this->lng->txt('delete'));
 
             $this->setSelectAllCheckbox('tpls');
         }
         $this->setRowTemplate('tpl.didactic_template_overview_row.html', 'Services/DidacticTemplate');
         $this->setDefaultOrderField('title');
         $this->setDefaultOrderDirection('asc');
         $this->setFormAction($this->ctrl->getFormAction($this->getParentObject()));
     }

Here is the call graph for this function:

◆ parse()

ilDidacticTemplateSettingsTableGUI::parse ( ilDidacticTemplateSettingsTableFilter $filter )

Parse didactic templates.

Definition at line 60 of file class.ilDidacticTemplateSettingsTableGUI.php.

References ilTableGUI\$data, ilTableGUI\$tpl, ilDidacticTemplateSettingsTableFilter\filter(), ilDidacticTemplateSettings\getInstance(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and ilTable2GUI\setData().

                                                                         : void
     {
         $tpls = ilDidacticTemplateSettings::getInstance();
         $tpls->readInactive();
         $templates = $filter->filter($tpls->getTemplates());
 
         $counter = 0;
         $data = [];
         foreach ($templates as $tpl) {
             /* @var $tpl ilDidacticTemplateSetting */
             $data[$counter]['id'] = $tpl->getId();
             $data[$counter]['icon'] = $tpl->getIconHandler()->getAbsolutePath();
             $data[$counter]['title'] = $tpl->getPresentationTitle();
             $data[$counter]['description'] = $tpl->getPresentationDescription();
             $data[$counter]['info'] = $tpl->getInfo();
             $data[$counter]['enabled'] = (int) $tpl->isEnabled();
             $data[$counter]['assignments'] = $tpl->getAssignments();
 
             $atxt = '';
             foreach ($tpl->getAssignments() as $obj_type) {
                 $atxt .= ($this->lng->txt('objs_' . $obj_type) . '<br/>');
             }
             $data[$counter]['applicable'] = $atxt;
             $data[$counter]['automatic_generated'] = $tpl->isAutoGenerated();
             $data[$counter]['scope'] = (array) $tpl->getEffectiveFrom();
 
             ++$counter;
         }
 
         $this->setData($data);
     }