ilCourseReferenceDeleteConfirmationTableGUI Class Reference

Class ilCourseReferencePathInfo. More...

Inheritance diagram for ilCourseReferenceDeleteConfirmationTableGUI:

Collaboration diagram for ilCourseReferenceDeleteConfirmationTableGUI:

Public Member Functions
	__construct ($gui, $member_obj, string $cmd)
	ilCourseReferenceDeleteConfirmationTableGUI constructor. More...
	setParticipants (array $participants)
	init ()
	Init table. More...
	parse ()
	Parse table content. More...
	fillRow (array $a_set)
	Standard Version of Fill Row.Most likely to be overwritten by derived class. Parameters array $a_set data array 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 ()
	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)
	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
	readLinkedCourseAssignments ($part_id)
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
	$tree = null
	$member_obj = null
	$participants = []

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

Class ilCourseReferencePathInfo.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 10 of file class.ilCourseReferenceDeleteConfirmationTableGUI.php.

Constructor & Destructor Documentation

__construct()

ilCourseReferenceDeleteConfirmationTableGUI::__construct	(		$gui,
			$member_obj,
		string	$cmd
	)

ilCourseReferenceDeleteConfirmationTableGUI constructor.

Parameters

object	$gui
object	$member_obj
string	$cmd

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

    {
        global $DIC;
 
        $this->tree = $DIC->repositoryTree();
 
        $this->setId('crsr_mem_confirmation');
        parent::__construct($gui, $cmd);
 
        $this->member_obj = $member_obj;
    }

References $DIC, $member_obj, ILIAS\GlobalScreen\Provider\__construct(), and ilTable2GUI\setId().

Here is the call graph for this function:

Member Function Documentation

fillRow()

ilCourseReferenceDeleteConfirmationTableGUI::fillRow

(

array

$a_set

)

Standard Version of Fill Row.Most likely to be overwritten by derived class.

Parameters

array

$a_set

data array

Reimplemented from ilTable2GUI.

Definition at line 95 of file class.ilCourseReferenceDeleteConfirmationTableGUI.php.

                                         : void
    {
        $this->tpl->setVariable('HIDDEN_NAME', $a_set['id']);
        $this->tpl->setVariable('TYPE_ICON', ilUtil::getImagePath('icon_usr.svg'));
        $this->tpl->setVariable('ALT_USR', $this->lng->txt('obj_usr'));
        $this->tpl->setVariable('VAL_LOGIN', $a_set['title']);
 
        $linked_course_assignments = $this->readLinkedCourseAssignments($a_set['id']);
        foreach ($linked_course_assignments as $course_ref_id) {
            $path = new ilPathGUI();
            $path->enableHideLeaf(false);
            $path->enableTextOnly(false);
            $this->tpl->setCurrentBlock('reference_path');
            $this->tpl->setVariable('CHECK_USER_NAME', 'refs[' . $a_set['id'] . '][' . $course_ref_id . ']');
            $this->tpl->setVariable('CHECK_USER_VAL', 1);
            $this->tpl->setVariable('REF_PATH', $path->getPath(ROOT_FOLDER_ID, (int) $course_ref_id));
            $this->tpl->parseCurrentBlock();
        }
 
 
        if (count($linked_course_assignments)) {
            $this->tpl->setCurrentBlock('reference_select');
            $this->tpl->setVariable('RUID', $a_set['id']);
            $this->tpl->setVariable('RFORM_ID', $this->formname);
            $this->tpl->setVariable('SEL_ALL', $this->lng->txt('select_all'));
            $this->tpl->parseCurrentBlock();
        }
    }

References $path, ilUtil\getImagePath(), ILIAS\Repository\lng(), readLinkedCourseAssignments(), and ROOT_FOLDER_ID.

Here is the call graph for this function:

init()

ilCourseReferenceDeleteConfirmationTableGUI::init

(

)

Init table.

