Inheritance diagram for ilStudyProgrammeMembersTableGUI:

Collaboration diagram for ilStudyProgrammeMembersTableGUI:

Public Member Functions
	__construct (int $prg_obj_id, protected int $prg_ref_id, ilObjStudyProgrammeMembersGUI $parent_obj, ilPRGPermissionsHelper $permissions, Data\Factory $data_factory, ILIAS\UI\Factory $ui_factory, ILIAS\UI\Renderer $ui_renderer, ilStudyProgrammeUserTable $prg_user_table, ilPRGAssignmentFilter $custom_filter, ilObjUser $user, string $parent_cmd='', string $template_context='')

	getSelectableColumns ()
	Get selectable columns. More...

	initFilter ()

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

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

	fillRow ($row)

	buildActionDropDown (array $actions, string $prgrs_id, int $ass_id)

	getLinkTargetForAction (string $action, string $prgrs_id, int $ass_id)

	addMultiCommands ()

	getMultiCommands ()
	Get possible multicommands. More...

	getFilterValues ()
	Get filter-values by field id. More...

	getPossibleActions (bool $is_root, int $status, int $node_lifecyle_status)
	Get a list with possible actions on a progress record. More...

	getValidUserIds ()

	getCompletionLink (int $target_obj_id, string $title)

	getCertificateLink (int $usr_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...

Protected Attributes
Data Factory	$data_factory

int	$prg_obj_id

bool	$prg_has_lp_children

ilObjStudyProgramme	$prg

ilPRGPermissionsHelper	$permissions

bool	$may_edit_anything

ilStudyProgrammeUserTable	$prg_user_table

ilObjUser	$user

ilPRGAssignmentFilter	$custom_filter

ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$ui_renderer

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

Definition at line 23 of file class.ilStudyProgrammeMembersTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeMembersTableGUI::__construct	(	int	$prg_obj_id,
		protected int	$prg_ref_id,
		ilObjStudyProgrammeMembersGUI	$parent_obj,
		ilPRGPermissionsHelper	$permissions,
		Data\Factory	$data_factory,
		ILIAS\UI\Factory	$ui_factory,
		ILIAS\UI\Renderer	$ui_renderer,
		ilStudyProgrammeUserTable	$prg_user_table,
		ilPRGAssignmentFilter	$custom_filter,
		ilObjUser	$user,
		string	$parent_cmd = `''`,
		string	$template_context = `''`
	)

Definition at line 37 of file class.ilStudyProgrammeMembersTableGUI.php.

      {
        $this->setId("sp_member_list_" . $prg_obj_id);
        $this->prg_obj_id = $prg_obj_id;
        $this->prg_user_table = $prg_user_table;
        $this->custom_filter = $custom_filter;
 
        $this->data_factory = $data_factory;
        $this->ui_factory = $ui_factory;
        $this->ui_renderer = $ui_renderer;
        $this->permissions = $permissions;
        $this->may_edit_anything = $this->permissions->mayAnyOf([ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN, ilOrgUnitOperation::OP_MANAGE_MEMBERS]);
        $this->user = $user;
 
        $this->prg = ilObjStudyProgramme::getInstanceByRefId($prg_ref_id);
        $this->prg_has_lp_children = $parent_obj->getStudyProgramme()->hasLPChildren();
 
        parent::__construct($parent_obj, $parent_cmd, $template_context);
 
        $this->setEnableTitle(true);
        $this->setTopCommands(false);
        $this->setEnableHeader(true);
        $this->setExternalSorting(true);
        $this->setExternalSegmentation(true);
        $this->setRowTemplate("tpl.members_table_row.html", "components/ILIAS/StudyProgramme");
        $this->setShowRowsSelector(true);
        $this->setFormAction($this->ctrl->getFormAction($parent_obj, "view"));
        $this->addColumn("", "", "1", true);
        $this->setEnableAllCommand(true);
        $this->addMultiCommands();
        $this->setDefaultOrderField('prgrs_id');
        $this->setDefaultOrderDirection('ASC');
 
        if ($this->may_edit_anything) {
            $this->setSelectAllCheckbox($parent_obj::F_SELECTED_PROGRESS_IDS . '[]');
        }
 
        $selected = $this->getSelectedColumns();
        foreach ($this->prg_user_table->getColumns($prg_obj_id, false, $this->prg->isCertificateActive()) as $column) {
            [$col, $lng_var, $optional, $lp, $no_lp] = $column;
 
            $show_by_lp = ($this->prg_has_lp_children && $lp) || (!$this->prg_has_lp_children && $no_lp);
            $show_optional = !$optional || ($optional && array_key_exists($col, $selected));
 
            if ($show_by_lp && $show_optional) {
                $this->addColumn($lng_var, $col);
            }
        }
 
        $this->addColumn($this->lng->txt('action'), '');
 
        $this->initFilter();
        $this->determineOffsetAndOrder();
        $this->determineLimit();
 
        $valid_user_ids = $this->getValidUserIds();
        $filter_values = $this->getFilterValues();
 
        $order = $this->getOrdering();
 
        $members_list = $this->prg_user_table->fetchData(
            $prg_obj_id,
            $valid_user_ids,
            $order,
            $this->custom_filter->withValues($filter_values),
            $this->getLimit() ? (int) $this->getLimit() : null,
            $this->getOffset()
        );
 
        $count = $this->prg_user_table->countFetchData(
            $prg_obj_id,
            $valid_user_ids,
            $this->custom_filter->withValues($filter_values)
        );
        $this->setMaxCount($count);
 
 
        $progress_ids = array_map(
            function ($row) {
                return (string) $row->getId();
            },
            $members_list
        );
        $this->addHiddenInput(
            $parent_obj::F_ALL_PROGRESS_IDS,
            implode(',', $progress_ids)
        );
 
        $this->setData($members_list);
    }

References ilTable2GUI\$column, $custom_filter, $data_factory, ilTable2GUI\$parent_cmd, ilTable2GUI\$parent_obj, $permissions, $prg_obj_id, $prg_user_table, $ui_factory, $ui_renderer, $user, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addHiddenInput(), addMultiCommands(), ILIAS\Repository\ctrl(), ilTable2GUI\determineLimit(), ilTable2GUI\determineOffsetAndOrder(), getFilterValues(), ilObjStudyProgramme\getInstanceByRefId(), getOrdering(), ilTable2GUI\getSelectedColumns(), getValidUserIds(), initFilter(), ILIAS\Repository\lng(), ilPRGPermissionsHelper\mayAnyOf(), ilOrgUnitOperation\OP_EDIT_INDIVIDUAL_PLAN, ilOrgUnitOperation\OP_MANAGE_MEMBERS, ilTable2GUI\setData(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableAllCommand(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTableGUI\setMaxCount(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), ilTable2GUI\setShowRowsSelector(), ilTable2GUI\setTopCommands(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ addMultiCommands()

ilStudyProgrammeMembersTableGUI::addMultiCommands ( )

protected

Definition at line 341 of file class.ilStudyProgrammeMembersTableGUI.php.

                                         : void
    {
        foreach ($this->getMultiCommands() as $cmd => $caption) {
            $this->addMultiCommand($cmd, $caption);
        }
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ buildActionDropDown()

ilStudyProgrammeMembersTableGUI::buildActionDropDown	(	array	$actions,
		string	$prgrs_id,
		int	$ass_id
	)

protected

Definition at line 272 of file class.ilStudyProgrammeMembersTableGUI.php.

     : string {
        $l = [];
 
        $view_individual_plan = $this->permissions->may(ilOrgUnitOperation::OP_VIEW_INDIVIDUAL_PLAN);
        $edit_individual_plan = $this->permissions->may(ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN);
        $addremove_users = $this->permissions->may(ilOrgUnitOperation::OP_MANAGE_MEMBERS);
 
        foreach ($actions as $action) {
            switch ($action) {
                case ilObjStudyProgrammeMembersGUI::ACTION_MARK_ACCREDITED:
                case ilObjStudyProgrammeMembersGUI::ACTION_UNMARK_ACCREDITED:
                case ilObjStudyProgrammeMembersGUI::ACTION_UNMARK_RELEVANT:
                case ilObjStudyProgrammeMembersGUI::ACTION_MARK_RELEVANT:
                case ilObjStudyProgrammeMembersGUI::ACTION_UPDATE_FROM_CURRENT_PLAN:
                case ilObjStudyProgrammeMembersGUI::ACTION_ACKNOWLEDGE_COURSES:
                case ilObjStudyProgrammeMembersGUI::ACTION_CHANGE_DEADLINE:
                case ilObjStudyProgrammeMembersGUI::ACTION_CHANGE_EXPIRE_DATE:
                case ilObjStudyProgrammeMembersGUI::ACTION_UPDATE_CERTIFICATE:
                case ilObjStudyProgrammeMembersGUI::ACTION_REMOVE_CERTIFICATE:
 
                    if (!$edit_individual_plan) {
                        continue 2;
                    }
                    break;
                case ilObjStudyProgrammeMembersGUI::ACTION_SHOW_INDIVIDUAL_PLAN:
                    if (!$view_individual_plan) {
                        continue 2;
                    }
                    break;
 
                case ilObjStudyProgrammeMembersGUI::ACTION_REMOVE_USER:
                    if (!$addremove_users) {
                        continue 2;
                    }
                    break;
            }
 
            $target = $this->getLinkTargetForAction($action, $prgrs_id, $ass_id);
            $l[] = $this->ui_factory->button()->shy($this->lng->txt("prg_$action"), $target);
        }
        return $this->ui_renderer->render(
            $this->ui_factory->dropdown()->standard($l)
        );
    }

Referenced by fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillRow()

ilStudyProgrammeMembersTableGUI::fillRow ( $row )

protected

Definition at line 155 of file class.ilStudyProgrammeMembersTableGUI.php.

                                    : void
    {
        if (!$row instanceof ilStudyProgrammeUserTableRow) {
            throw new \Exception("use ilStudyProgrammeUserTableRow for data output", 1);
        }
 
        if ($this->may_edit_anything) {
            $this->tpl->setCurrentBlock("checkb");
            $this->tpl->setVariable("ID", (string) $row->getId());
            $this->tpl->parseCurrentBlock();
        }
 
        if (!$row->isUserActiveRaw()) {
            $this->tpl->setCurrentBlock('access_warning');
            $this->tpl->setVariable('PARENT_ACCESS', $this->lng->txt('usr_account_inactive'));
            $this->tpl->parseCurrentBlock();
        }
 
        $this->tpl->setVariable("FIRSTNAME", $row->getFirstname());
        $this->tpl->setVariable("LASTNAME", $row->getLastname());
        $this->tpl->setVariable("LOGIN", $row->getLogin());
        $this->tpl->setVariable("STATUS", $row->getStatus());
        $this->tpl->setVariable("ASSIGN_DATE", $row->getAssignmentDate());
        $this->tpl->setVariable("POINTS_REQUIRED", $row->getPointsRequired());
 
        if (!$this->prg_has_lp_children) {
            $this->tpl->setCurrentBlock("points_current");
            $this->tpl->setVariable("POINTS_CURRENT", $row->getPointsCurrent());
            $this->tpl->parseCurrentBlock();
        }
 
        foreach ($this->getSelectedColumns() as $column) {
            switch ($column) {
                case "prg_orgus":
                    $this->tpl->setVariable("ORGUS", $row->getOrgUs());
                    break;
                case "prg_completion_date":
                    $this->tpl->setVariable("COMPLETION_DATE", $row->getCompletionDate());
                    break;
                case "prg_completion_by":
                    $completion_by = $row->getCompletionBy();
                    if ($completion_by_obj_ids = $row->getCompletionByObjIds()) {
                        $out = [];
                        foreach ($completion_by_obj_ids as $completion_by_obj_id) {
                            $type = ilObject::_lookupType($completion_by_obj_id);
                            if ($type === 'crs') {
                                $out[] = $this->getCompletionLink($completion_by_obj_id, $completion_by);
                            } else {
                                $target_obj_id = $completion_by_obj_id;
                                $out[] = $this->getCompletionLink(
                                    $target_obj_id,
                                    ilStudyProgrammeUserTable::lookupTitle($completion_by_obj_id)
                                );
                            }
                        }
                        $completion_by = implode(', ', $out);
                    }
                    $this->tpl->setVariable("COMPLETION_BY", $completion_by);
                    break;
                case "prg_custom_plan":
                    $this->tpl->setVariable("CUSTOM_PLAN", $row->getCustomPlan());
                    break;
                case "prg_belongs_to":
                    $this->tpl->setVariable("BELONGS_TO", $row->getBelongsTo());
                    break;
                case "prg_expiry_date":
                    $this->tpl->setVariable("EXPIRY_DATE", $row->getExpiryDate());
                    break;
                case "prg_assigned_by":
                    $this->tpl->setVariable("ASSIGNED_BY", $row->getAssignmentBy());
                    break;
                case "prg_deadline":
                    $this->tpl->setVariable("DEADLINE", $row->getDeadline());
                    break;
                case "prg_validity":
                    $this->tpl->setVariable("VALIDITY", $row->getValidity());
                    break;
                case 'org_units':
                    $this->tpl->setCurrentBlock('udf');
                    $this->tpl->setVariable("UDF", $row->getOrgUs());
                    $this->tpl->parseCurrentBlock();
                    break;
                case 'gender':
                    $this->tpl->setCurrentBlock('udf');
                    $this->tpl->setVariable("UDF", $row->getGender());
                    $this->tpl->parseCurrentBlock();
                    break;
                case 'cert_relevance':
                    $cert = '';
                    if ($row->getCertificateRelevance()) {
                        $cert = $this->getCertificateLink($row->getUsrId());
                    }
                    $this->tpl->setVariable("CERT_RELEVANCE", $cert);
                    break;
                default:
                    $value = $row->getUserInformation()->getUserData($column) ?? '';
                    $this->tpl->setCurrentBlock('udf');
                    $this->tpl->setVariable("UDF", $value);
                    $this->tpl->parseCurrentBlock();
            }
        }
        $actions = $this->getPossibleActions(
            $row->isRootProgress(),
            $row->getStatusRaw(),
            $row->getNodeLifecycleStatus()
        );
 
        $this->tpl->setVariable(
            "ACTIONS",
            $this->buildActionDropDown(
                $actions,
                (string) $row->getId(),
                $row->getAssignmentId()
            )
        );
    }

References ilTable2GUI\$column, $out, ilObject\_lookupType(), buildActionDropDown(), getCertificateLink(), getCompletionLink(), getPossibleActions(), ilTable2GUI\getSelectedColumns(), ILIAS\Repository\lng(), and ilStudyProgrammeUserTable\lookupTitle().

Here is the call graph for this function:

◆ getCertificateLink()

ilStudyProgrammeMembersTableGUI::getCertificateLink ( int $usr_id )

protected

Definition at line 490 of file class.ilStudyProgrammeMembersTableGUI.php.

                                                      : string
    {
        $this->ctrl->setParameter($this->parent_obj, 'cert_usr_id', $usr_id);
        $cert_url = $this->ctrl->getLinkTarget($this->parent_obj, 'deliverCertificate');
        $this->ctrl->setParameter($this->parent_obj, 'cert_usr_id', null);
        $icon = $this->ui_renderer->render(
            $this->ui_factory->symbol()->icon()->standard('cert', 'relevant', 'small')
        );
        $link = $this->ui_factory->link()->standard($icon, $cert_url);
        return $this->ui_renderer->render($link);
    }

References ILIAS\Repository\ctrl().

Referenced by fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCompletionLink()

ilStudyProgrammeMembersTableGUI::getCompletionLink	(	int	$target_obj_id,
		string	$title
	)

protected

Definition at line 477 of file class.ilStudyProgrammeMembersTableGUI.php.

                                                                           : string
    {
        $link = $title;
        $ref_ids = ilObject::_getAllReferences($target_obj_id);
        foreach ($ref_ids as $ref_id) {
            if (!ilObject::_isInTrash($ref_id)) {
                $url = ilLink::_getStaticLink($ref_id, "crs");
                $link = $this->ui_renderer->render($this->ui_factory->link()->standard($title, $url));
            }
        }
        return $link;
    }

References $ref_id, $url, ilObject\_getAllReferences(), ilLink\_getStaticLink(), and ilObject\_isInTrash().

Referenced by fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFilterValues()

ilStudyProgrammeMembersTableGUI::getFilterValues ( )

protected

Get filter-values by field id.

Definition at line 405 of file class.ilStudyProgrammeMembersTableGUI.php.

                                        : array
    {
        $this->getCurrentState();
        $f = [];
        foreach ($this->filters as $item) {
            $f[$item->getFieldId()] = $this->getFilterValue($item);
        }
        return $f;
    }

References Vendor\Package\$f.

Referenced by __construct().

Here is the caller graph for this function:

◆ getLinkTargetForAction()

ilStudyProgrammeMembersTableGUI::getLinkTargetForAction	(	string	$action,
		string	$prgrs_id,
		int	$ass_id
	)

protected

Definition at line 322 of file class.ilStudyProgrammeMembersTableGUI.php.

                                                                                            : string
    {
        return $this->getParentObject()->getLinkTargetForAction($action, $prgrs_id, $ass_id);
    }

References $ass_id.

Referenced by buildActionDropDown().

Here is the caller graph for this function:

◆ getMultiCommands()

ilStudyProgrammeMembersTableGUI::getMultiCommands ( )

protected

Get possible multicommands.

Returns: string[]

Definition at line 353 of file class.ilStudyProgrammeMembersTableGUI.php.

                                         : array
    {
        $permissions_for_edit_individual_plan = [
            'updateFromCurrentPlanMulti' => $this->lng->txt('prg_multi_update_from_current_plan'),
            'acknowledgeCoursesMulti' => $this->lng->txt('prg_acknowledge_completed_courses'),
            'markRelevantMulti' => $this->lng->txt('prg_multi_mark_relevant'),
            'markNotRelevantMulti' => $this->lng->txt('prg_multi_unmark_relevant'),
            'changeDeadlineMulti' => $this->lng->txt('prg_multi_change_deadline'),
            'changeExpireDateMulti' => $this->lng->txt('prg_multi_change_expire_date'),
            'markAccreditedMulti' => $this->lng->txt('prg_multi_mark_accredited'),
            'unmarkAccreditedMulti' => $this->lng->txt('prg_multi_unmark_accredited'),
        ];
        if ($this->prg->isCertificateActive()) {
            $permissions_for_edit_individual_plan['updateCertificateMulti'] = $this->lng->txt('prg_multi_update_certificate');
            $permissions_for_edit_individual_plan['removeCertificateMulti'] = $this->lng->txt('prg_multi_remove_certificate');
        }
 
        $permissions_for_manage = [
            'removeUserMulti' => $this->lng->txt('prg_multi_remove_user'),
            'mailUserMulti' => $this->lng->txt('prg_multi_mail_user')
        ];
 
        $perms = [];
 
        if ($this->permissions->may(ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN)) {
            $perms = array_merge($perms, $permissions_for_edit_individual_plan);
        }
 
        if ($this->permissions->may(ilOrgUnitOperation::OP_MANAGE_MEMBERS)) {
            $perms = array_merge($perms, $permissions_for_manage);
        }
 
        return $perms;
    }

References ILIAS\Repository\lng(), ilOrgUnitOperation\OP_EDIT_INDIVIDUAL_PLAN, and ilOrgUnitOperation\OP_MANAGE_MEMBERS.

Here is the call graph for this function:

◆ getOrdering()

ilStudyProgrammeMembersTableGUI::getOrdering ( )

protected

Definition at line 140 of file class.ilStudyProgrammeMembersTableGUI.php.

                                    : Data\Order
    {
        $field = $this->getOrderField();
        if (!$field) {
            $field = $this->getDefaultOrderField();
        }
        $direction = $this->getOrderDirection();
        if (!$direction) {
            $direction = $this->getDefaultOrderDirection();
        }
 
        return $this->data_factory->order($field, strtoupper($direction));
    }

References ilTable2GUI\getDefaultOrderDirection(), ilTable2GUI\getDefaultOrderField(), ilTableGUI\getOrderDirection(), and ilTable2GUI\getOrderField().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPossibleActions()

ilStudyProgrammeMembersTableGUI::getPossibleActions	(	bool	$is_root,
		int	$status,
		int	$node_lifecyle_status
	)

protected

Get a list with possible actions on a progress record.

Returns: string[]

Definition at line 420 of file class.ilStudyProgrammeMembersTableGUI.php.

     : array {
        $actions = [];
 
        if ($is_root) {
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_SHOW_INDIVIDUAL_PLAN;
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_REMOVE_USER;
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_UPDATE_FROM_CURRENT_PLAN;
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_CHANGE_DEADLINE;
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_CHANGE_EXPIRE_DATE;
        }
 
        if ($status == ilPRGProgress::STATUS_ACCREDITED) {
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_UNMARK_ACCREDITED;
        }
        if ($status == ilPRGProgress::STATUS_IN_PROGRESS) {
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_MARK_ACCREDITED;
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_ACKNOWLEDGE_COURSES;
        }
 
        if (! $is_root &&
            ($status == ilPRGProgress::STATUS_IN_PROGRESS ||
            $status == ilPRGProgress::STATUS_ACCREDITED)
        ) {
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_UNMARK_RELEVANT;
        }
        if ($status == ilPRGProgress::STATUS_NOT_RELEVANT
            && $node_lifecyle_status == ilStudyProgrammeAssessmentSettings::STATUS_ACTIVE
        ) {
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_MARK_RELEVANT;
        }
        if ($status == ilPRGProgress::STATUS_COMPLETED ||
            $status == ilPRGProgress::STATUS_ACCREDITED
            && $this->prg->isCertificateActive()
        ) {
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_UPDATE_CERTIFICATE;
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_REMOVE_CERTIFICATE;
        }
 
 
        return $actions;
    }

References ilObjStudyProgrammeMembersGUI\ACTION_CHANGE_DEADLINE, ilObjStudyProgrammeMembersGUI\ACTION_CHANGE_EXPIRE_DATE, ilObjStudyProgrammeMembersGUI\ACTION_REMOVE_USER, ilObjStudyProgrammeMembersGUI\ACTION_SHOW_INDIVIDUAL_PLAN, and ilObjStudyProgrammeMembersGUI\ACTION_UPDATE_FROM_CURRENT_PLAN.

Referenced by fillRow().

Here is the caller graph for this function:

◆ getSelectableColumns()

ilStudyProgrammeMembersTableGUI::getSelectableColumns ( )

Get selectable columns.

Returns: array key: column id, val: true/false -> default on/off

Reimplemented from ilTable2GUI.

Definition at line 327 of file class.ilStudyProgrammeMembersTableGUI.php.

                                          : array
    {
        $cols = [];
 
        foreach ($this->prg_user_table->getColumns($this->prg_obj_id, false, $this->prg->isCertificateActive()) as $column) {
            [$col, $lng_var, $optional, $lp, $no_lp] = $column;
            if ($optional) {
                $cols[$col] = ["txt" => $lng_var];
            }
        }
 
        return $cols;
    }

◆ getValidUserIds()

ilStudyProgrammeMembersTableGUI::getValidUserIds ( )

protected

Definition at line 466 of file class.ilStudyProgrammeMembersTableGUI.php.

                                        : ?array
    {
        if ($this->permissions->may($this->permissions::ROLEPERM_MANAGE_MEMBERS)) {
            return null;
        }
 
        $valid_user_ids = $this->permissions->getUserIdsSusceptibleTo(ilOrgUnitOperation::OP_VIEW_MEMBERS);
        array_unshift($valid_user_ids, $this->user->getId());
        return $valid_user_ids;
    }

References ilOrgUnitOperation\OP_VIEW_MEMBERS, and ILIAS\Repository\user().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFilter()

ilStudyProgrammeMembersTableGUI::initFilter ( )

Reimplemented from ilTable2GUI.

Definition at line 391 of file class.ilStudyProgrammeMembersTableGUI.php.

                                : void
    {
        foreach ($this->custom_filter->getItemConfig() as $conf) {
            [$id, $type, $options, $caption] = $conf;
            $item = $this->addFilterItemByMetaType($id, $type, false, $caption);
            if ($options) {
                $item->setOptions($options);
            }
        }
    }

References $id.

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

◆ $custom_filter

ilPRGAssignmentFilter ilStudyProgrammeMembersTableGUI::$custom_filter

protected

Definition at line 33 of file class.ilStudyProgrammeMembersTableGUI.php.

Referenced by __construct().

◆ $data_factory

Data Factory ilStudyProgrammeMembersTableGUI::$data_factory

protected

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

Referenced by __construct().

◆ $may_edit_anything

bool ilStudyProgrammeMembersTableGUI::$may_edit_anything

protected

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

◆ $permissions

ilPRGPermissionsHelper ilStudyProgrammeMembersTableGUI::$permissions

protected

Definition at line 29 of file class.ilStudyProgrammeMembersTableGUI.php.

Referenced by __construct().

◆ $prg

ilObjStudyProgramme ilStudyProgrammeMembersTableGUI::$prg

protected

Definition at line 28 of file class.ilStudyProgrammeMembersTableGUI.php.

◆ $prg_has_lp_children

bool ilStudyProgrammeMembersTableGUI::$prg_has_lp_children

protected

Definition at line 27 of file class.ilStudyProgrammeMembersTableGUI.php.

◆ $prg_obj_id

int ilStudyProgrammeMembersTableGUI::$prg_obj_id

protected

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

Referenced by __construct().

◆ $prg_user_table

ilStudyProgrammeUserTable ilStudyProgrammeMembersTableGUI::$prg_user_table

protected

Definition at line 31 of file class.ilStudyProgrammeMembersTableGUI.php.

Referenced by __construct().

◆ $ui_factory

ILIAS UI Factory ilStudyProgrammeMembersTableGUI::$ui_factory

protected

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

Referenced by __construct().

◆ $ui_renderer

ILIAS UI Renderer ilStudyProgrammeMembersTableGUI::$ui_renderer

protected

Definition at line 35 of file class.ilStudyProgrammeMembersTableGUI.php.

Referenced by __construct().

◆ $user

ilObjUser ilStudyProgrammeMembersTableGUI::$user

protected

Definition at line 32 of file class.ilStudyProgrammeMembersTableGUI.php.

Referenced by __construct().

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

components/ILIAS/StudyProgramme/classes/class.ilStudyProgrammeMembersTableGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addMultiCommands()

◆ buildActionDropDown()

◆ fillRow()

◆ getCertificateLink()

◆ getCompletionLink()

◆ getFilterValues()

◆ getLinkTargetForAction()

◆ getMultiCommands()

◆ getOrdering()

◆ getPossibleActions()

◆ getSelectableColumns()

◆ getValidUserIds()

◆ initFilter()

Field Documentation

◆ $custom_filter

◆ $data_factory

◆ $may_edit_anything

◆ $permissions

◆ $prg

◆ $prg_has_lp_children

◆ $prg_obj_id

◆ $prg_user_table

◆ $ui_factory

◆ $ui_renderer

◆ $user