Class ilObjStudyProgrammeMembersTableGUI. More...

Inheritance diagram for ilStudyProgrammeMembersTableGUI:

Collaboration diagram for ilStudyProgrammeMembersTableGUI:

Public Member Functions
	__construct ($a_prg_obj_id, $a_prg_ref_id, $a_parent_obj, $a_parent_cmd="", $a_template_context="", \ilStudyProgrammeUserProgressDB $sp_user_progress_db)

	getSelectableColumns ()
	Get selectable columns. 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)
	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)

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

	buildActionDropDown ($a_actions, $a_prgrs_id, $a_ass_id)
	Builds the action menu for each row of the table. More...

	getLinkTargetForAction ($a_action, $a_prgrs_id, $a_ass_id)
	Get ilias link for action. More...

	fetchData ($a_prg_id, $limit=null, $offset=null, $order_coloumn=null, $order_direction=null)
	Get data for table. More...

	countFetchData ($a_prg_id)
	Get maximum number of rows the table could have. More...

	getFrom ()
	Get the sql part FROM. More...

	getWhere ($a_prg_id)
	Get the sql part WHERE. More...

	getColumnsChildren ()
	Get columns for children if it is a child. More...

	getColumnsLPChildren ()
	Get columns for children if it is a lp child. More...

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

	getMultiCommands ()
	Get possible multicommnds. More...

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

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

	$sel_buttons = []

Protected Attributes inherited from ilTableGUI
	$tpl

	$lng

Private Attributes
	$sp_user_progress_db

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

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

Detailed Description

Class ilObjStudyProgrammeMembersTableGUI.

Author: Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de; Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

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

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeMembersTableGUI::__construct	(		$a_prg_obj_id,
			$a_prg_ref_id,
			$a_parent_obj,
			$a_parent_cmd = `""`,
			$a_template_context = `""`,
		\ilStudyProgrammeUserProgressDB	$sp_user_progress_db
	)

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

    {
        $this->setId("sp_member_list");
        parent::__construct($a_parent_obj, $a_parent_cmd, $a_template_context);
 
        $this->prg_obj_id = $a_prg_obj_id;
        $this->prg_ref_id = $a_prg_ref_id;
        $this->prg_has_lp_children = $a_parent_obj->getStudyProgramme()->hasLPChildren();
 
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
        $ilDB = $DIC['ilDB'];
        $this->ctrl = $ilCtrl;
        $this->lng = $lng;
        $this->db = $ilDB;
 
        $this->setEnableTitle(true);
        $this->setTopCommands(false);
        $this->setEnableHeader(true);
        // TODO: switch this to internal sorting/segmentation
        $this->setExternalSorting(true);
        $this->setExternalSegmentation(true);
        $this->setRowTemplate("tpl.members_table_row.html", "Modules/StudyProgramme");
        $this->setShowRowsSelector(false);
 
        $this->setFormAction($ilCtrl->getFormAction($a_parent_obj, "view"));
 
        $this->addColumn("", "", "1", true);
        $this->setSelectAllCheckbox("prgs_ids[]");
        $this->setEnableAllCommand(true);
        $this->addMultiCommands();
 
        if ($this->prg_has_lp_children) {
            $columns = $this->getColumnsLPChildren();
        } else {
            $columns = $this->getColumnsChildren();
        }
 
        foreach ($this->getSelectedColumns() as $column) {
            $columns[$column] = array($column);
        }
 
        $columns["action"] = array(null);
 
        foreach ($columns as $lng_var => $params) {
            $this->addColumn($this->lng->txt($lng_var), $params[0]);
        }
 
        $this->determineLimit();
        $this->determineOffsetAndOrder();
        $oder = $this->getOrderField();
        $dir = $this->getOrderDirection();
 
        $this->sp_user_progress_db = $sp_user_progress_db;
 
        $members_list = $this->fetchData($a_prg_obj_id, $this->getLimit(), $this->getOffset(), $this->getOrderField(), $this->getOrderDirection());
        $this->setMaxCount($this->countFetchData($a_prg_obj_id));
        $this->setData($members_list);
    }

References $column, $columns, $DIC, $ilCtrl, $ilDB, ilTableGUI\$lng, $params, $sp_user_progress_db, ilTable2GUI\addColumn(), addMultiCommands(), countFetchData(), ilTable2GUI\determineLimit(), ilTable2GUI\determineOffsetAndOrder(), fetchData(), getColumnsChildren(), getColumnsLPChildren(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilTable2GUI\getSelectedColumns(), ilTable2GUI\setData(), 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.

Returns: null

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

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

References ilTable2GUI\addMultiCommand(), and getMultiCommands().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildActionDropDown()

ilStudyProgrammeMembersTableGUI::buildActionDropDown	(	$a_actions,
		$a_prgrs_id,
		$a_ass_id
	)

protected

Builds the action menu for each row of the table.

Parameters

stirng	$a_actions
int	$a_prgrs_id
int	$a_ass_id

Returns: ilAdvancedSelectionListGUI

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

    {
        $l = new ilAdvancedSelectionListGUI();
        foreach ($a_actions as $action) {
            $target = $this->getLinkTargetForAction($action, $a_prgrs_id, $a_ass_id);
            $l->addItem($this->lng->txt("prg_$action"), $action, $target);
        }
        return $l->getHTML();
    }

References $action, $l, $target, and getLinkTargetForAction().

Referenced by fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ countFetchData()

ilStudyProgrammeMembersTableGUI::countFetchData ( $a_prg_id )

protected

Get maximum number of rows the table could have.

Parameters

int $a_prg_id

Returns: int

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

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

References $query, $res, getFrom(), and getWhere().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchData()

ilStudyProgrammeMembersTableGUI::fetchData	(	$a_prg_id,
		$limit = `null`,
		$offset = `null`,
		$order_coloumn = `null`,
		$order_direction = `null`
	)

protected

Get data for table.

Parameters

int	$a_prg_id
int \| null	$limit
int \| null	$offset
string \| null	$order_column
string \| null	$order_directon

Returns: string[]

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

    {
        // TODO: Reimplement this in terms of ActiveRecord when innerjoin
        // supports the required rename functionality
        $query = "SELECT prgrs.id prgrs_id"
                   . "     , pcp.firstname"
                   . "     , pcp.lastname"
                   . "     , pcp.login"
                   . "     , prgrs.points"
                   //the following is a replacement for:
                   //IF(prgrs.status = ".ilStudyProgrammeProgress::STATUS_ACCREDITED.",prgrs.points,prgrs.points_cur)
                   //dirty hack to make it work with oracle :/ 1-|x-a|/max(|x-a|,1) = id_a(x)
                   . "     , prgrs.points_cur*"
                       . "ABS(prgrs.status - " . ilStudyProgrammeProgress::STATUS_ACCREDITED . ")"
                           . "/(GREATEST(ABS(prgrs.status - " . ilStudyProgrammeProgress::STATUS_ACCREDITED . "),1))"
                   . "     + prgrs.points*"
                       . "(1 -ABS(prgrs.status - " . ilStudyProgrammeProgress::STATUS_ACCREDITED . ")"
                           . "/(GREATEST(ABS(prgrs.status - " . ilStudyProgrammeProgress::STATUS_ACCREDITED . "),1))) points_current"
                   . "     , prgrs.last_change_by"
                   . "     , prgrs.status"
                   . "     , blngs.title belongs_to"
                   . "     , cmpl_usr.login accredited_by"
                   . "     , cmpl_obj.title completion_by"
                   . "     , cmpl_obj.type completion_by_type"
                   . "     , prgrs.completion_by completion_by_id"
                   . "     , prgrs.assignment_id assignment_id"
                   . "     , ass.root_prg_id root_prg_id"
                   . "     , ass.last_change prg_assign_date"
                   . "     , ass_usr.login prg_assigned_by"
                   // for sorting
                   . "     , CONCAT(pcp.firstname, pcp.lastname) name"
                   . "     , (prgrs.last_change_by IS NOT NULL) custom_plan"
                   ;
 
        $query .= $this->getFrom();
        $query .= $this->getWhere($a_prg_id);
 
        if ($order_coloumn !== null) {
            $query .= " ORDER BY $order_coloumn";
 
            if ($order_direction !== null) {
                $query .= " $order_direction";
            }
        }
 
 
        if ($limit !== null) {
            $this->db->setLimit($limit, $offset !== null ? $offset : 0);
        }
        $res = $this->db->query($query);
 
        $members_list = array();
        while ($rec = $this->db->fetchAssoc($res)) {
            $rec["actions"] = ilStudyProgrammeUserProgress::getPossibleActions(
                $a_prg_id,
                $rec["root_prg_id"],
                $rec["status"]
            );
            $rec['points_current'] = number_format($rec['points_current']);
            if ($rec["status"] == ilStudyProgrammeProgress::STATUS_COMPLETED) {
                //If the status completet is set by crs reference
                //use crs title
                if ($rec["completion_by_type"] == "crsr") {
                    $rec["completion_by"] = ilContainerReference::_lookupTitle($rec["completion_by_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->getInstanceForAssignment($this->prg_obj_id, $rec["assignment_id"]);
                    $rec["completion_by"] = implode(", ", $prgrs->getNamesOfCompletedOrAccreditedChildren());
                }
            } elseif ($rec["status"] == ilStudyProgrammeProgress::STATUS_ACCREDITED) {
                $rec["completion_by"] = $rec["accredited_by"];
            }
 
            $members_list[] = $rec;
        }
        return $members_list;
    }

References ilTableGUI\$limit, ilTableGUI\$offset, ilTableGUI\$order_direction, $query, $res, ilContainerReference\_lookupTitle(), getFrom(), ilStudyProgrammeUserProgress\getPossibleActions(), getWhere(), ilStudyProgrammeProgress\STATUS_ACCREDITED, and ilStudyProgrammeProgress\STATUS_COMPLETED.

Referenced by __construct().

Here is the call graph for this function:

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

    {
        $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->sp_user_progress_db->statusToRepr($a_set["status"]));
        $this->tpl->setVariable("COMPLETION_BY", $a_set["completion_by"]);
        $this->tpl->setVariable("POINTS_REQUIRED", $a_set["points"]);
 
        if (!$this->prg_has_lp_children) {
            $this->tpl->setCurrentBlock("points_current");
            $this->tpl->setVariable("POINTS_CURRENT", $a_set["points_current"]);
            $this->tpl->parseCurrentBlock();
        }
 
        $this->tpl->setVariable("CUSTOM_PLAN", $a_set["last_change_by"]
                                                ? $this->lng->txt("yes")
                                                : $this->lng->txt("no"));
        $this->tpl->setVariable("BELONGS_TO", $a_set["belongs_to"]);
        $this->tpl->setVariable("ACTIONS", $this->buildActionDropDown($a_set["actions"], $a_set["prgrs_id"], $a_set["assignment_id"]));
 
        foreach ($this->getSelectedColumns() as $column) {
            switch ($column) {
                case "prg_assign_date":
                    $this->tpl->setCurrentBlock("assign_date");
                    $this->tpl->setVariable("ASSIGN_DATE", $a_set["prg_assign_date"]);
                    $this->tpl->parseCurrentBlock("assign_date");
                    break;
                case "prg_assigned_by":
                    $this->tpl->setCurrentBlock("assigned_by");
                    $this->tpl->setVariable("ASSIGNED_BY", $a_set["prg_assigned_by"]);
                    $this->tpl->parseCurrentBlock("assigned_by");
                    break;
            }
        }
    }

References $column, buildActionDropDown(), and ilTable2GUI\getSelectedColumns().

Here is the call graph for this function:

◆ getColumnsChildren()

ilStudyProgrammeMembersTableGUI::getColumnsChildren ( )

protected

Get columns for children if it is a child.

Returns: array<string, string[]>

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

    {
        return array( "name"                            => array("name")
                        , "login"                               => array("login")
                        , "prg_status"                  => array("status")
                        , "prg_completion_by"   => array(null)
                        , "prg_points_required" => array("points")
                        , "prg_points_current"  => array("points_current")
                        , "prg_custom_plan"             => array("custom_plan")
                        , "prg_belongs_to"              => array("belongs_to")
                        );
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ getColumnsLPChildren()

ilStudyProgrammeMembersTableGUI::getColumnsLPChildren ( )

protected

Get columns for children if it is a lp child.

Returns: array<string, string[]>

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

    {
        return array( "name"                            => array("name")
                        , "login"                               => array("login")
                        , "prg_status"                  => array("status")
                        , "prg_completion_by"   => array(null)
                        , "prg_points_reachable" => array("points")
                        , "prg_custom_plan"             => array("custom_plan")
                        , "prg_belongs_to"              => array("belongs_to")
                        );
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ getFrom()

ilStudyProgrammeMembersTableGUI::getFrom ( )

protected

Get the sql part FROM.

Returns: string

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

    {
        return "  FROM " . ilStudyProgrammeProgress::returnDbTableName() . " prgrs"
                . "  JOIN usr_data pcp ON pcp.usr_id = prgrs.usr_id"
                . "  JOIN " . ilStudyProgrammeAssignment::returnDbTableName() . " ass"
                         . " ON ass.id = prgrs.assignment_id"
                . "  JOIN object_data blngs ON blngs.obj_id = ass.root_prg_id"
                . "  LEFT JOIN usr_data ass_usr ON ass_usr.usr_id = ass.last_change_by"
                . "  LEFT JOIN usr_data cmpl_usr ON cmpl_usr.usr_id = prgrs.completion_by"
                . "  LEFT JOIN object_data cmpl_obj ON cmpl_obj.obj_id = prgrs.completion_by";
    }

References ilStudyProgrammeAssignment\returnDbTableName(), and ilStudyProgrammeProgress\returnDbTableName().

Referenced by countFetchData(), and fetchData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLinkTargetForAction()

ilStudyProgrammeMembersTableGUI::getLinkTargetForAction	(	$a_action,
		$a_prgrs_id,
		$a_ass_id
	)

protected

Get ilias link for action.

Parameters

stirng	$a_actions
int	$a_prgrs_id
int	$a_ass_id

Returns: string

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

    {
        return $this->getParentObject()->getLinkTargetForAction($a_action, $a_prgrs_id, $a_ass_id);
    }

References ilTable2GUI\getParentObject().

Referenced by buildActionDropDown().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMultiCommands()

ilStudyProgrammeMembersTableGUI::getMultiCommands ( )

protected

Get possible multicommnds.

Returns: string[]

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

    {
        return array(
            'markAccreditedMulti' => $this->lng->txt('prg_multi_mark_accredited'),
            'unmarkAccreditedMulti' => $this->lng->txt('prg_multi_unmark_accredited'),
            'removeUserMulti' => $this->lng->txt('prg_multi_remove_user'),
            'markRelevantMulti' => $this->lng->txt('prg_multi_mark_relevant'),
            'markNotRelevantMulti' => $this->lng->txt('prg_multi_unmark_relevant'),
            'updateFromCurrentPlanMulti' => $this->lng->txt('prg_multi_update_from_current_plan')
        );
    }

Referenced by addMultiCommands().

Here is the caller graph for this function:

◆ getSelectableColumns()

ilStudyProgrammeMembersTableGUI::getSelectableColumns ( )

Get selectable columns.

Returns: array[] $cols

Reimplemented from ilTable2GUI.

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

    {
        // default fields
        $cols = array();
 
        $cols["prg_assign_date"] = array(
                "txt" => $this->lng->txt("prg_assign_date"));
 
        $cols["prg_assigned_by"] = array(
                "txt" => $this->lng->txt("prg_assigned_by"));
 
        return $cols;
    }

References $cols.

◆ getWhere()

ilStudyProgrammeMembersTableGUI::getWhere ( $a_prg_id )

protected

Get the sql part WHERE.

Parameters

int $a_prg_id

Returns: string

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

    {
        return " WHERE prgrs.prg_id = " . $this->db->quote($a_prg_id, "integer");
    }

Referenced by countFetchData(), and fetchData().

Here is the caller graph for this function:

Field Documentation

◆ $prg_obj_id

ilStudyProgrammeMembersTableGUI::$prg_obj_id

protected

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

◆ $prg_ref_id

ilStudyProgrammeMembersTableGUI::$prg_ref_id

protected

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

◆ $sp_user_progress_db

ilStudyProgrammeMembersTableGUI::$sp_user_progress_db

private

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

Referenced by __construct().

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

Modules/StudyProgramme/classes/class.ilStudyProgrammeMembersTableGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addMultiCommands()

◆ buildActionDropDown()

◆ countFetchData()

◆ fetchData()

◆ fillRow()

◆ getColumnsChildren()

◆ getColumnsLPChildren()

◆ getFrom()

◆ getLinkTargetForAction()

◆ getMultiCommands()

◆ getSelectableColumns()

◆ getWhere()

Field Documentation

◆ $prg_obj_id

◆ $prg_ref_id

◆ $sp_user_progress_db