Definition at line 57 of file class.ilCourseReferenceDeleteConfirmationTableGUI.php.

    {
        $this->setRowTemplate('tpl.crsr_mem_deletion_confirmation_row.html', 'Modules/CourseReference');
        $this->addCommandButton('deleteParticipantsWithLinkedCourses', $this->lng->txt('confirm'));
        $this->addCommandButton('participants', $this->lng->txt('cancel'));
        $this->setFormAction($this->ctrl->getFormAction($this->getParentObject()));
 
        $this->disable('sort');
        $this->setShowRowsSelector(false);
        $this->setSelectAllCheckbox('refs');
 
        $this->addColumn($this->lng->txt('type'), 'type', '50px');
        $this->addColumn($this->lng->txt('title'), 'title');
    }

References ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ILIAS\Repository\ctrl(), ilTableGUI\disable(), ILIAS\Repository\lng(), ilTable2GUI\setFormAction(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setShowRowsSelector().

Here is the call graph for this function:

parse()

ilCourseReferenceDeleteConfirmationTableGUI::parse

(

)

Parse table content.

Definition at line 75 of file class.ilCourseReferenceDeleteConfirmationTableGUI.php.

    {
        $rows = [];
        foreach ($this->participants as $part_id) {
            $row = [];
            $row['type'] = 'usr';
            $row['id'] = $part_id;
 
            $name = ilObjUser::_lookupName($part_id);
 
            $row['title'] = ($name['lastname'] . ', ' . $name['firstname'] . ' [' . $name['login'] . ']');
            $rows[] = $row;
        }
 
        $this->setData($rows);
    }

References $name, $rows, ilObjUser\_lookupName(), and ilTable2GUI\setData().

Here is the call graph for this function:

readLinkedCourseAssignments()

ilCourseReferenceDeleteConfirmationTableGUI::readLinkedCourseAssignments (   $part_id )

protected

Parameters

$part_id

Definition at line 127 of file class.ilCourseReferenceDeleteConfirmationTableGUI.php.

                                                            : array
    {
        $childs = $this->tree->getChildsByType($this->member_obj->getRefId(), 'crsr');
        $assigned_references = [];
        foreach ($childs as $tree_node) {
            $path_info = ilCourseReferencePathInfo::getInstanceByRefId($tree_node['child']);
            if (!$path_info->hasParentCourse()) {
                continue;
            }
            if (!$path_info->isMemberUpdateEnabled()) {
                continue;
            }
            if (!$path_info->checkManagmentAccess()) {
                continue;
            }
            $course_ref_id = $path_info->getTargetId();
            $part = ilCourseParticipants::getInstance($course_ref_id);
            if ($part->isMember($part_id)) {
                $assigned_references[] = $course_ref_id;
            }
        }
        return $assigned_references;
    }

References ilParticipants\getInstance(), and ilCourseReferencePathInfo\getInstanceByRefId().

Referenced by fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

setParticipants()

ilCourseReferenceDeleteConfirmationTableGUI::setParticipants

(

array

$participants

)

Parameters

int[]

$participants

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

    {
        $this->participants = $participants;
    }

References $participants.

Field Documentation

$member_obj

ilCourseReferenceDeleteConfirmationTableGUI::$member_obj = null

private

Definition at line 21 of file class.ilCourseReferenceDeleteConfirmationTableGUI.php.

Referenced by __construct().

$participants

ilCourseReferenceDeleteConfirmationTableGUI::$participants = []

private

Definition at line 26 of file class.ilCourseReferenceDeleteConfirmationTableGUI.php.

Referenced by setParticipants().

$tree

ilCourseReferenceDeleteConfirmationTableGUI::$tree = null

private

Definition at line 15 of file class.ilCourseReferenceDeleteConfirmationTableGUI.php.

---

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

• Modules/CourseReference/classes/class.ilCourseReferenceDeleteConfirmationTableGUI.php