Class ilObjStudyProgrammeMembersTableGUI. More...

Inheritance diagram for ilStudyProgrammeMembersTableGUI:

Collaboration diagram for ilStudyProgrammeMembersTableGUI:

Public Member Functions
	__construct (int $prg_obj_id, int $prg_ref_id, ilObjStudyProgrammeMembersGUI $parent_obj, string $parent_cmd='', string $template_context='', ilStudyProgrammeProgressRepository $sp_user_progress_db, ilPRGPermissionsHelper $permissions, \ILIAS\Data\Factory $data_factory)

	getSelectableColumns ()
	Get selectable columns. More...

	initFilter ()
	Init filter.Overwrite this to initialize all filter input property objects. More...

Public Member Functions inherited from ilTable2GUI
	__construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
	ilTable2GUI constructor. More...

	setOpenFormTag ($a_val)
	Set open form tag. More...

	getOpenFormTag ()
	Get open form tag. More...

	setCloseFormTag ($a_val)
	Set close form tag. More...

	getCloseFormTag ()
	Get close form tag. More...

	determineLimit ()
	Determine the limit. More...

	getSelectableColumns ()
	Get selectable columns. More...

	determineSelectedColumns ()
	Determine selected columns. More...

	isColumnSelected ($a_col)
	Is given column selected? More...

	getSelectedColumns ()
	Get selected columns. More...

	executeCommand ()
	Execute command. More...

	resetOffset ($a_in_determination=false)
	Reset offset. More...

	initFilter ()
	Init filter. More...

	getParentObject ()
	Get parent object. More...

	getParentCmd ()
	Get parent command. More...

	setTopAnchor ($a_val)
	Set top anchor. More...

	getTopAnchor ()
	Get top anchor. More...

	setNoEntriesText ($a_text)
	Set text for an empty table. More...

	getNoEntriesText ()
	Get text for an empty table. More...

	setIsDataTable ($a_val)
	Set is data table. More...

	getIsDataTable ()
	Get is data table. More...

	setEnableTitle ($a_enabletitle)
	Set Enable Title. More...

	getEnableTitle ()
	Get Enable Title. More...

	setEnableHeader ($a_enableheader)
	Set Enable Header. More...

	getEnableHeader ()
	Get Enable Header. More...

	setEnableNumInfo ($a_val)
	Set enable num info. More...

	getEnableNumInfo ()
	Get enable num info. More...

	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	Set title and title icon. More...

	setDescription ($a_val)
	Set description. More...

	getDescription ()
	Get description. More...

	setOrderField ($a_order_field)
	set order column More...

	getOrderField ()

	setData ($a_data)
	set table data @access public More...

	getData ()

	dataExists ()

	setPrefix ($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) @access public More...

	getPrefix ()

	addFilterItem ($a_input_item, $a_optional=false)
	Add filter item. More...

	addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null)
	Add filter by standard type. More...

	getFilterItems ($a_optionals=false)
	Get filter items. More...

	getFilterItemByPostVar ($a_post_var)

	setFilterCols ($a_val)
	Set filter columns. More...

	getFilterCols ()
	Get filter columns. More...

	setDisableFilterHiding ($a_val=true)
	Set disable filter hiding. More...

	getDisableFilterHiding ()
	Get disable filter hiding. More...

	isFilterSelected ($a_col)
	Is given filter selected? More...

	getSelectedFilters ()
	Get selected filters. More...

	determineSelectedFilters ()
	Determine selected filters. More...

	setCustomPreviousNext ($a_prev_link, $a_next_link)
	Set custom previous/next links. More...

	setFormAction ($a_form_action, $a_multipart=false)
	Set Form action parameter. More...

	getFormAction ()
	Get Form action parameter. More...

	setFormName ($a_formname="")
	Set Form name. More...

	getFormName ()
	Get Form name. More...

	setId ($a_val)
	Set id. More...

	getId ()
	Get element id. More...

	setDisplayAsBlock ($a_val)
	Set display as block. More...

	getDisplayAsBlock ()
	Get display as block. More...

	getSelectAllCheckbox ()
	Get the name of the checkbox that should be toggled with a select all button. More...

	setSelectAllCheckbox ($a_select_all_checkbox, $a_select_all_on_top=false)
	Set the name of the checkbox that should be toggled with a select all button. More...

	setExternalSorting ($a_val)
	Set external sorting. More...

	getExternalSorting ()
	Get external sorting. More...

	setFilterCommand ($a_val, $a_caption=null)
	Set filter command. More...

	getFilterCommand ()
	Get filter command. More...

	setResetCommand ($a_val, $a_caption=null)
	Set reset filter command. More...

	getResetCommand ()
	Get reset filter command. More...

	setExternalSegmentation ($a_val)
	Set external segmentation. More...

	getExternalSegmentation ()
	Get external segmentation. More...

	setRowTemplate ($a_template, $a_template_dir="")
	Set row template. More...

	setDefaultOrderField ($a_defaultorderfield)
	Set Default order field. More...

	getDefaultOrderField ()
	Get Default order field. More...

	setDefaultOrderDirection ($a_defaultorderdirection)
	Set Default order direction. More...

	getDefaultOrderDirection ()
	Get Default order direction. More...

	setDefaultFilterVisiblity ($a_status)
	Set default filter visiblity. More...

	getDefaultFilterVisibility ()
	Get default filter visibility. More...

	clearCommandButtons ()

	addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
	Add Command button. More...

	addCommandButtonInstance (ilButtonBase $a_button)
	Add Command button instance. More...

	addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
	Add Selection List + Command button. More...

	addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
	Add Selection List + Command button for selected items. More...

	setCloseCommand ($a_link)
	Add command for closing table. More...

	addMultiCommand ($a_cmd, $a_text)
	Add Command button. More...

	addHiddenInput ($a_name, $a_value)
	Add Hidden Input field. More...

	addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
	Add Header Command (Link) (Image needed for now) More...

	setTopCommands ($a_val)
	Set top commands (display command buttons on top of table, too) More...

	getTopCommands ()
	Get top commands (display command buttons on top of table, too) More...

	addColumn ( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
	Add a column to the header. More...

	getNavParameter ()

	setOrderLink ($sort_field, $order_dir)

	fillHeader ()

	determineOffsetAndOrder ($a_omit_offset=false)
	Determine offset and order. More...

	storeNavParameter ()

	getHTML ()
	Get HTML. More...

	numericOrdering ($a_field)
	Should this field be sorted numeric? More...

	render ()
	render table @access public More...

	writeFilterToSession ()
	Write filter values to session. More...

	resetFilter ()
	Reset filter. More...

	fillFooter ()
	Fill footer row. More...

	getLinkbar ($a_num)
	Get previous/next linkbar. More...

	fillHiddenRow ()

	fillActionRow ()
	Fill Action Row. More...

	setHeaderHTML ($html)
	set header html More...

	storeProperty ($type, $value)
	Store table property. More...

	loadProperty ($type)
	Load table property. More...

	getCurrentState ()
	get current settings for order, limit, columns and filter More...

	setContext ($id)
	Set context. More...

	getContext ()
	Get context. More...

	setShowRowsSelector ($a_value)
	Toggle rows-per-page selector. More...

	getShowRowsSelector ()
	Get rows-per-page selector state. More...

	setShowTemplates ($a_value)
	Toggle templates. More...

	getShowTemplates ()
	Get template state. More...

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

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

	deleteTemplate ($a_name)
	Delete template. More...

	getLimit ()
	Get limit. More...

	getOffset ()
	Get offset. More...

	setExportFormats (array $formats)
	Set available export formats. More...

	setPrintMode ($a_value=false)
	Toogle print mode. More...

	getPrintMode ()
	Get print mode. More...

	getExportMode ()
	Was export activated? More...

	exportData ($format, $send=false)
	Export and optionally send current table data. More...

	setEnableAllCommand ($a_value)
	Enable actions for all entries in current result. More...

	setRowSelectorLabel ($row_selector_label)

	getRowSelectorLabel ()

	setPreventDoubleSubmission ($a_val)
	Set prevent double submission. More...

	getPreventDoubleSubmission ()
	Get prevent double submission. More...

	setLimit ($a_limit=0, $a_default_limit=0)
	set max. More...

Public Member Functions inherited from ilTableGUI
	__construct ($a_data=0, $a_global_tpl=true)
	Constructor. More...

	setTemplate ($a_tpl)
	set template @access public More...

&	getTemplateObject ()

	setData ($a_data)
	set table data @access public More...

	getData ()

	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	set table title @access public More...

	setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
	set table help page @access public More...

	setHeaderNames ($a_header_names)
	set table header names @access public More...

	getColumnCount ()
	Returns the column count based on the number of the header row columns @access public. More...

	setHeaderVars ($a_header_vars, $a_header_params=0)
	set table header vars @access public More...

	setColumnWidth ($a_column_width)
	set table column widths @access public More...

	setOneColumnWidth ($a_column_width, $a_column_number)
	set one table column width @access public More...

	setMaxCount ($a_max_count)
	set max. More...

	setLimit ($a_limit=0, $a_default_limit=0)
	set max. More...

	getLimit ()
	Get limit. More...

	setPrefix ($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) @access public More...

	setOffset ($a_offset)
	set dataset offset @access public More...

	getOffset ()
	Get offset. More...

	setOrderColumn ($a_order_column=0, $a_default_column=0)
	set order column @access public More...

	getOrderColumn ()
	Get order column. More...

	setOrderDirection ($a_order_direction)
	set order direction @access public More...

	getOrderDirection ()
	Get order direction. More...

	setFooter ($a_style, $a_previous=0, $a_next=0)
	set order direction @access public More...

	enable ($a_module_name)
	enables particular modules of table More...

	disable ($a_module_name)
	diesables particular modules of table More...

	sortData ()

	render ()
	render table @access public More...

	renderHeader ()

	setOrderLink ($key, $order_dir)

	setStyle ($a_element, $a_style)

	getStyle ($a_element)

	setBase ($a_base)
	Set Base script name (deprecated, only use this for workarounds). More...

	getBase ()
	Get Base script name (deprecated, only use this for workarounds). More...

	getFormName ()

	setFormName ($a_name="cmd")

	getSelectAllCheckbox ()

	setSelectAllCheckbox ($a_select_all_checkbox)

	clearActionButtons ()

	addActionButton ($btn_name, $btn_value)

Data Fields
const	COLUMNS

const	OPTION_ALL = -1

const	VALIDITY_OPTION_VALID = 1

const	VALIDITY_OPTION_INVALID = 3

const	ORDER_MAPPING

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
	$title

	$icon

	$icon_alt

	$help_page

	$help_icon

	$help_icon_alt

	$header_names

	$header_vars

	$linkbar_vars

	$data

	$column_count

	$column_width

	$max_count

	$limit

	$max_limit = false

	$offset

	$order_column

	$order_direction

	$footer_style

	$footer_previous

	$footer_next

	$lang_support = true

	$global_tpl

	$form_name

	$select_all_checkbox

	$action_buttons

	$prefix

	$base = ""

	$enabled

	$styles

Protected Member Functions
	postOrder (array $list, \ILIAS\Data\Order $order)

	getOrdering ()

	getUserDateFormat ()

	fillRow ($a_set)
	Standard Version of Fill Row. More...

	getValueOrEmptyString (string $condition, string $value)

	buildActionDropDown (array $actions, int $prgrs_id, int $ass_id, int $usr_id)
	Builds the action menu for each row of the table. More...

	getLinkTargetForAction (string $action, int $prgrs_id, int $ass_id)
	Get ilias link for action. More...

	getCompletionLink (int $target_obj_id, int $target_ref_id)

	fetchData (int $prg_id, int $limit=null, int $offset=null, array $filter=[])
	Get data for table. More...

	countFetchData (int $prg_id, array $filter=[])
	Get maximum number of rows the table could have. More...

	getFrom ()

	getWhere (int $prg_id)
	Get the sql part WHERE. More...

	addMultiCommands ()
	Add multicommands to table. More...

	getMultiCommands ()
	Get possible multicommnds. More...

	getPossibleActions (int $node_id, int $root_prg_id, int $status)
	Get a list with possible actions on a progress record. More...

	getValidityOptions ()
	Get options of filter "validity". More...

	getStatusOptions ()
	Get options of filter "status". More...

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

	getFilterWhere (array $filter)
	Get the additional sql WHERE-part for filters. More...

	isPermissionControlledByOrguPosition ()

	getOrguValidUsersFilter ()

Protected Member Functions inherited from ilTable2GUI
	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, $a_element)
	Check if filter element is based on adv md. More...

	fillRow ($a_set)
	Standard Version of Fill Row. More...

	getFilterValue (ilFormPropertyGUI $a_item)
	Get current filter value. More...

	SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
	Set current filter value. More...

	fillMetaExcel (ilExcel $a_excel, &$a_row)
	Add meta information to excel export. More...

	fillHeaderExcel (ilExcel $a_excel, &$a_row)
	Excel Version of Fill Header. More...

	fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
	Excel Version of Fill Row. More...

	fillMetaCSV ($a_csv)
	Add meta information to csv export. More...

	fillHeaderCSV ($a_csv)
	CSV Version of Fill Header. More...

	fillRowCSV ($a_csv, $a_set)
	CSV Version of Fill Row. More...

