ILIAS  trunk Revision v11.0_alpha-2638-g80c1d007f79
ilStudyProgrammeMembersTableGUI Class Reference
+ Inheritance diagram for ilStudyProgrammeMembersTableGUI:
+ Collaboration diagram for ilStudyProgrammeMembersTableGUI:

Public Member Functions

 __construct (int $prg_obj_id, protected int $prg_ref_id, ilObjStudyProgrammeMembersGUI $parent_obj, ilPRGPermissionsHelper $permissions, Data\Factory $data_factory, ILIAS\UI\Factory $ui_factory, ILIAS\UI\Renderer $ui_renderer, ilStudyProgrammeUserTable $prg_user_table, ilPRGAssignmentFilter $custom_filter, ilObjUser $user, string $parent_cmd='', string $template_context='')
 
 getSelectableColumns ()
 
 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)
 
 getData ()
 
 dataExists ()
 
 setPrefix (string $a_prefix)
 
 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 ()
 
 setId (string $a_val)
 
 getId ()
 
 setDisplayAsBlock (bool $a_val)
 
 getDisplayAsBlock ()
 
 setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)
 
 setExternalSorting (bool $a_val)
 
 getExternalSorting ()
 
 setFilterCommand (string $a_val, string $a_caption="")
 
 getFilterCommand ()
 
 setResetCommand (string $a_val, string $a_caption="")
 
 getResetCommand ()
 
 setExternalSegmentation (bool $a_val)
 
 getExternalSegmentation ()
 
 setRowTemplate (string $a_template, string $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField (string $a_defaultorderfield)
 
 getDefaultOrderField ()
 
 setDefaultOrderDirection (string $a_defaultorderdirection)
 
 getDefaultOrderDirection ()
 
 setDefaultFilterVisiblity (bool $a_status)
 
 getDefaultFilterVisibility ()
 
 clearCommandButtons ()
 
 addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")
 
 addCommandButtonInstance (ilButtonBase $a_button)
 
 addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')
 
 setCloseCommand (string $a_link)
 
 addMultiCommand (string $a_cmd, string $a_text)
 
 addHiddenInput (string $a_name, string $a_value)
 
 addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")
 
 setTopCommands (bool $a_val)
 
 getTopCommands ()
 
 addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)
 
 getNavParameter ()
 
 setOrderLink (string $key, string $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder (bool $a_omit_offset=false)
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering (string $a_field)
 Should this field be sorted numeric? More...
 
 render ()
 
 writeFilterToSession ()
 
 resetFilter ()
 
 fillFooter ()
 
 getLinkbar (string $a_num)
 
 fillHiddenRow ()
 
 fillActionRow ()
 
 setHeaderHTML (string $html)
 
 storeProperty (string $type, string $value)
 
 loadProperty (string $type)
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext (string $id)
 
 getContext ()
 
 setShowRowsSelector (bool $a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 
 getLimit ()
 
 getOffset ()
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode (bool $a_value=false)
 
 getPrintMode ()
 
 getExportMode ()
 
 exportData (int $format, bool $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand (bool $a_value)
 
 setRowSelectorLabel (string $row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission (bool $a_val)
 
 getPreventDoubleSubmission ()
 
 setLimit (int $a_limit=0, int $a_default_limit=0)
 
- Public Member Functions inherited from ilTableGUI
 __construct (array $a_data=[], bool $a_global_tpl=true)
 
 setTemplate (ilTemplate $a_tpl)
 
 getTemplateObject ()
 
 setData (array $a_data)
 Set table data. More...
 
 getData ()
 
 setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
 
 setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")
 
 setHeaderNames (array $a_header_names)
 
 getColumnCount ()
 
 setHeaderVars (array $a_header_vars, array $a_header_params=[])
 
 setColumnWidth (array $a_column_width)
 set table column widths More...
 
 setOneColumnWidth (string $a_column_width, int $a_column_number)
 
 setMaxCount (int $a_max_count)
 set max. More...
 
 setLimit (int $a_limit=0, int $a_default_limit=0)
 set max. More...
 
 getLimit ()
 
 setPrefix (string $a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...
 
 setOffset (int $a_offset)
 set dataset offset More...
 
 getOffset ()
 
 setOrderColumn (string $a_order_column="", string $a_default_column="")
 
 getOrderColumn ()
 
 setOrderDirection (string $a_order_direction)
 
 getOrderDirection ()
 
 setFooter (string $a_style, string $a_previous="", string $a_next="")
 
 enable (string $a_module_name)
 
 disable (string $a_module_name)
 
 sortData ()
 
 render ()
 
 renderHeader ()
 
 setOrderLink (string $key, string $order_dir)
 
 setStyle (string $a_element, string $a_style)
 
 getStyle (string $a_element)
 
 setBase (string $a_base)
 
 getBase ()
 
 getFormName ()
 get the name of the parent form More...
 
 setFormName (string $a_name="cmd")
 
 getSelectAllCheckbox ()
 get the name of the checkbox that should be toggled with a select all button More...
 
 setSelectAllCheckbox (string $a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton (string $btn_name, string $btn_value)
 

Protected Member Functions

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

Protected Attributes

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

Additional Inherited Members

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

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References ilTable2GUI\$column, $custom_filter, $data_factory, ilTable2GUI\$parent_cmd, $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(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), getOrdering(), ilTable2GUI\getSelectedColumns(), ilObjStudyProgrammeMembersGUI\getStudyProgramme(), getValidUserIds(), initFilter(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilPRGPermissionsHelper\mayAnyOf(), null, 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().

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 
56  $this->data_factory = $data_factory;
57  $this->ui_factory = $ui_factory;
58  $this->ui_renderer = $ui_renderer;
59  $this->permissions = $permissions;
60  $this->may_edit_anything = $this->permissions->mayAnyOf([ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN, ilOrgUnitOperation::OP_MANAGE_MEMBERS]);
61  $this->user = $user;
62 
63  $this->prg = ilObjStudyProgramme::getInstanceByRefId($prg_ref_id);
64  $this->prg_has_lp_children = $parent_obj->getStudyProgramme()->hasLPChildren();
65 
66  parent::__construct($parent_obj, $parent_cmd, $template_context);
67 
68  $this->setEnableTitle(true);
69  $this->setTopCommands(false);
70  $this->setEnableHeader(true);
71  $this->setExternalSorting(true);
72  $this->setExternalSegmentation(true);
73  $this->setRowTemplate("tpl.members_table_row.html", "components/ILIAS/StudyProgramme");
74  $this->setShowRowsSelector(true);
75  $this->setFormAction($this->ctrl->getFormAction($parent_obj, "view"));
76  $this->addColumn("", "", "1", true);
77  $this->setEnableAllCommand(true);
78  $this->addMultiCommands();
79  $this->setDefaultOrderField('prgrs_id');
80  $this->setDefaultOrderDirection('ASC');
81 
82  if ($this->may_edit_anything) {
83  $this->setSelectAllCheckbox($parent_obj::F_SELECTED_PROGRESS_IDS . '[]');
84  }
85 
86  $selected = $this->getSelectedColumns();
87  foreach ($this->prg_user_table->getColumns($prg_obj_id, false, $this->prg->isCertificateActive()) as $column) {
88  [$col, $lng_var, $optional, $lp, $no_lp] = $column;
89 
90  $show_by_lp = ($this->prg_has_lp_children && $lp) || (!$this->prg_has_lp_children && $no_lp);
91  $show_optional = !$optional || ($optional && array_key_exists($col, $selected));
92 
93  if ($show_by_lp && $show_optional) {
94  $this->addColumn($lng_var, $col);
95  }
96  }
97 
98  $this->addColumn($this->lng->txt('action'), '');
99 
100  $this->initFilter();
101  $this->determineOffsetAndOrder();
102  $this->determineLimit();
103 
104  $valid_user_ids = $this->getValidUserIds();
105  $filter_values = $this->getFilterValues();
106 
107  $order = $this->getOrdering();
108 
109  $members_list = $this->prg_user_table->fetchData(
110  $prg_obj_id,
111  $valid_user_ids,
112  $order,
113  $this->custom_filter->withValues($filter_values),
114  $this->getLimit() ? (int) $this->getLimit() : null,
115  $this->getOffset()
116  );
117 
118  $count = $this->prg_user_table->countFetchData(
119  $prg_obj_id,
120  $valid_user_ids,
121  $this->custom_filter->withValues($filter_values)
122  );
123  $this->setMaxCount($count);
124 
125 
126  $progress_ids = array_map(
127  function ($row) {
128  return (string) $row->getId();
129  },
130  $members_list
131  );
132  $this->addHiddenInput(
133  $parent_obj::F_ALL_PROGRESS_IDS,
134  implode(',', $progress_ids)
135  );
136 
137  $this->setData($members_list);
138  }
setData(array $a_data)
setTopCommands(bool $a_val)
setFormAction(string $a_form_action, bool $a_multipart=false)
setEnableTitle(bool $a_enabletitle)
setSelectAllCheckbox(string $a_select_all_checkbox, bool $a_select_all_on_top=false)
setId(string $a_val)
while($session_entry=$r->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) return null
setExternalSorting(bool $a_val)
setShowRowsSelector(bool $a_value)
Toggle rows-per-page selector.
addHiddenInput(string $a_name, string $a_value)
setDefaultOrderField(string $a_defaultorderfield)
setRowTemplate(string $a_template, string $a_template_dir="")
Set row template.
setDefaultOrderDirection(string $a_defaultorderdirection)
setEnableAllCommand(bool $a_value)
getStudyProgramme(?int $ref_id=null)
Get studyprogramm object for ref_id Use this ref_id if argument is null.
__construct(Container $dic, ilPlugin $plugin)
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)
determineOffsetAndOrder(bool $a_omit_offset=false)
setEnableHeader(bool $a_enableheader)
setMaxCount(int $a_max_count)
set max.
setExternalSegmentation(bool $a_val)
+ Here is the call graph for this function:

Member Function Documentation

◆ addMultiCommands()

ilStudyProgrammeMembersTableGUI::addMultiCommands ( )
protected

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

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

Referenced by __construct().

341  : void
342  {
343  foreach ($this->getMultiCommands() as $cmd => $caption) {
344  $this->addMultiCommand($cmd, $caption);
345  }
346  }
addMultiCommand(string $a_cmd, string $a_text)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ buildActionDropDown()

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

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

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_CERTIFICATE, ilObjStudyProgrammeMembersGUI\ACTION_REMOVE_USER, ilObjStudyProgrammeMembersGUI\ACTION_SHOW_INDIVIDUAL_PLAN, ilObjStudyProgrammeMembersGUI\ACTION_UNMARK_ACCREDITED, ilObjStudyProgrammeMembersGUI\ACTION_UNMARK_RELEVANT, ilObjStudyProgrammeMembersGUI\ACTION_UPDATE_CERTIFICATE, ilObjStudyProgrammeMembersGUI\ACTION_UPDATE_FROM_CURRENT_PLAN, getLinkTargetForAction(), ILIAS\Repository\lng(), ilOrgUnitOperation\OP_EDIT_INDIVIDUAL_PLAN, ilOrgUnitOperation\OP_MANAGE_MEMBERS, and ilOrgUnitOperation\OP_VIEW_INDIVIDUAL_PLAN.

Referenced by fillRow().

276  : string {
277  $l = [];
278 
279  $view_individual_plan = $this->permissions->may(ilOrgUnitOperation::OP_VIEW_INDIVIDUAL_PLAN);
280  $edit_individual_plan = $this->permissions->may(ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN);
281  $addremove_users = $this->permissions->may(ilOrgUnitOperation::OP_MANAGE_MEMBERS);
282 
283  foreach ($actions as $action) {
284  switch ($action) {
295 
296  if (!$edit_individual_plan) {
297  continue 2;
298  }
299  break;
301  if (!$view_individual_plan) {
302  continue 2;
303  }
304  break;
305 
307  if (!$addremove_users) {
308  continue 2;
309  }
310  break;
311  }
312 
313  $target = $this->getLinkTargetForAction($action, $prgrs_id, $ass_id);
314  $l[] = $this->ui_factory->button()->shy($this->lng->txt("prg_$action"), $target);
315  }
316  return $this->ui_renderer->render(
317  $this->ui_factory->dropdown()->standard($l)
318  );
319  }
getLinkTargetForAction(string $action, string $prgrs_id, int $ass_id)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillRow()

ilStudyProgrammeMembersTableGUI::fillRow (   $row)
protected

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

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

155  : void
156  {
157  if (!$row instanceof ilStudyProgrammeUserTableRow) {
158  throw new \Exception("use ilStudyProgrammeUserTableRow for data output", 1);
159  }
160 
161  if ($this->may_edit_anything) {
162  $this->tpl->setCurrentBlock("checkb");
163  $this->tpl->setVariable("ID", (string) $row->getId());
164  $this->tpl->parseCurrentBlock();
165  }
166 
167  if (!$row->isUserActiveRaw()) {
168  $this->tpl->setCurrentBlock('access_warning');
169  $this->tpl->setVariable('PARENT_ACCESS', $this->lng->txt('usr_account_inactive'));
170  $this->tpl->parseCurrentBlock();
171  }
172 
173  $this->tpl->setVariable("FIRSTNAME", $row->getFirstname());
174  $this->tpl->setVariable("LASTNAME", $row->getLastname());
175  $this->tpl->setVariable("LOGIN", $row->getLogin());
176  $this->tpl->setVariable("STATUS", $row->getStatus());
177  $this->tpl->setVariable("ASSIGN_DATE", $row->getAssignmentDate());
178  $this->tpl->setVariable("POINTS_REQUIRED", $row->getPointsRequired());
179 
180  if (!$this->prg_has_lp_children) {
181  $this->tpl->setCurrentBlock("points_current");
182  $this->tpl->setVariable("POINTS_CURRENT", $row->getPointsCurrent());
183  $this->tpl->parseCurrentBlock();
184  }
185 
186  foreach ($this->getSelectedColumns() as $column) {
187  switch ($column) {
188  case "prg_orgus":
189  $this->tpl->setVariable("ORGUS", $row->getOrgUs());
190  break;
191  case "prg_completion_date":
192  $this->tpl->setVariable("COMPLETION_DATE", $row->getCompletionDate());
193  break;
194  case "prg_completion_by":
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  case 'cert_relevance':
243  $cert = '';
244  if ($row->getCertificateRelevance()) {
245  $cert = $this->getCertificateLink($row->getUsrId());
246  }
247  $this->tpl->setVariable("CERT_RELEVANCE", $cert);
248  break;
249  default:
250  $value = $row->getUserInformation()->getUserData($column) ?? '';
251  $this->tpl->setCurrentBlock('udf');
252  $this->tpl->setVariable("UDF", $value);
253  $this->tpl->parseCurrentBlock();
254  }
255  }
256  $actions = $this->getPossibleActions(
257  $row->isRootProgress(),
258  $row->getStatusRaw(),
259  $row->getNodeLifecycleStatus()
260  );
261 
262  $this->tpl->setVariable(
263  "ACTIONS",
264  $this->buildActionDropDown(
265  $actions,
266  (string) $row->getId(),
267  $row->getAssignmentId()
268  )
269  );
270  }
ilStudyProgrammeUserTable provides a flattened list of progresses at a programme-node.
getPossibleActions(bool $is_root, int $status, int $node_lifecyle_status)
Get a list with possible actions on a progress record.
buildActionDropDown(array $actions, string $prgrs_id, int $ass_id)
$out
Definition: buildRTE.php:24
getCompletionLink(int $target_obj_id, string $title)
static _lookupType(int $id, bool $reference=false)
+ Here is the call graph for this function:

◆ getCertificateLink()

ilStudyProgrammeMembersTableGUI::getCertificateLink ( int  $usr_id)
protected

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

References ilTableGUI\$icon, ILIAS\Repository\ctrl(), and null.

Referenced by fillRow().

490  : string
491  {
492  $this->ctrl->setParameter($this->parent_obj, 'cert_usr_id', $usr_id);
493  $cert_url = $this->ctrl->getLinkTarget($this->parent_obj, 'deliverCertificate');
494  $this->ctrl->setParameter($this->parent_obj, 'cert_usr_id', null);
495  $icon = $this->ui_renderer->render(
496  $this->ui_factory->symbol()->icon()->standard('cert', 'relevant', 'small')
497  );
498  $link = $this->ui_factory->link()->standard($icon, $cert_url);
499  return $this->ui_renderer->render($link);
500  }
while($session_entry=$r->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) return null
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getCompletionLink()

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

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

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

Referenced by fillRow().

477  : string
478  {
479  $link = $title;
480  $ref_ids = ilObject::_getAllReferences($target_obj_id);
481  foreach ($ref_ids as $ref_id) {
482  if (!ilObject::_isInTrash($ref_id)) {
483  $url = ilLink::_getStaticLink($ref_id, "crs");
484  $link = $this->ui_renderer->render($this->ui_factory->link()->standard($title, $url));
485  }
486  }
487  return $link;
488  }
static _getAllReferences(int $id)
get all reference ids for object ID
$url
Definition: shib_logout.php:68
$ref_id
Definition: ltiauth.php:65
static _isInTrash(int $ref_id)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getFilterValues()

ilStudyProgrammeMembersTableGUI::getFilterValues ( )
protected

Get filter-values by field id.

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

References Vendor\Package\$f, ilTable2GUI\getCurrentState(), and ilTable2GUI\getFilterValue().

Referenced by __construct().

405  : array
406  {
407  $this->getCurrentState();
408  $f = [];
409  foreach ($this->filters as $item) {
410  $f[$item->getFieldId()] = $this->getFilterValue($item);
411  }
412  return $f;
413  }
getFilterValue(ilTableFilterItem $a_item)
Get current filter value.
getCurrentState()
get current settings for order, limit, columns and filter
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getLinkTargetForAction()

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

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

References ilTable2GUI\getParentObject().

Referenced by buildActionDropDown().

322  : string
323  {
324  return $this->getParentObject()->getLinkTargetForAction($action, $prgrs_id, $ass_id);
325  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMultiCommands()

ilStudyProgrammeMembersTableGUI::getMultiCommands ( )
protected

Get possible multicommands.

Returns
string[]

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

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

Referenced by addMultiCommands().

353  : array
354  {
355  $permissions_for_edit_individual_plan = [
356  'updateFromCurrentPlanMulti' => $this->lng->txt('prg_multi_update_from_current_plan'),
357  'acknowledgeCoursesMulti' => $this->lng->txt('prg_acknowledge_completed_courses'),
358  'markRelevantMulti' => $this->lng->txt('prg_multi_mark_relevant'),
359  'markNotRelevantMulti' => $this->lng->txt('prg_multi_unmark_relevant'),
360  'changeDeadlineMulti' => $this->lng->txt('prg_multi_change_deadline'),
361  'changeExpireDateMulti' => $this->lng->txt('prg_multi_change_expire_date'),
362  'markAccreditedMulti' => $this->lng->txt('prg_multi_mark_accredited'),
363  'unmarkAccreditedMulti' => $this->lng->txt('prg_multi_unmark_accredited'),
364  ];
365  if ($this->prg->isCertificateActive()) {
366  $permissions_for_edit_individual_plan['updateCertificateMulti'] = $this->lng->txt('prg_multi_update_certificate');
367  $permissions_for_edit_individual_plan['removeCertificateMulti'] = $this->lng->txt('prg_multi_remove_certificate');
368  }
369 
370  $permissions_for_manage = [
371  'removeUserMulti' => $this->lng->txt('prg_multi_remove_user'),
372  'mailUserMulti' => $this->lng->txt('prg_multi_mail_user')
373  ];
374 
375  $perms = [];
376 
377  if ($this->permissions->may(ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN)) {
378  $perms = array_merge($perms, $permissions_for_edit_individual_plan);
379  }
380 
381  if ($this->permissions->may(ilOrgUnitOperation::OP_MANAGE_MEMBERS)) {
382  $perms = array_merge($perms, $permissions_for_manage);
383  }
384 
385  return $perms;
386  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getOrdering()

ilStudyProgrammeMembersTableGUI::getOrdering ( )
protected

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

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

Referenced by __construct().

140  : Data\Order
141  {
142  $field = $this->getOrderField();
143  if (!$field) {
144  $field = $this->getDefaultOrderField();
145  }
146  $direction = $this->getOrderDirection();
147  if (!$direction) {
148  $direction = $this->getDefaultOrderDirection();
149  }
150 
151  return $this->data_factory->order($field, strtoupper($direction));
152  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getPossibleActions()

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

Get a list with possible actions on a progress record.

Returns
string[]

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

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_CERTIFICATE, ilObjStudyProgrammeMembersGUI\ACTION_REMOVE_USER, ilObjStudyProgrammeMembersGUI\ACTION_SHOW_INDIVIDUAL_PLAN, ilObjStudyProgrammeMembersGUI\ACTION_UNMARK_ACCREDITED, ilObjStudyProgrammeMembersGUI\ACTION_UNMARK_RELEVANT, ilObjStudyProgrammeMembersGUI\ACTION_UPDATE_CERTIFICATE, ilObjStudyProgrammeMembersGUI\ACTION_UPDATE_FROM_CURRENT_PLAN, ilPRGProgress\STATUS_ACCREDITED, ilStudyProgrammeAssessmentSettings\STATUS_ACTIVE, ilPRGProgress\STATUS_COMPLETED, ilPRGProgress\STATUS_IN_PROGRESS, and ilPRGProgress\STATUS_NOT_RELEVANT.

Referenced by fillRow().

424  : array {
425  $actions = [];
426 
427  if ($is_root) {
433  }
434 
435  if ($status == ilPRGProgress::STATUS_ACCREDITED) {
437  }
438  if ($status == ilPRGProgress::STATUS_IN_PROGRESS) {
441  }
442 
443  if (! $is_root &&
444  ($status == ilPRGProgress::STATUS_IN_PROGRESS ||
446  ) {
448  }
450  && $node_lifecyle_status == ilStudyProgrammeAssessmentSettings::STATUS_ACTIVE
451  ) {
453  }
454  if ($status == ilPRGProgress::STATUS_COMPLETED ||
456  && $this->prg->isCertificateActive()
457  ) {
460  }
461 
462 
463  return $actions;
464  }
+ Here is the caller graph for this function:

◆ getSelectableColumns()

ilStudyProgrammeMembersTableGUI::getSelectableColumns ( )

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

References ilTable2GUI\$column.

327  : array
328  {
329  $cols = [];
330 
331  foreach ($this->prg_user_table->getColumns($this->prg_obj_id, false, $this->prg->isCertificateActive()) as $column) {
332  [$col, $lng_var, $optional, $lp, $no_lp] = $column;
333  if ($optional) {
334  $cols[$col] = ["txt" => $lng_var];
335  }
336  }
337 
338  return $cols;
339  }

◆ getValidUserIds()

ilStudyProgrammeMembersTableGUI::getValidUserIds ( )
protected

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

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

Referenced by __construct().

466  : ?array
467  {
468  if ($this->permissions->may($this->permissions::ROLEPERM_MANAGE_MEMBERS)) {
469  return null;
470  }
471 
472  $valid_user_ids = $this->permissions->getUserIdsSusceptibleTo(ilOrgUnitOperation::OP_VIEW_MEMBERS);
473  array_unshift($valid_user_ids, $this->user->getId());
474  return $valid_user_ids;
475  }
while($session_entry=$r->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) return null
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initFilter()

ilStudyProgrammeMembersTableGUI::initFilter ( )

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

References ilTable2GUI\$id, and ilTable2GUI\addFilterItemByMetaType().

Referenced by __construct().

391  : void
392  {
393  foreach ($this->custom_filter->getItemConfig() as $conf) {
394  [$id, $type, $options, $caption] = $conf;
395  $item = $this->addFilterItemByMetaType($id, $type, false, $caption);
396  if ($options) {
397  $item->setOptions($options);
398  }
399  }
400  }
addFilterItemByMetaType(string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
Add filter by standard type.
+ Here is the call graph for this function:
+ 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: