ILIAS  release_8 Revision v8.24
Public Member Functions | Protected Member Functions | Protected Attributes
ilStudyProgrammeMembersTableGUI Class Reference
+ Inheritance diagram for ilStudyProgrammeMembersTableGUI:
+ Collaboration diagram for ilStudyProgrammeMembersTableGUI:

Public Member Functions

 __construct (int $prg_obj_id, int $prg_ref_id, ilObjStudyProgrammeMembersGUI $parent_obj, ilPRGPermissionsHelper $permissions, Data\Factory $data_factory, ILIAS\UI\Factory $ui_factory, ILIAS\UI\Renderer $ui_renderer, ilStudyProgrammeUserTable $prg_user_table, ilPRGAssignmentFilter $custom_filter, ilObjUser $user, string $parent_cmd='', string $template_context='')
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 initFilter ()
 
- Public Member Functions inherited from ilTable2GUI
 __construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")
 
 setOpenFormTag (bool $a_val)
 
 getOpenFormTag ()
 
 setCloseFormTag (bool $a_val)
 
 getCloseFormTag ()
 
 determineLimit ()
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 
 isColumnSelected (string $col)
 
 getSelectedColumns ()
 
 resetOffset (bool $a_in_determination=false)
 
 initFilter ()
 
 getParentObject ()
 
 getParentCmd ()
 
 setTopAnchor (string $a_val)
 
 getTopAnchor ()
 
 setNoEntriesText (string $a_text)
 
 getNoEntriesText ()
 
 setIsDataTable (bool $a_val)
 
 getIsDataTable ()
 
 setEnableTitle (bool $a_enabletitle)
 
 getEnableTitle ()
 
 setEnableHeader (bool $a_enableheader)
 
 getEnableHeader ()
 
 setEnableNumInfo (bool $a_val)
 
 getEnableNumInfo ()
 
 setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
 
 setDescription (string $a_val)
 
 getDescription ()
 
 setOrderField (string $a_order_field)
 
 getOrderField ()
 
 setData (array $a_data)
 Set table data. More...
 
 getData ()
 
 dataExists ()
 
 setPrefix (string $a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...
 
 getPrefix ()
 
 addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)
 
 addFilterItemByMetaType (string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
 Add filter by standard type. More...
 
 getFilterItems (bool $a_optionals=false)
 
 getFilterItemByPostVar (string $a_post_var)
 
 setFilterCols (int $a_val)
 
 getFilterCols ()
 
 setDisableFilterHiding (bool $a_val=true)
 
 getDisableFilterHiding ()
 
 isFilterSelected (string $a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 
 determineSelectedFilters ()
 
 setCustomPreviousNext (string $a_prev_link, string $a_next_link)
 
 setFormAction (string $a_form_action, bool $a_multipart=false)
 
 getFormAction ()
 
 setFormName (string $a_name="")
 
 getFormName ()
 get the name of the parent form More...
 
 setId (string $a_val)
 
 getId ()
 
 setDisplayAsBlock (bool $a_val)
 
 getDisplayAsBlock ()
 
 setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)
 
 setExternalSorting (bool $a_val)
 
 getExternalSorting ()
 
 setFilterCommand (string $a_val, string $a_caption="")
 
 getFilterCommand ()
 
 setResetCommand (string $a_val, string $a_caption="")
 
 getResetCommand ()
 
 setExternalSegmentation (bool $a_val)
 
 getExternalSegmentation ()
 
 setRowTemplate (string $a_template, string $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField (string $a_defaultorderfield)
 
 getDefaultOrderField ()
 
 setDefaultOrderDirection (string $a_defaultorderdirection)
 
 getDefaultOrderDirection ()
 
 setDefaultFilterVisiblity (bool $a_status)
 
 getDefaultFilterVisibility ()
 
 clearCommandButtons ()
 
 addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")
 
 addCommandButtonInstance (ilButtonBase $a_button)
 
 addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')
 
 setCloseCommand (string $a_link)
 
 addMultiCommand (string $a_cmd, string $a_text)
 
 addHiddenInput (string $a_name, string $a_value)
 
 addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")
 
 setTopCommands (bool $a_val)
 
 getTopCommands ()
 
 addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)
 
 getNavParameter ()
 
 setOrderLink (string $key, string $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder (bool $a_omit_offset=false)
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering (string $a_field)
 Should this field be sorted numeric? More...
 
 render ()
 
 writeFilterToSession ()
 
 resetFilter ()
 
 fillFooter ()
 
 getLinkbar (string $a_num)
 
 fillHiddenRow ()
 
 fillActionRow ()
 
 setHeaderHTML (string $html)
 
 storeProperty (string $type, string $value)
 
 loadProperty (string $type)
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext (string $id)
 
 getContext ()
 
 setShowRowsSelector (bool $a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 
 setShowTemplates (bool $a_value)
 
 getShowTemplates ()
 
 restoreTemplate (string $a_name)
 Restore state from template. More...
 
 saveTemplate (string $a_name)
 Save current state as template. More...
 
 deleteTemplate (string $a_name)
 
 getLimit ()
 
 getOffset ()
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode (bool $a_value=false)
 
 getPrintMode ()
 
 getExportMode ()
 
 exportData (int $format, bool $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand (bool $a_value)
 
 setRowSelectorLabel (string $row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission (bool $a_val)
 
 getPreventDoubleSubmission ()
 
 setLimit (int $a_limit=0, int $a_default_limit=0)
 set max. More...
 
- Public Member Functions inherited from ilTableGUI
 __construct (array $a_data=[], bool $a_global_tpl=true)
 
 setTemplate (ilTemplate $a_tpl)
 
 getTemplateObject ()
 
 setData (array $a_data)
 Set table data. More...
 
 getData ()
 
 setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
 
 setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")
 
 setHeaderNames (array $a_header_names)
 
 getColumnCount ()
 
 setHeaderVars (array $a_header_vars, array $a_header_params=[])
 
 setColumnWidth (array $a_column_width)
 set table column widths More...
 
 setOneColumnWidth (string $a_column_width, int $a_column_number)
 
 setMaxCount (int $a_max_count)
 set max. More...
 
 setLimit (int $a_limit=0, int $a_default_limit=0)
 set max. More...
 
 getLimit ()
 
 setPrefix (string $a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...
 
 setOffset (int $a_offset)
 set dataset offset More...
 
 getOffset ()
 
 setOrderColumn (string $a_order_column="", string $a_default_column="")
 
 getOrderColumn ()
 
 setOrderDirection (string $a_order_direction)
 
 getOrderDirection ()
 
 setFooter (string $a_style, string $a_previous="", string $a_next="")
 
 enable (string $a_module_name)
 
 disable (string $a_module_name)
 
 sortData ()
 
 render ()
 
 renderHeader ()
 
 setOrderLink (string $key, string $order_dir)
 
 setStyle (string $a_element, string $a_style)
 
 getStyle (string $a_element)
 
 setBase (string $a_base)
 
 getBase ()
 
 getFormName ()
 get the name of the parent form More...
 
 setFormName (string $a_name="cmd")
 
 getSelectAllCheckbox ()
 get the name of the checkbox that should be toggled with a select all button More...
 
 setSelectAllCheckbox (string $a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton (string $btn_name, string $btn_value)
 

Protected Member Functions

 getOrdering ()
 
 fillRow ($row)
 
 buildActionDropDown (array $actions, string $prgrs_id, int $ass_id)
 
 getLinkTargetForAction (string $action, string $prgrs_id, int $ass_id)
 
 addMultiCommands ()
 
 getMultiCommands ()
 Get possible multicommands. More...
 
 getFilterValues ()
 Get filter-values by field id. More...
 
 getPossibleActions (bool $is_root, int $status)
 Get a list with possible actions on a progress record. More...
 
 getValidUserIds ()
 
 getCompletionLink (int $reference_obj_id, string $title)
 
- Protected Member Functions inherited from ilTable2GUI
 getRequestedValues ()
 
 prepareOutput ()
 Anything that must be done before HTML is generated. More...
 
 isFilterVisible ()
 Check if filter is visible: manually shown (session, db) or default value set. More...
 
 isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, ilTableFilterItem $a_element)
 Check if filter element is based on adv md. More...
 
 fillRow (array $a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilTableFilterItem $a_item)
 Get current filter value. More...
 
 setFilterValue (ilTableFilterItem $a_item, $a_value)
 
 fillMetaExcel (ilExcel $a_excel, int &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel (ilExcel $a_excel, int &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV (ilCSVWriter $a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV (ilCSVWriter $a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV (ilCSVWriter $a_csv, array $a_set)
 CSV Version of Fill Row. More...
 

Protected Attributes

Data Factory $data_factory
 
int $prg_obj_id
 
bool $prg_has_lp_children
 
ilObjStudyProgramme $prg
 
ilPRGPermissionsHelper $permissions
 
bool $may_edit_anything
 
ilStudyProgrammeUserTable $prg_user_table
 
ilObjUser $user
 
ilPRGAssignmentFilter $custom_filter
 
ILIAS UI Factory $ui_factory
 
ILIAS UI Renderer $ui_renderer
 
- Protected Attributes inherited from ilTable2GUI
string $requested_tmpl_delete
 
string $requested_tmpl_create
 
string $requested_nav_par2 = ""
 
string $requested_nav_par = ""
 
string $requested_nav_par1 = ""
 
ILIAS Table TableGUIRequest $table_request = null
 
array $selected_columns = []
 
ilCtrl $ctrl
 
object $parent_obj = null
 
string $parent_cmd = ""
 
string $close_command = ""
 
string $top_anchor = "il_table_top"
 
array $filters = array()
 
array $optional_filters = array()
 
string $filter_cmd = 'applyFilter'
 
string $reset_cmd = 'resetFilter'
 
int $filter_cols = 5
 
bool $ext_sort = false
 
bool $ext_seg = false
 
string $context = ""
 
array $mi_sel_buttons = []
 
bool $disable_filter_hiding = false
 
bool $top_commands = true
 
array $selectable_columns = array()
 
array $selected_column = array()
 
bool $show_templates = false
 
bool $show_rows_selector = true
 
bool $rows_selector_off = false
 
bool $nav_determined = false
 
bool $limit_determined = false
 
bool $filters_determined = false
 
bool $columns_determined = false
 
bool $open_form_tag = true
 
bool $close_form_tag = true
 
array $export_formats = []
 
int $export_mode = 0
 
bool $print_mode = false
 
bool $enable_command_for_all = false
 
bool $restore_filter = false
 
array $restore_filter_values = []
 
bool $default_filter_visibility = false
 
array $sortable_fields = array()
 
bool $prevent_double_submission = true
 
string $row_selector_label = ""
 
bool $select_all_on_top = false
 
array $sel_buttons = []
 
string $nav_value = ''
 
string $noentriestext = ''
 
string $css_row = ''
 
bool $display_as_block = false
 
string $description = ''
 
string $id = ""
 
bool $custom_prev_next = false
 
string $reset_cmd_txt = ""
 
string $defaultorderfield = ""
 
string $defaultorderdirection = ""
 
array $column = []
 
bool $datatable = false
 
bool $num_info = false
 
bool $form_multipart = false
 
array $row_data = []
 
string $order_field = ""
 
array $selected_filter = []
 
string $form_action = ""
 
string $formname = ""
 
string $sort_order = ""
 
array $buttons = []
 
array $multi = []
 
array $hidden_inputs = []
 
array $header_commands = []
 
string $row_template = ""
 
string $row_template_dir = ""
 
string $filter_cmd_txt = ""
 
string $custom_prev = ""
 
string $custom_next = ""
 
array $raw_post_data = null
 
ilGlobalTemplateInterface $main_tpl
 
- Protected Attributes inherited from ilTableGUI
string $sort_order
 
string $link_params
 
array $header_params
 
 $tpl
 
ilLanguage $lng
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 
- Static Public Member Functions inherited from ilTableGUI
static linkbar (string $AScript, int $AHits, int $ALimit, int $AOffset, array $AParams=array(), array $ALayout=array(), string $prefix='')
 
- Data Fields inherited from ilTable2GUI
const FILTER_TEXT = 1
 
const FILTER_SELECT = 2
 
const FILTER_DATE = 3
 
const FILTER_LANGUAGE = 4
 
const FILTER_NUMBER_RANGE = 5
 
const FILTER_DATE_RANGE = 6
 
const FILTER_DURATION_RANGE = 7
 
const FILTER_DATETIME_RANGE = 8
 
const FILTER_CHECKBOX = 9
 
const EXPORT_EXCEL = 1
 
const EXPORT_CSV = 2
 
const ACTION_ALL_LIMIT = 1000
 
- Data Fields inherited from ilTableGUI
string $title = ""
 
string $icon = ""
 
string $icon_alt = ""
 
string $help_page = ""
 
string $help_icon = ""
 
string $help_icon_alt = ""
 
array $header_names = []
 
array $header_vars = []
 
array $linkbar_vars = []
 
array $data = []
 
int $column_count = 0
 
array $column_width = []
 
int $max_count = 0
 
int $limit = 0
 
bool $max_limit = false
 
int $offset = 0
 
string $order_column = ""
 
string $order_direction = ""
 
string $footer_style = ""
 
string $footer_previous = ""
 
string $footer_next = ""
 
bool $lang_support = true
 
bool $global_tpl = false
 
string $form_name = ""
 
string $select_all_checkbox = ""
 
array $action_buttons = []
 
string $prefix = ""
 
string $base = ""
 
array $enabled
 
array $styles
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

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

50 {
51 $this->setId("sp_member_list_" . $prg_obj_id);
52 $this->prg_obj_id = $prg_obj_id;
53 $this->prg_user_table = $prg_user_table;
54 $this->custom_filter = $custom_filter;
55 parent::__construct($parent_obj, $parent_cmd, $template_context);
56
57 $this->data_factory = $data_factory;
58 $this->ui_factory = $ui_factory;
59 $this->ui_renderer = $ui_renderer;
60 $this->permissions = $permissions;
61 $this->may_edit_anything = $this->permissions->mayAnyOf([ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN, ilOrgUnitOperation::OP_MANAGE_MEMBERS]);
62 $this->user = $user;
63
64 $this->prg = ilObjStudyProgramme::getInstanceByRefId($prg_ref_id);
65 $this->prg_has_lp_children = $parent_obj->getStudyProgramme()->hasLPChildren();
66
67 $this->setEnableTitle(true);
68 $this->setTopCommands(false);
69 $this->setEnableHeader(true);
70 $this->setExternalSorting(true);
71 $this->setExternalSegmentation(true);
72 $this->setRowTemplate("tpl.members_table_row.html", "Modules/StudyProgramme");
73 $this->setShowRowsSelector(true);
74 $this->setFormAction($this->ctrl->getFormAction($parent_obj, "view"));
75 $this->addColumn("", "", "1", true);
76 $this->setEnableAllCommand(true);
77 $this->addMultiCommands();
78 $this->setDefaultOrderField('prgrs_id');
79 $this->setDefaultOrderDirection('ASC');
80
81 if ($this->may_edit_anything) {
82 $this->setSelectAllCheckbox($parent_obj::F_SELECTED_PROGRESS_IDS . '[]');
83 }
84
85 $selected = $this->getSelectedColumns();
86 foreach ($this->prg_user_table->getColumns($prg_obj_id) as $column) {
87 [$col, $lng_var, $optional, $lp, $no_lp] = $column;
88
89 $show_by_lp = ($this->prg_has_lp_children && $lp) || (!$this->prg_has_lp_children && $no_lp);
90 $show_optional = !$optional || ($optional && array_key_exists($col, $selected));
91
92 if ($show_by_lp && $show_optional) {
93 $this->addColumn($lng_var, $col);
94 }
95 }
96
97 $this->addColumn($this->lng->txt('action'), '');
98
99 $this->initFilter();
100 $this->determineOffsetAndOrder();
101 $this->determineLimit();
102
103 $valid_user_ids = $this->getValidUserIds();
104 $filter_values = $this->getFilterValues();
105
106 $order = $this->getOrdering();
107
108 $members_list = $this->prg_user_table->fetchData(
109 $prg_obj_id,
110 $valid_user_ids,
111 $order,
112 $this->custom_filter->withValues($filter_values),
113 $this->getLimit() ? (int) $this->getLimit() : null,
114 $this->getOffset()
115 );
116
117 $count = $this->prg_user_table->countFetchData(
118 $prg_obj_id,
119 $valid_user_ids,
120 $this->custom_filter->withValues($filter_values)
121 );
122 $this->setMaxCount($count);
123
124
125 $progress_ids = array_map(
126 function ($row) {
127 return (string) $row->getId();
128 },
129 $members_list
130 );
131 $this->addHiddenInput(
132 $parent_obj::F_ALL_PROGRESS_IDS,
133 implode(',', $progress_ids)
134 );
135
136 $this->setData($members_list);
137 }
ilTable2GUI\setShowRowsSelector
setShowRowsSelector(bool $a_value)
Toggle rows-per-page selector.
Definition: class.ilTable2GUI.php:2486
ilTable2GUI\setEnableAllCommand
setEnableAllCommand(bool $a_value)
Definition: class.ilTable2GUI.php:2798
ilTable2GUI\determineOffsetAndOrder
determineOffsetAndOrder(bool $a_omit_offset=false)
Definition: class.ilTable2GUI.php:1184
ilTable2GUI\setExternalSegmentation
setExternalSegmentation(bool $a_val)
Definition: class.ilTable2GUI.php:839
ilTable2GUI\setEnableTitle
setEnableTitle(bool $a_enabletitle)
Definition: class.ilTable2GUI.php:418
ilTable2GUI\addHiddenInput
addHiddenInput(string $a_name, string $a_value)
Definition: class.ilTable2GUI.php:941
ilTable2GUI\setFormAction
setFormAction(string $a_form_action, bool $a_multipart=false)
Definition: class.ilTable2GUI.php:746
ilTable2GUI\addColumn
addColumn(string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)
Definition: class.ilTable2GUI.php:966
ilTable2GUI\setEnableHeader
setEnableHeader(bool $a_enableheader)
Definition: class.ilTable2GUI.php:428
ilTable2GUI\setDefaultOrderField
setDefaultOrderField(string $a_defaultorderfield)
Definition: class.ilTable2GUI.php:860
ilTable2GUI\setSelectAllCheckbox
setSelectAllCheckbox(string $a_select_all_checkbox, bool $a_select_all_on_top=false)
Definition: class.ilTable2GUI.php:795
ilTable2GUI\setTopCommands
setTopCommands(bool $a_val)
Definition: class.ilTable2GUI.php:956
ilTable2GUI\setExternalSorting
setExternalSorting(bool $a_val)
Definition: class.ilTable2GUI.php:803
ilTable2GUI\setRowTemplate
setRowTemplate(string $a_template, string $a_template_dir="")
Set row template.
Definition: class.ilTable2GUI.php:854
ilTable2GUI\setId
setId(string $a_val)
Definition: class.ilTable2GUI.php:769
ilTable2GUI\setDefaultOrderDirection
setDefaultOrderDirection(string $a_defaultorderdirection)
Definition: class.ilTable2GUI.php:871
ilTable2GUI\setData
setData(array $a_data)
Set table data.
Definition: class.ilTable2GUI.php:476
ilTableGUI\setMaxCount
setMaxCount(int $a_max_count)
set max.
Definition: class.ilTableGUI.php:216
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
Definition: PluginProviderHelper.php:37

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

+ Here is the call graph for this function:

Member Function Documentation

◆ addMultiCommands()

ilStudyProgrammeMembersTableGUI::addMultiCommands ( )
protected

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

334 : void
335 {
336 foreach ($this->getMultiCommands() as $cmd => $caption) {
337 $this->addMultiCommand($cmd, $caption);
338 }
339 }
ilTable2GUI\addMultiCommand
addMultiCommand(string $a_cmd, string $a_text)
Definition: class.ilTable2GUI.php:936

Referenced by __construct().

+ Here is the caller graph for this function:

◆ buildActionDropDown()

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

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

274 : string {
275 $l = new ilAdvancedSelectionListGUI();
276
277 $view_individual_plan = $this->permissions->may(ilOrgUnitOperation::OP_VIEW_INDIVIDUAL_PLAN);
278 $edit_individual_plan = $this->permissions->may(ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN);
279 $addremove_users = $this->permissions->may(ilOrgUnitOperation::OP_MANAGE_MEMBERS);
280
281 foreach ($actions as $action) {
282 switch ($action) {
283 case ilObjStudyProgrammeMembersGUI::ACTION_MARK_ACCREDITED:
284 case ilObjStudyProgrammeMembersGUI::ACTION_UNMARK_ACCREDITED:
285 case ilObjStudyProgrammeMembersGUI::ACTION_UNMARK_RELEVANT:
286 case ilObjStudyProgrammeMembersGUI::ACTION_MARK_RELEVANT:
287 case ilObjStudyProgrammeMembersGUI::ACTION_UPDATE_FROM_CURRENT_PLAN:
288 case ilObjStudyProgrammeMembersGUI::ACTION_ACKNOWLEDGE_COURSES:
289 case ilObjStudyProgrammeMembersGUI::ACTION_CHANGE_DEADLINE:
290 case ilObjStudyProgrammeMembersGUI::ACTION_CHANGE_EXPIRE_DATE:
291 if (!$edit_individual_plan) {
292 continue 2;
293 }
294 break;
295 case ilObjStudyProgrammeMembersGUI::ACTION_SHOW_INDIVIDUAL_PLAN:
296 if (!$view_individual_plan) {
297 continue 2;
298 }
299 break;
300
301 case ilObjStudyProgrammeMembersGUI::ACTION_REMOVE_USER:
302 if (!$addremove_users) {
303 continue 2;
304 }
305 break;
306 }
307
308 $target = $this->getLinkTargetForAction($action, $prgrs_id, $ass_id);
309 $l->addItem($this->lng->txt("prg_$action"), $action, $target);
310 }
311
312 return $l->getHTML();
313 }
ilAdvancedSelectionListGUI
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: class.ilAdvancedSelectionListGUI.php:26
ilStudyProgrammeMembersTableGUI\getLinkTargetForAction
getLinkTargetForAction(string $action, string $prgrs_id, int $ass_id)
Definition: class.ilStudyProgrammeMembersTableGUI.php:316

References ilObjStudyProgrammeMembersGUI\ACTION_ACKNOWLEDGE_COURSES, ilObjStudyProgrammeMembersGUI\ACTION_CHANGE_DEADLINE, ilObjStudyProgrammeMembersGUI\ACTION_CHANGE_EXPIRE_DATE, ilObjStudyProgrammeMembersGUI\ACTION_MARK_ACCREDITED, ilObjStudyProgrammeMembersGUI\ACTION_MARK_RELEVANT, ilObjStudyProgrammeMembersGUI\ACTION_REMOVE_USER, ilObjStudyProgrammeMembersGUI\ACTION_SHOW_INDIVIDUAL_PLAN, ilObjStudyProgrammeMembersGUI\ACTION_UNMARK_ACCREDITED, ilObjStudyProgrammeMembersGUI\ACTION_UNMARK_RELEVANT, ilObjStudyProgrammeMembersGUI\ACTION_UPDATE_FROM_CURRENT_PLAN, getLinkTargetForAction(), and ILIAS\Repository\lng().

Referenced by fillRow().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillRow()

ilStudyProgrammeMembersTableGUI::fillRow (   $row)
protected

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

154 : void
155 {
156 if (!$row instanceof ilStudyProgrammeUserTableRow) {
157 throw new \Exception("use ilStudyProgrammeUserTableRow for data output", 1);
158 }
159
160 if ($this->may_edit_anything) {
161 $this->tpl->setCurrentBlock("checkb");
162 $this->tpl->setVariable("ID", (string) $row->getId());
163 $this->tpl->parseCurrentBlock();
164 }
165
166 if (!$row->isUserActiveRaw()) {
167 $this->tpl->setCurrentBlock('access_warning');
168 $this->tpl->setVariable('PARENT_ACCESS', $this->lng->txt('usr_account_inactive'));
169 $this->tpl->parseCurrentBlock();
170 }
171
172 $this->tpl->setVariable("FIRSTNAME", $row->getFirstname());
173 $this->tpl->setVariable("LASTNAME", $row->getLastname());
174 $this->tpl->setVariable("LOGIN", $row->getLogin());
175 $this->tpl->setVariable("STATUS", $row->getStatus());
176 $this->tpl->setVariable("ASSIGN_DATE", $row->getAssignmentDate());
177 $this->tpl->setVariable("POINTS_REQUIRED", $row->getPointsRequired());
178
179 if (!$this->prg_has_lp_children) {
180 $this->tpl->setCurrentBlock("points_current");
181 $this->tpl->setVariable("POINTS_CURRENT", $row->getPointsCurrent());
182 $this->tpl->parseCurrentBlock();
183 }
184
185 foreach ($this->getSelectedColumns() as $column) {
186 switch ($column) {
187 case "prg_orgus":
188 $this->tpl->setVariable("ORGUS", $row->getOrgUs());
189 break;
190 case "prg_completion_date":
191 $this->tpl->setVariable("COMPLETION_DATE", $row->getCompletionDate());
192 break;
193 case "prg_completion_by":
194
195 $completion_by = $row->getCompletionBy();
196 if ($completion_by_obj_ids = $row->getCompletionByObjIds()) {
197 $out = [];
198 foreach ($completion_by_obj_ids as $completion_by_obj_id) {
199 $type = ilObject::_lookupType($completion_by_obj_id);
200 if ($type === 'crs') {
201 $out[] = $this->getCompletionLink($completion_by_obj_id, $completion_by);
202 } else {
203 $target_obj_id = $completion_by_obj_id;
204 $out[] = $this->getCompletionLink(
205 $target_obj_id,
206 ilStudyProgrammeUserTable::lookupTitle($completion_by_obj_id)
207 );
208 }
209 }
210 $completion_by = implode(', ', $out);
211 }
212 $this->tpl->setVariable("COMPLETION_BY", $completion_by);
213 break;
214 case "prg_custom_plan":
215 $this->tpl->setVariable("CUSTOM_PLAN", $row->getCustomPlan());
216 break;
217 case "prg_belongs_to":
218 $this->tpl->setVariable("BELONGS_TO", $row->getBelongsTo());
219 break;
220 case "prg_expiry_date":
221 $this->tpl->setVariable("EXPIRY_DATE", $row->getExpiryDate());
222 break;
223 case "prg_assigned_by":
224 $this->tpl->setVariable("ASSIGNED_BY", $row->getAssignmentBy());
225 break;
226 case "prg_deadline":
227 $this->tpl->setVariable("DEADLINE", $row->getDeadline());
228 break;
229 case "prg_validity":
230 $this->tpl->setVariable("VALIDITY", $row->getValidity());
231 break;
232 case 'org_units':
233 $this->tpl->setCurrentBlock('udf');
234 $this->tpl->setVariable("UDF", $row->getOrgUs());
235 $this->tpl->parseCurrentBlock();
236 break;
237 case 'gender':
238 $this->tpl->setCurrentBlock('udf');
239 $this->tpl->setVariable("UDF", $row->getGender());
240 $this->tpl->parseCurrentBlock();
241 break;
242
243 case strpos($column, 'udf_') === 0:
244 $id = str_replace('udf_', 'f_', $column);
245 $this->tpl->setCurrentBlock('udf');
246 $this->tpl->setVariable("UDF", $row->getUDF($id));
247 $this->tpl->parseCurrentBlock();
248 break;
249 default:
250 $this->tpl->setCurrentBlock('udf');
251 $this->tpl->setVariable("UDF", $row->getUDF($column));
252 $this->tpl->parseCurrentBlock();
253 }
254 }
255 $actions = $this->getPossibleActions(
256 $row->isRootProgress(),
257 $row->getStatusRaw()
258 );
259
260 $this->tpl->setVariable(
261 "ACTIONS",
262 $this->buildActionDropDown(
263 $actions,
264 (string) $row->getId(),
265 $row->getAssignmentId()
266 )
267 );
268 }
$out
$out
Definition: buildRTE.php:24
ilObject\_lookupType
static _lookupType(int $id, bool $reference=false)
Definition: class.ilObject.php:1091
ilStudyProgrammeMembersTableGUI\getPossibleActions
getPossibleActions(bool $is_root, int $status)
Get a list with possible actions on a progress record.
Definition: class.ilStudyProgrammeMembersTableGUI.php:409
ilStudyProgrammeMembersTableGUI\getCompletionLink
getCompletionLink(int $reference_obj_id, string $title)
Definition: class.ilStudyProgrammeMembersTableGUI.php:447
ilStudyProgrammeMembersTableGUI\buildActionDropDown
buildActionDropDown(array $actions, string $prgrs_id, int $ass_id)
Definition: class.ilStudyProgrammeMembersTableGUI.php:270
ilStudyProgrammeUserTableRow
ilStudyProgrammeUserTable provides a flattened list of progresses at a programme-node.
Definition: ilStudyProgrammeUserTableRow.php:27
$type
$type
Definition: proxy_ylocal.php:10

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

+ Here is the call graph for this function:

◆ getCompletionLink()

ilStudyProgrammeMembersTableGUI::getCompletionLink ( int  $reference_obj_id,
string  $title 
)
protected

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

447 : string
448 {
449 $link = $title;
450 $target_obj_id = ilContainerReference::_lookupTargetId($reference_obj_id);
451 $ref_ids = ilObject::_getAllReferences($target_obj_id);
452 foreach ($ref_ids as $ref_id) {
453 if (!ilObject::_isInTrash($ref_id)) {
454 $url = ilLink::_getStaticLink($ref_id, "crs");
455 $link = $this->ui_renderer->render($this->ui_factory->link()->standard($title, $url));
456 }
457 }
458 return $link;
459 }
ilContainerReference\_lookupTargetId
static _lookupTargetId(int $a_obj_id)
Definition: class.ilContainerReference.php:44
ilObject\_getAllReferences
static _getAllReferences(int $id)
get all reference ids for object ID
Definition: class.ilObject.php:816
ilObject\_isInTrash
static _isInTrash(int $ref_id)
Definition: class.ilObject.php:1102
$ref_id
$ref_id
Definition: ltiauth.php:67
$url
$url
Definition: proxy_ylocal.php:28

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

Referenced by fillRow().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getFilterValues()

ilStudyProgrammeMembersTableGUI::getFilterValues ( )
protected

Get filter-values by field id.

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

394 : array
395 {
396 $this->getCurrentState();
397 $f = [];
398 foreach ($this->filters as $item) {
399 $f[$item->getFieldId()] = $this->getFilterValue($item);
400 }
401 return $f;
402 }
ilTable2GUI\getCurrentState
getCurrentState()
get current settings for order, limit, columns and filter
Definition: class.ilTable2GUI.php:2402
ilTable2GUI\getFilterValue
getFilterValue(ilTableFilterItem $a_item)
Get current filter value.
Definition: class.ilTable2GUI.php:2443

References Vendor\Package\$f.

Referenced by __construct().

+ Here is the caller graph for this function:

◆ getLinkTargetForAction()

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

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

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

Referenced by buildActionDropDown().

+ Here is the caller graph for this function:

◆ getMultiCommands()

ilStudyProgrammeMembersTableGUI::getMultiCommands ( )
protected

Get possible multicommands.

Returns
string[]

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

346 : array
347 {
348 $permissions_for_edit_individual_plan = [
349 'updateFromCurrentPlanMulti' => $this->lng->txt('prg_multi_update_from_current_plan'),
350 'acknowledgeCoursesMulti' => $this->lng->txt('prg_acknowledge_completed_courses'),
351 'markRelevantMulti' => $this->lng->txt('prg_multi_mark_relevant'),
352 'markNotRelevantMulti' => $this->lng->txt('prg_multi_unmark_relevant'),
353 'changeDeadlineMulti' => $this->lng->txt('prg_multi_change_deadline'),
354 'changeExpireDateMulti' => $this->lng->txt('prg_multi_change_expire_date'),
355 'markAccreditedMulti' => $this->lng->txt('prg_multi_mark_accredited'),
356 'unmarkAccreditedMulti' => $this->lng->txt('prg_multi_unmark_accredited')
357 ];
358
359 $permissions_for_manage = [
360 'removeUserMulti' => $this->lng->txt('prg_multi_remove_user'),
361 'mailUserMulti' => $this->lng->txt('prg_multi_mail_user')
362 ];
363
364 $perms = [];
365
366 if ($this->permissions->may(ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN)) {
367 $perms = array_merge($perms, $permissions_for_edit_individual_plan);
368 }
369
370 if ($this->permissions->may(ilOrgUnitOperation::OP_MANAGE_MEMBERS)) {
371 $perms = array_merge($perms, $permissions_for_manage);
372 }
373
374 return $perms;
375 }

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

+ Here is the call graph for this function:

◆ getOrdering()

ilStudyProgrammeMembersTableGUI::getOrdering ( )
protected

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

139 : Data\Order
140 {
141 $field = $this->getOrderField();
142 if (!$field) {
143 $field = $this->getDefaultOrderField();
144 }
145 $direction = $this->getOrderDirection();
146 if (!$direction) {
147 $direction = $this->getDefaultOrderDirection();
148 }
149
150 return $this->data_factory->order($field, strtoupper($direction));
151 }

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

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getPossibleActions()

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

Get a list with possible actions on a progress record.

Returns
string[]

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

412 : array {
413 $actions = [];
414
415 if ($is_root) {
416 $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_SHOW_INDIVIDUAL_PLAN;
417 $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_REMOVE_USER;
418 $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_UNMARK_RELEVANT;
419 $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_MARK_RELEVANT;
420 $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_UPDATE_FROM_CURRENT_PLAN;
421 $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_ACKNOWLEDGE_COURSES;
422 $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_CHANGE_DEADLINE;
423 $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_CHANGE_EXPIRE_DATE;
424 }
425
426 if ($status == ilPRGProgress::STATUS_ACCREDITED) {
427 $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_UNMARK_ACCREDITED;
428 }
429 if ($status == ilPRGProgress::STATUS_IN_PROGRESS) {
430 $actions[] = ilObjStudyProgrammeMembersGUI::ACTION_MARK_ACCREDITED;
431 }
432
433 return $actions;
434 }

References ilObjStudyProgrammeMembersGUI\ACTION_ACKNOWLEDGE_COURSES, ilObjStudyProgrammeMembersGUI\ACTION_CHANGE_DEADLINE, ilObjStudyProgrammeMembersGUI\ACTION_CHANGE_EXPIRE_DATE, ilObjStudyProgrammeMembersGUI\ACTION_MARK_RELEVANT, ilObjStudyProgrammeMembersGUI\ACTION_REMOVE_USER, ilObjStudyProgrammeMembersGUI\ACTION_SHOW_INDIVIDUAL_PLAN, ilObjStudyProgrammeMembersGUI\ACTION_UNMARK_RELEVANT, and ilObjStudyProgrammeMembersGUI\ACTION_UPDATE_FROM_CURRENT_PLAN.

Referenced by fillRow().

+ Here is the caller graph for this function:

◆ getSelectableColumns()

ilStudyProgrammeMembersTableGUI::getSelectableColumns ( )

Get selectable columns.

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

Reimplemented from ilTable2GUI.

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

321 : array
322 {
323 $cols = [];
324 foreach ($this->prg_user_table->getColumns($this->prg_obj_id) as $column) {
325 [$col, $lng_var, $optional, $lp, $no_lp] = $column;
326 if ($optional) {
327 $cols[$col] = ["txt" => $lng_var];
328 }
329 }
330
331 return $cols;
332 }
$cols
$cols
Definition: xhr_table.php:11

References $cols.

◆ getValidUserIds()

ilStudyProgrammeMembersTableGUI::getValidUserIds ( )
protected

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

436 : ?array
437 {
438 if ($this->permissions->may($this->permissions::ROLEPERM_MANAGE_MEMBERS)) {
439 return null;
440 }
441
442 $valid_user_ids = $this->permissions->getUserIdsSusceptibleTo(ilOrgUnitOperation::OP_VIEW_MEMBERS);
443 array_unshift($valid_user_ids, $this->user->getId());
444 return $valid_user_ids;
445 }

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

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initFilter()

ilStudyProgrammeMembersTableGUI::initFilter ( )

Reimplemented from ilTable2GUI.

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

380 : void
381 {
382 foreach ($this->custom_filter->getItemConfig() as $conf) {
383 [$id, $type, $options, $caption] = $conf;
384 $item = $this->addFilterItemByMetaType($id, $type, false, $caption);
385 if ($options) {
386 $item->setOptions($options);
387 }
388 }
389 }
ilTable2GUI\addFilterItemByMetaType
addFilterItemByMetaType(string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
Add filter by standard type.
Definition: class.ilTable2GUI.php:527

References $id, and $type.

Referenced by __construct().

+ Here is the caller graph for this function:

Field Documentation

◆ $custom_filter

ilPRGAssignmentFilter ilStudyProgrammeMembersTableGUI::$custom_filter
protected

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

Referenced by __construct().

◆ $data_factory

Data Factory ilStudyProgrammeMembersTableGUI::$data_factory
protected

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

Referenced by __construct().

◆ $may_edit_anything

bool ilStudyProgrammeMembersTableGUI::$may_edit_anything
protected

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

◆ $permissions

ilPRGPermissionsHelper ilStudyProgrammeMembersTableGUI::$permissions
protected

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

Referenced by __construct().

◆ $prg

ilObjStudyProgramme ilStudyProgrammeMembersTableGUI::$prg
protected

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

◆ $prg_has_lp_children

bool ilStudyProgrammeMembersTableGUI::$prg_has_lp_children
protected

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

◆ $prg_obj_id

int ilStudyProgrammeMembersTableGUI::$prg_obj_id
protected

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

Referenced by __construct().

◆ $prg_user_table

ilStudyProgrammeUserTable ilStudyProgrammeMembersTableGUI::$prg_user_table
protected

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

Referenced by __construct().

◆ $ui_factory

ILIAS UI Factory ilStudyProgrammeMembersTableGUI::$ui_factory
protected

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

Referenced by __construct().

◆ $ui_renderer

ILIAS UI Renderer ilStudyProgrammeMembersTableGUI::$ui_renderer
protected

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

Referenced by __construct().

◆ $user

ilObjUser ilStudyProgrammeMembersTableGUI::$user
protected

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

Referenced by __construct().

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