Protected Attributes
	$prg_obj_id

	$prg_ref_id

	$prg_has_lp_children

	$db

	$ui_factory

	$ui_renderer

	$sp_user_progress_db

	$prg

	$permissions

	$may_edit_anything

	$user_ids_viewer_may_read_learning_progress_of

Protected Attributes inherited from ilTable2GUI
	$ctrl

	$tpl

	$parent_obj

	$parent_cmd

	$close_command = ""

	$top_anchor = "il_table_top"

	$filters = array()

	$optional_filters = array()

	$filter_cmd = 'applyFilter'

	$reset_cmd = 'resetFilter'

	$filter_cols = 5

	$ext_sort = false

	$ext_seg = false

	$context = ""

	$mi_sel_buttons = []

	$disable_filter_hiding = false

	$selected_filter = false

	$top_commands = true

	$selectable_columns = array()

	$selected_column = array()

	$show_templates = false

	$show_rows_selector = true

	$rows_selector_off = false

	$nav_determined = false

	$limit_determined = false

	$filters_determined = false

	$columns_determined = false

	$open_form_tag = true

	$close_form_tag = true

	$export_formats = []

	$export_mode

	$print_mode

	$enable_command_for_all

	$restore_filter

	$restore_filter_values

	$default_filter_visibility = false

	$sortable_fields = array()

	$prevent_double_submission = true

	$row_selector_label

	$select_all_on_top = false

	$sel_buttons = []

Protected Attributes inherited from ilTableGUI
	$tpl

	$lng

Additional Inherited Members
Static Public Member Functions inherited from ilTable2GUI
static	getAllCommandLimit ()
	Get maximum number of entries to enable actions for all. More...

Detailed Description

Class ilObjStudyProgrammeMembersTableGUI.

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

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeMembersTableGUI::__construct	(	int	$prg_obj_id,
		int	$prg_ref_id,
		ilObjStudyProgrammeMembersGUI	$parent_obj,
		string	$parent_cmd = `''`,
		string	$template_context = `''`,
		ilStudyProgrammeProgressRepository	$sp_user_progress_db,
		ilPRGPermissionsHelper	$permissions,
		\ILIAS\Data\Factory	$data_factory
	)

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

      {
        $this->setId("sp_member_list");
        parent::__construct($parent_obj, $parent_cmd, $template_context);
 
        $this->prg_obj_id = $prg_obj_id;
        $this->prg_ref_id = $prg_ref_id;
        $this->data_factory = $data_factory;
        $this->permissions = $permissions;
        $this->may_edit_anything = $this->permissions->mayAnyOf([ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN, ilOrgUnitOperation::OP_MANAGE_MEMBERS]);
        $this->user_ids_viewer_may_read_learning_progress_of = $this->permissions->getUserIdsSusceptibleTo(ilOrgUnitOperation::OP_READ_LEARNING_PROGRESS);
 
        $this->prg = ilObjStudyProgramme::getInstanceByRefId($prg_ref_id);
        $this->prg_has_lp_children = $parent_obj->getStudyProgramme()->hasLPChildren();
 
        global $DIC;
        $this->db = $DIC['ilDB'];
        $this->ui_factory = $DIC['ui.factory'];
        $this->ui_renderer = $DIC['ui.renderer'];
 
        $this->setEnableTitle(true);
        $this->setTopCommands(false);
        $this->setEnableHeader(true);
        $this->setExternalSorting(true);
        $this->setExternalSegmentation(true);
        $this->setRowTemplate("tpl.members_table_row.html", "Modules/StudyProgramme");
        $this->setShowRowsSelector(false);
        $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 (self::COLUMNS as $column) {
            list($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($this->lng->txt($lng_var), $col);
            }
        }
 
        $this->sp_user_progress_db = $sp_user_progress_db;
 
        $this->initFilter();
        $filter_values = $this->getFilterValues();
 
        $this->determineOffsetAndOrder();
        $this->determineLimit();
 
 
        $members_list = $this->fetchData(
            $prg_obj_id,
            $this->getLimit(),
            $this->getOffset(),
            $filter_values
        );
 
        $progress_ids = array_map(
            function ($row) {
                return (int) $row['prgrs_id'];
            },
            $members_list
        );
        $this->addHiddenInput(
            $parent_obj::F_ALL_PROGRESS_IDS,
            implode(',', $progress_ids)
        );
 
        $this->setMaxCount($this->countFetchData($prg_obj_id, $filter_values));
        $this->setData(
            $this->postOrder(
                $members_list,
                $this->getOrdering()
            )
        );
    }

References $DIC, ilTable2GUI\$parent_cmd, ilTable2GUI\$parent_obj, $permissions, $prg_obj_id, $prg_ref_id, $sp_user_progress_db, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addHiddenInput(), addMultiCommands(), countFetchData(), ilTable2GUI\determineLimit(), ilTable2GUI\determineOffsetAndOrder(), fetchData(), getFilterValues(), ilObjStudyProgramme\getInstanceByRefId(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), getOrdering(), ilTable2GUI\getSelectedColumns(), initFilter(), ilOrgUnitOperation\OP_EDIT_INDIVIDUAL_PLAN, ilOrgUnitOperation\OP_MANAGE_MEMBERS, ilOrgUnitOperation\OP_READ_LEARNING_PROGRESS, postOrder(), 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(), and ilTable2GUI\setTopCommands().

Here is the call graph for this function:

Member Function Documentation

◆ addMultiCommands()

ilStudyProgrammeMembersTableGUI::addMultiCommands ( )

protected

Add multicommands to table.

Definition at line 673 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,
		int	$prgrs_id,
		int	$ass_id,
		int	$usr_id
	)

protected

Builds the action menu for each row of the table.

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

      : string {
        $parent = $this->getParentObject();
        $l = new ilAdvancedSelectionListGUI();
 
        $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:
                    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->addItem($this->lng->txt("prg_$action"), $action, $target);
        }
 
        return $l->getHTML();
    }

Referenced by fillRow().

Here is the caller graph for this function:

◆ countFetchData()

ilStudyProgrammeMembersTableGUI::countFetchData	(	int	$prg_id,
		array	$filter = `[]`
	)

protected

Get maximum number of rows the table could have.

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

                                                                       : int
    {
        // TODO: Reimplement this in terms of ActiveRecord when innerjoin
        // supports the required rename functionality
        $query = "SELECT count(prgrs.id) as cnt" . PHP_EOL;
        $query .= $this->getFrom();
        $query .= $this->getWhere($prg_id);
        $query .= $this->getFilterWhere($filter);
 
        $res = $this->db->query($query);
        $rec = $this->db->fetchAssoc($res);
 
        return $rec["cnt"];
    }

References $query, and $res.

Referenced by __construct().

Here is the caller graph for this function:

◆ fetchData()

ilStudyProgrammeMembersTableGUI::fetchData	(	int	$prg_id,
		int	$limit = `null`,
		int	$offset = `null`,
		array	$filter = `[]`
	)

protected

Get data for table.

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

      : array {
        // TODO: Reimplement this in terms of ActiveRecord when innerjoin
        // supports the required rename functionality
 
        $accredited = $this->db->quote(ilStudyProgrammeProgress::STATUS_ACCREDITED, 'integer');
 
        $sql =
             "SELECT" . PHP_EOL
            . "prgrs.id AS prgrs_id," . PHP_EOL
            . "pcp.firstname," . PHP_EOL
            . "pcp.lastname," . PHP_EOL
            . "pcp.login," . PHP_EOL
            . "pcp.usr_id," . PHP_EOL
            . "prgrs.usr_id," . PHP_EOL
            . "prgrs.points," . PHP_EOL
            . "prgrs.points_cur * ABS(prgrs.status - $accredited) /" . PHP_EOL
            . "    (GREATEST(ABS(prgrs.status - $accredited),1))" . PHP_EOL
            . "+ prgrs.points * (1 - ABS(prgrs.status - $accredited) /" . PHP_EOL
            . "    (GREATEST(ABS(prgrs.status - $accredited),1))) AS points_current," . PHP_EOL
            . "prgrs.last_change_by," . PHP_EOL
            . "prgrs.status," . PHP_EOL
            . "prgrs.individual," . PHP_EOL
            . "blngs.title AS belongs_to," . PHP_EOL
            . "cmpl_usr.login AS accredited_by," . PHP_EOL
            . "cmpl_obj.title AS completion_by," . PHP_EOL
            . "cmpl_obj.type AS completion_by_type," . PHP_EOL
            . "prgrs.completion_by AS completion_by_id," . PHP_EOL
            . "prgrs.assignment_id AS assignment_id," . PHP_EOL
            . "prgrs.completion_date," . PHP_EOL
            . "prgrs.vq_date," . PHP_EOL
            . "prgrs.deadline AS prg_deadline," . PHP_EOL
            . "ass.root_prg_id AS root_prg_id," . PHP_EOL
            . "ass.last_change AS prg_assign_date," . PHP_EOL
            . "ass.last_change_by AS prg_assingment_origin," . PHP_EOL
            . "ass_usr.login AS prg_assigned_by," . PHP_EOL
            . "CONCAT(pcp.firstname, pcp.lastname) AS name," . PHP_EOL
            . "prgrs.individual AS custom_plan" . PHP_EOL
        ;
 
        $sql .= $this->getFrom();
        $sql .= $this->getWhere($prg_id);
        $sql .= $this->getFilterWhere($filter);
        $sql .= $this->getOrguValidUsersFilter();
 
        if ($limit !== null) {
            $this->db->setLimit($limit, $offset !== null ? $offset : 0);
        }
 
        $res = $this->db->query($sql);
        $now = new DateTimeImmutable();
        $members_list = array();
 
        while ($rec = $this->db->fetchAssoc($res)) {
            $progress_id = (int) $rec['prgrs_id'];
            $progress = $this->sp_user_progress_db->get($progress_id);
 
            $rec["actions"] = $this->getPossibleActions(
                $prg_id,
                $rec["root_prg_id"],
                $rec["status"]
            );
 
            $prg = ilObjStudyProgramme::getInstanceByObjId($progress->getNodeId());
 
            $rec['points_required'] = number_format($progress->getAmountOfPoints());
            $rec['points_current'] = number_format($progress->getCurrentAmountOfPoints());
 
            if ($rec["status"] == ilStudyProgrammeProgress::STATUS_COMPLETED) {
                //If the status completed is set by crs reference
                //use crs title
                if ($rec["completion_by_type"] == "crsr") {
                    $completion_id = $rec["completion_by_id"];
                    $obj_id = ilContainerReference::_lookupTargetId($completion_id);
                    $ref_id = ilContainerReference::_lookupTargetRefId($completion_id);
                    $rec["completion_by"] = $this->getCompletionLink($obj_id, $ref_id);
                }
 
                // If the status completed and there is a non-null completion_by field
                // in the set, this means the completion was achieved by some leaf in
                // the program tree.
                if (!$rec["completion_by"]) {
                    $prgrs = $this->sp_user_progress_db->getByPrgIdAndAssignmentId(
                        $this->prg_obj_id,
                        $rec["assignment_id"]
                    );
                    $prg = ilObjStudyProgramme::getInstanceByObjId($this->prg_obj_id);
 
                    $links = [];
                    $successful_children = $prg->getIdsOfSuccessfulChildren((int) $rec["assignment_id"]);
                    foreach ($successful_children as $entry) {
                        list($obj_id, $ref_id) = $entry;
                        $links[] = $this->getCompletionLink($obj_id, $ref_id);
                    }
                    $rec["completion_by"] = implode(", ", $links);
                }
                // This case should only occur if the status completed is set
                // by an already deleted crs.
                if (!$rec["completion_by"]) {
                    $title = ilObjectDataDeletionLog::get($rec["completion_by_id"]);
                    if (!is_null($title["title"])) {
                        $rec["completion_by"] = $title["title"];
                    }
                }
            } elseif ($rec["status"] == ilStudyProgrammeProgress::STATUS_ACCREDITED) {
                $rec["completion_by"] = $rec["accredited_by"];
            }
 
            if (!$rec['completion_date']) {
                $rec['completion_date'] = '';
            }
 
            $rec['vq_date'] = '';
            if (!is_null($progress->getValidityOfQualification())
            ) {
                $rec['vq_date'] = $progress->getValidityOfQualification()->format($this->getUserDateFormat());
            }
 
            $rec['prg_validity'] = '-';
            if (!is_null($progress->hasValidQualification($now))) {
                $rec['prg_validity'] = $this->lng->txt('prg_not_valid');
                if ($progress->hasValidQualification($now)) {
                    $rec['prg_validity'] = $this->lng->txt('prg_still_valid');
                }
            }
            
            $rec['prg_deadline'] = null;
            if ($progress->isSuccessful() === false
                && !is_null($progress->getDeadline())
            ) {
                $rec['prg_deadline'] = $progress->getDeadline()->format($this->getUserDateFormat());
            }
 
            $usr_id = (int) $rec['usr_id'];
            $rec["orgus"] = ilObjUser::lookupOrgUnitsRepresentation($usr_id);
            $members_list[] = $rec;
        }
 
        return $members_list;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ fillRow()

ilStudyProgrammeMembersTableGUI::fillRow ( $a_set )

protected

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 237 of file class.ilStudyProgrammeMembersTableGUI.php.

                                       : void
    {
        $usr_id = (int) $a_set['usr_id'];
        if ($this->may_edit_anything) {
            $this->tpl->setCurrentBlock("checkb");
            $this->tpl->setVariable("ID", $a_set["prgrs_id"]);
            $this->tpl->parseCurrentBlock();
        }
 
        $this->tpl->setVariable("FIRSTNAME", $a_set["firstname"]);
        $this->tpl->setVariable("LASTNAME", $a_set["lastname"]);
        $this->tpl->setVariable("LOGIN", $a_set["login"]);
        $this->tpl->setVariable(
            "STATUS",
            $this->getValueOrEmptyString(
                in_array($usr_id, $this->user_ids_viewer_may_read_learning_progress_of),
                $this->prg->statusToRepr($a_set["status"])
            )
        );
        $this->tpl->setVariable("ASSIGN_DATE", $a_set["prg_assign_date"]);
 
 
        $this->tpl->setVariable("POINTS_REQUIRED", $a_set["points_required"]);
 
        if (!$this->prg_has_lp_children) {
            $this->tpl->setCurrentBlock("points_current");
            $this->tpl->setVariable(
                "POINTS_CURRENT",
                $this->getValueOrEmptyString(
                    in_array($usr_id, $this->user_ids_viewer_may_read_learning_progress_of),
                    $a_set['points_current']
                )
            );
            $this->tpl->parseCurrentBlock();
        }
 
 
        foreach ($this->getSelectedColumns() as $column) {
            switch ($column) {
                case "prg_orgus":
                    $this->tpl->setVariable("ORGUS", $a_set["orgus"]);
                    break;
                case "prg_completion_date":
                    $completion_date = '';
                    if (in_array($usr_id, $this->user_ids_viewer_may_read_learning_progress_of)) {
                        $completion_date = $a_set["completion_date"];
                    }
                    $this->tpl->setVariable("COMPLETION_DATE", $completion_date);
                    break;
 
                case "prg_completion_by":
                    if (is_null($a_set["completion_by"])) {
                        $this->tpl->touchBlock("comp_by");
                    } else {
                        $this->tpl->setVariable(
                            "COMPLETION_BY",
                            $this->getValueOrEmptyString(
                                in_array($usr_id, $this->user_ids_viewer_may_read_learning_progress_of),
                                $a_set["completion_by"]
                            )
                        );
                    }
 
                    break;
                case "prg_custom_plan":
                    $individual = $this->lng->txt("no");
                    if ($a_set["individual"]) {
                        $individual = $this->lng->txt("yes");
                    }
                    
                    $this->tpl->setVariable(
                        "CUSTOM_PLAN",
                        $individual
                    );
                    break;
                    
                case "prg_belongs_to":
                    $this->tpl->setVariable("BELONGS_TO", $a_set["belongs_to"]);
                    break;
                case "prg_expiry_date":
                    $this->tpl->setVariable(
                        "EXPIRY_DATE",
                        $this->getValueOrEmptyString(
                            in_array($usr_id, $this->user_ids_viewer_may_read_learning_progress_of),
                            $a_set["vq_date"]
                        )
                    );
                    break;
                case "prg_assigned_by":
                    $assigned_by = $a_set["prg_assigned_by"];
                    if (is_null($assigned_by)) {
                        $srcs = array_flip(ilStudyProgrammeAutoMembershipSource::SOURCE_MAPPING);
                        $assignment_src = (int) $a_set['prg_assignment_origin'];
                        $assigned_by = $this->lng->txt('prg_autoassignment')
                            . ' ' . $this->lng->txt($srcs[$assignment_src]);
                    }
                    $this->tpl->setVariable("ASSIGNED_BY", $assigned_by);
                    break;
                case "prg_deadline":
                    if (is_null($a_set["prg_deadline"])) {
                        $this->tpl->touchBlock("deadline");
                    } else {
                        $this->tpl->setVariable(
                            "DEADLINE",
                            $this->getValueOrEmptyString(
                                in_array($usr_id, $this->user_ids_viewer_may_read_learning_progress_of),
                                $a_set["prg_deadline"]
                            )
                        );
                    }
                    break;
                case "prg_validity":
                    $this->tpl->setVariable(
                        "VALIDITY",
                        $this->getValueOrEmptyString(
                            in_array($usr_id, $this->user_ids_viewer_may_read_learning_progress_of),
                            $a_set['prg_validity']
                        )
                    );
                    break;
 
            }
        }
        $this->tpl->setVariable(
            "ACTIONS",
            $this->buildActionDropDown(
                $a_set["actions"],
                $a_set["prgrs_id"],
                $a_set["assignment_id"],
                $usr_id
            )
        );
    }

References buildActionDropDown(), ilTable2GUI\getSelectedColumns(), getValueOrEmptyString(), and ilStudyProgrammeAutoMembershipSource\SOURCE_MAPPING.

Here is the call graph for this function:

◆ getCompletionLink()

ilStudyProgrammeMembersTableGUI::getCompletionLink	(	int	$target_obj_id,
		int	$target_ref_id
	)

protected

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

                                                                                 : string
    {
        $link = '?';
        if (ilObject::_exists($target_ref_id, true) &&
            is_null(ilObject::_lookupDeletedDate($target_ref_id))
        ) {
            $title = ilObject::_lookupTitle($target_obj_id);
            $url = ilLink::_getStaticLink($target_ref_id, "crs");
            $link = $this->ui_renderer->render($this->ui_factory->link()->standard($title, $url));
        } else {
            $del_data = \ilObjectDataDeletionLog::get($target_obj_id);
            if ($del_data) {
                $link = $del_data['title'];
            }
        }
        return $link;
    }

References $url, ilObject\_exists(), ilLink\_getStaticLink(), ilObject\_lookupDeletedDate(), ilObject\_lookupTitle(), and ilObjectDataDeletionLog\get().

Here is the call graph for this function:

◆ getFilterValues()

ilStudyProgrammeMembersTableGUI::getFilterValues ( )

protected

Get filter-values by field id.

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

                                         : array
    {
        $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:

◆ getFilterWhere()

ilStudyProgrammeMembersTableGUI::getFilterWhere ( array $filter )

protected

Get the additional sql WHERE-part for filters.

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

                                                     : string
    {
        $buf = [''];
 
        if (strlen($filter['name']) > 0) {
            $name = substr($this->db->quote($filter['name'], "text"), 1, -1);
            $name_filter =
                'AND (' . PHP_EOL
                . 'pcp.firstname LIKE \'%' . $name . '%\' OR' . PHP_EOL
                . 'pcp.lastname LIKE \'%' . $name . '%\' OR' . PHP_EOL
                . 'pcp.login LIKE \'%' . $name . '%\'' . PHP_EOL
                . ')' . PHP_EOL
            ;
 
            $buf[] = $name_filter;
        }
 
        if ($filter['prg_status'] && (int) $filter['prg_status'] !== self::OPTION_ALL) {
            $buf[] = 'AND prgrs.status = ' . $this->db->quote($filter['prg_status'], "integer");
        }
        
        $filter_success = 'prgrs.status IN ('
            . ilStudyProgrammeProgress::STATUS_COMPLETED
            . ','
            . ilStudyProgrammeProgress::STATUS_ACCREDITED
        . ') ';
 
        if ($filter['prg_validity'] && (int) $filter['prg_validity'] !== self::OPTION_ALL) {
            if ((int) $filter['prg_validity'] === self::VALIDITY_OPTION_VALID) {
                $filter_validity = 'AND (prgrs.vq_date >= NOW() OR prgrs.vq_date IS NULL)';
            }
            if ((int) $filter['prg_validity'] === self::VALIDITY_OPTION_INVALID) {
                $filter_validity = 'AND prgrs.vq_date < NOW()';
            }
 
            $buf[] = 'AND ('
                . $filter_success
                . $filter_validity
            . ')';
        }
 
        $exp_from = $filter['prg_expiry_date']['from'];
        if (!is_null($exp_from)) {
            $dat = $exp_from->get(IL_CAL_DATE);
            $buf[] = 'AND ('
                . $filter_success
                . 'AND prgrs.vq_date >= \'' . $dat . ' 00:00:00\''
            . ')';
        }
 
        $exp_to = $filter['prg_expiry_date']['to'];
        if (!is_null($exp_to)) {
            $dat = $exp_to->get(IL_CAL_DATE);
            $buf[] = 'AND ('
                . $filter_success
                . 'AND prgrs.vq_date <= \'' . $dat . ' 23:59:59\''
            . ')';
        }
 
        $conditions = implode(PHP_EOL, $buf);
 
        return $conditions;
    }

References $name, IL_CAL_DATE, ilStudyProgrammeProgress\STATUS_ACCREDITED, and ilStudyProgrammeProgress\STATUS_COMPLETED.

◆ getFrom()

ilStudyProgrammeMembersTableGUI::getFrom ( )

protected

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

                                 : string
    {
        return
            "FROM " . ilStudyProgrammeProgressDBRepository::TABLE . " prgrs" . PHP_EOL
            . "JOIN usr_data pcp ON pcp.usr_id = prgrs.usr_id" . PHP_EOL
            . "JOIN " . ilStudyProgrammeAssignmentDBRepository::TABLE . " ass" . PHP_EOL
            . "   ON ass.id = prgrs.assignment_id" . PHP_EOL
            . "JOIN object_data blngs ON blngs.obj_id = ass.root_prg_id" . PHP_EOL
            . "LEFT JOIN usr_data ass_usr ON ass_usr.usr_id = ass.last_change_by" . PHP_EOL
            . "LEFT JOIN usr_data cmpl_usr ON cmpl_usr.usr_id = prgrs.completion_by" . PHP_EOL
            . "LEFT JOIN object_data cmpl_obj ON cmpl_obj.obj_id = prgrs.completion_by" . PHP_EOL
        ;
    }

References ilStudyProgrammeAssignmentDBRepository\TABLE, and ilStudyProgrammeProgressDBRepository\TABLE.

◆ getLinkTargetForAction()

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

protected

Get ilias link for action.

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

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

◆ getMultiCommands()

ilStudyProgrammeMembersTableGUI::getMultiCommands ( )

protected

Get possible multicommnds.

Returns: string[]

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

                                          : array
    {
        $permissions_for_edit_individual_plan = [
            'updateFromCurrentPlanMulti' => $this->lng->txt('prg_multi_update_from_current_plan'),
            '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')
        ];
        
        $permissions_for_manage = [
            'removeUserMulti' => $this->lng->txt('prg_multi_remove_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 ilOrgUnitOperation\OP_EDIT_INDIVIDUAL_PLAN, and ilOrgUnitOperation\OP_MANAGE_MEMBERS.

◆ getOrdering()

ilStudyProgrammeMembersTableGUI::getOrdering ( )

protected

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

                                     : \ILIAS\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:

◆ getOrguValidUsersFilter()

ilStudyProgrammeMembersTableGUI::getOrguValidUsersFilter ( )

protected

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

                                                 : string
    {
        if ($this->permissions->may($this->permissions::ROLEPERM_MANAGE_MEMBERS)) {
            return '';
        }
        $valid_user_ids = $this->permissions->getUserIdsSusceptibleTo(ilOrgUnitOperation::OP_VIEW_MEMBERS);
 
        if (count($valid_user_ids) < 1) {
            return ' AND false';
        }
 
        $valid_user_ids[] = $this->getParentObject()->user->getId();
        return ' AND pcp.usr_id in ('
            . implode(',', $valid_user_ids)
            . ')';
    }

References ilOrgUnitOperation\OP_VIEW_MEMBERS.

◆ getPossibleActions()

ilStudyProgrammeMembersTableGUI::getPossibleActions	(	int	$node_id,
		int	$root_prg_id,
		int	$status
	)

protected

Get a list with possible actions on a progress record.

Returns: string[]

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

      : array {
        $actions = array();
 
        if ($node_id == $root_prg_id) {
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_SHOW_INDIVIDUAL_PLAN;
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_REMOVE_USER;
        }
 
        if ($status == ilStudyProgrammeProgress::STATUS_ACCREDITED) {
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_UNMARK_ACCREDITED;
        }
        if ($status == ilStudyProgrammeProgress::STATUS_IN_PROGRESS) {
            $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_MARK_ACCREDITED;
        }
 
        return $actions;
    }

References ilObjStudyProgrammeMembersGUI\ACTION_REMOVE_USER, and ilObjStudyProgrammeMembersGUI\ACTION_SHOW_INDIVIDUAL_PLAN.

◆ getSelectableColumns()

ilStudyProgrammeMembersTableGUI::getSelectableColumns ( )

Get selectable columns.

Reimplemented from ilTable2GUI.

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

                                           : array
    {
        $cols = [];
        foreach (self::COLUMNS as $column) {
            list($col, $lng_var, $optional, $lp, $no_lp) = $column;
            if ($optional) {
                $cols[$col] = ["txt" => $this->lng->txt($lng_var)];
            }
        }
 
        return $cols;
    }

References $cols.

◆ getStatusOptions()

ilStudyProgrammeMembersTableGUI::getStatusOptions ( )

protected

Get options of filter "status".

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

                                          : array
    {
        return [
            ilStudyProgrammeProgress::STATUS_IN_PROGRESS => $this->lng->txt("prg_status_in_progress"),
            ilStudyProgrammeProgress::STATUS_COMPLETED => $this->lng->txt("prg_status_completed"),
            ilStudyProgrammeProgress::STATUS_ACCREDITED => $this->lng->txt("prg_status_accredited"),
            ilStudyProgrammeProgress::STATUS_NOT_RELEVANT => $this->lng->txt("prg_status_not_relevant"),
            ilStudyProgrammeProgress::STATUS_FAILED => $this->lng->txt("prg_status_failed")
        ];
    }

References ilStudyProgrammeProgress\STATUS_ACCREDITED, ilStudyProgrammeProgress\STATUS_COMPLETED, ilStudyProgrammeProgress\STATUS_FAILED, ilStudyProgrammeProgress\STATUS_IN_PROGRESS, and ilStudyProgrammeProgress\STATUS_NOT_RELEVANT.

◆ getUserDateFormat()

ilStudyProgrammeMembersTableGUI::getUserDateFormat ( )

protected

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

                                           : string
    {
        return ilCalendarUtil::getUserDateFormat(false, true);
    }

References ilCalendarUtil\getUserDateFormat().

Here is the call graph for this function:

◆ getValidityOptions()

ilStudyProgrammeMembersTableGUI::getValidityOptions ( )

protected

Get options of filter "validity".

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

                                            : array
    {
        return [
            self::VALIDITY_OPTION_VALID => $this->lng->txt("prg_still_valid"),
            self::VALIDITY_OPTION_INVALID => $this->lng->txt("prg_not_valid")
        ];
    }

◆ getValueOrEmptyString()

ilStudyProgrammeMembersTableGUI::getValueOrEmptyString	(	string	$condition,
		string	$value
	)

protected

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

                                                                               : string
    {
        if ($condition) {
            return $value;
        }
 
        return '';
    }

Referenced by fillRow().

Here is the caller graph for this function:

◆ getWhere()

ilStudyProgrammeMembersTableGUI::getWhere ( int $prg_id )

protected

Get the sql part WHERE.

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

                                             : string
    {
        $q = "WHERE prgrs.prg_id = " . $this->db->quote($prg_id, "integer") . PHP_EOL;
            
        //get all potentially visible users:
        $visible = [];
        foreach ($this->permissions::ORGU_OPERATIONS as $op) {
            $visible = array_merge(
                $visible,
                $this->permissions->getUserIdsSusceptibleTo($op)
            );
        }
 
        if (count($visible) > 0) {
            $q .= "     AND " . $this->db->in("prgrs.usr_id", $visible, false, "integer") . PHP_EOL;
        } else {
            $q .= " AND FALSE" . PHP_EOL;
        }
        return $q;
    }

◆ initFilter()

ilStudyProgrammeMembersTableGUI::initFilter ( )

Init filter.Overwrite this to initialize all filter input property objects.

Reimplemented from ilTable2GUI.

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

                                 : void
    {
        $item = $this->addFilterItemByMetaType('prg_validity', self::FILTER_SELECT);
        $item->setOptions(
            [self::OPTION_ALL => $this->lng->txt("all")] + $this->getValidityOptions()
        );
 
        $item = $this->addFilterItemByMetaType('prg_status', self::FILTER_SELECT);
        $item->setOptions(
            [self::OPTION_ALL => $this->lng->txt("all")] + $this->getStatusOptions()
        );
 
        $this->addFilterItemByMetaType('name', self::FILTER_TEXT);
        $this->addFilterItemByMetaType('prg_expiry_date', self::FILTER_DATE_RANGE);
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ isPermissionControlledByOrguPosition()

ilStudyProgrammeMembersTableGUI::isPermissionControlledByOrguPosition ( )

protected

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

    {
        return $this->prg->getPositionSettingsIsActiveForPrg();
    }

◆ postOrder()

ilStudyProgrammeMembersTableGUI::postOrder	(	array	$list,
		\ILIAS\Data\Order	$order
	)

protected

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

                                                                        : array
    {
        list($aspect, $direction) = $order->join('', function ($i, $k, $v) {
            return  [$k, $v];
        });
        
        if (array_key_exists($aspect, self::ORDER_MAPPING)) {
            $aspect = self::ORDER_MAPPING[$aspect];
        }
        
        usort($list, function ($a, $b) use ($aspect) {
            if (is_numeric($a[$aspect])) {
                return $a[$aspect] > $b[$aspect];
            }
            return strcmp($a[$aspect], $b[$aspect]);
        });
 
        if ($direction === $order::DESC) {
            $list = array_reverse($list);
        }
        return $list;
    }

References Vendor\Package\$a, Vendor\Package\$b, and $i.

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

◆ $db

ilStudyProgrammeMembersTableGUI::$db

protected

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

◆ $may_edit_anything

ilStudyProgrammeMembersTableGUI::$may_edit_anything

protected

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

◆ $permissions

ilStudyProgrammeMembersTableGUI::$permissions

protected

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

Referenced by __construct().

◆ $prg

ilStudyProgrammeMembersTableGUI::$prg

protected

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

◆ $prg_has_lp_children

ilStudyProgrammeMembersTableGUI::$prg_has_lp_children

protected

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

◆ $prg_obj_id

ilStudyProgrammeMembersTableGUI::$prg_obj_id

protected

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

Referenced by __construct().

◆ $prg_ref_id

ilStudyProgrammeMembersTableGUI::$prg_ref_id

protected

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

Referenced by __construct().

◆ $sp_user_progress_db

ilStudyProgrammeMembersTableGUI::$sp_user_progress_db

protected

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

Referenced by __construct().

◆ $ui_factory

ilStudyProgrammeMembersTableGUI::$ui_factory

protected

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

◆ $ui_renderer

ilStudyProgrammeMembersTableGUI::$ui_renderer

protected

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

◆ $user_ids_viewer_may_read_learning_progress_of

ilStudyProgrammeMembersTableGUI::$user_ids_viewer_may_read_learning_progress_of

protected

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

◆ COLUMNS

const ilStudyProgrammeMembersTableGUI::COLUMNS

Initial value:

= [
        
        ['name', 'name', false, true, true],
        ['login', 'login', false, true, true],
        ['prg_orgus', 'prg_orgus', true, true, true],
        ['prg_status', 'prg_status', false, true, true],
        ['prg_completion_date', 'prg_completion_date', true, true, true],
        ['prg_completion_by', 'prg_completion_by', true, true, true],
        ['points', 'prg_points_reachable', false, true, false],
        ['points', 'prg_points_required', false, false, true],
        ['points_current', 'prg_points_current', false, false, true],
        ['prg_custom_plan', 'prg_custom_plan', true, true, true],
        ['prg_belongs_to', 'prg_belongs_to', true, true, true],
        ['prg_assign_date', 'prg_assign_date', false, true, true],
        ['prg_assigned_by', 'prg_assigned_by', true, true, true],
        ['prg_deadline', 'prg_deadline', true, true, true],
        ['prg_expiry_date', 'prg_expiry_date', true, true, true],
        ['prg_validity', 'prg_validity', true, true, true],
        [null, 'action', false, true, true]
    ]

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

◆ OPTION_ALL

const ilStudyProgrammeMembersTableGUI::OPTION_ALL = -1

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

◆ ORDER_MAPPING

const ilStudyProgrammeMembersTableGUI::ORDER_MAPPING

Initial value:

= [
        'prg_status' => 'status',
        'prg_custom_plan' => 'custom_plan',
        'prg_belongs_to' => 'belongs_to',
        'prg_expiry_date' => 'vq_date',
        'prg_orgus' => 'orgus',
        'prg_completion_by' => 'completion_by',
        'prg_completion_date' => 'completion_date',
    ]

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

◆ VALIDITY_OPTION_INVALID

const ilStudyProgrammeMembersTableGUI::VALIDITY_OPTION_INVALID = 3

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

◆ VALIDITY_OPTION_VALID

const ilStudyProgrammeMembersTableGUI::VALIDITY_OPTION_VALID = 1

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

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

Modules/StudyProgramme/classes/class.ilStudyProgrammeMembersTableGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addMultiCommands()

◆ buildActionDropDown()

◆ countFetchData()

◆ fetchData()

◆ fillRow()

◆ getCompletionLink()

◆ getFilterValues()

◆ getFilterWhere()

◆ getFrom()

◆ getLinkTargetForAction()

◆ getMultiCommands()

◆ getOrdering()

◆ getOrguValidUsersFilter()

◆ getPossibleActions()

◆ getSelectableColumns()

◆ getStatusOptions()

◆ getUserDateFormat()

◆ getValidityOptions()

◆ getValueOrEmptyString()

◆ getWhere()

◆ initFilter()

◆ isPermissionControlledByOrguPosition()

◆ postOrder()

Field Documentation

◆ $db

◆ $may_edit_anything

◆ $permissions

◆ $prg

◆ $prg_has_lp_children

◆ $prg_obj_id

◆ $prg_ref_id

◆ $sp_user_progress_db

◆ $ui_factory

◆ $ui_renderer

◆ $user_ids_viewer_may_read_learning_progress_of

◆ COLUMNS

◆ OPTION_ALL

◆ ORDER_MAPPING

◆ VALIDITY_OPTION_INVALID

◆ VALIDITY_OPTION_VALID