Class ilOrgUnitRecursiveUserAssignmentTableGUI. More...

Inheritance diagram for ilOrgUnitRecursiveUserAssignmentTableGUI:

Collaboration diagram for ilOrgUnitRecursiveUserAssignmentTableGUI:

Public Member Functions
	__construct (BaseCommands $parent_obj, string $parent_cmd, ilOrgUnitPosition $position)

	loadData ()

	fillRow (array $a_set)

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

	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)

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

	addActions (ilAdvancedSelectionListGUI $selection)

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

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

Private Member Functions
	mayViewLPIn (int $ref_id, ilAccess $access, ilObjOrgUnitTree $orgu_tree)

Static Private Attributes
static array	$permission_access_staff_recursive = []

static array	$permission_view_lp_recursive = []

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

Class ilOrgUnitRecursiveUserAssignmentTableGUI.

Author: dkloepfer; Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitRecursiveUserAssignmentTableGUI::__construct	(	BaseCommands	$parent_obj,
		string	$parent_cmd,
		ilOrgUnitPosition	$position
	)

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

References $DIC, ilTable2GUI\$parent_obj, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ilOrgUnitPosition\getId(), ilOrgUnitPosition\getTitle(), loadData(), ilTable2GUI\setData(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), ilTable2GUI\setId(), ilTable2GUI\setPrefix(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setShowRowsSelector(), ilTable2GUI\setShowTemplates(), setTableHeaders(), ilTable2GUI\setTitle(), and ilTable2GUI\setTopCommands().

     {
         global $DIC;
 
         $this->parent_obj = $parent_obj;
         $this->ilOrgUnitPosition = $position;
         $this->ctrl = $DIC->ctrl();
         $this->setPrefix("il_orgu_" . $position->getId());
         $this->setFormName('il_orgu_' . $position->getId());
         $this->setId("il_orgu_" . $position->getId());
         $this->orgu_ref_id = filter_input(INPUT_GET, "ref_id", FILTER_SANITIZE_NUMBER_INT);
         parent::__construct($parent_obj, $parent_cmd);
 
         $this->setFormAction($this->ctrl->getFormAction($parent_obj));
         $this->setTableHeaders();
         $this->setTopCommands(true);
         $this->setEnableHeader(true);
         $this->setShowRowsSelector(true);
         $this->setShowTemplates(false);
         $this->setEnableHeader(true);
         $this->setEnableTitle(true);
         $this->setTitle($position->getTitle());
         $this->setRowTemplate("tpl.staff_row.html", "Modules/OrgUnit");
         $this->setData($this->loadData());
     }

Here is the call graph for this function:

Member Function Documentation

◆ addActions()

ilOrgUnitRecursiveUserAssignmentTableGUI::addActions ( ilAdvancedSelectionListGUI $selection )

protected

Definition at line 203 of file class.ilOrgUnitRecursiveUserAssignmentTableGUI.php.

References ilAdvancedSelectionListGUI\addItem(), ILIAS\Modules\OrgUnit\ARHelper\BaseCommands\CMD_CONFIRM_RECURSIVE, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by fillRow().

                                                                         : void
     {
         $selection->addItem($this->lng->txt("remove"), "delete_from_employees", $this->ctrl->getLinkTargetByClass(ilOrgUnitUserAssignmentGUI::class, ilOrgUnitUserAssignmentGUI::CMD_CONFIRM_RECURSIVE));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillRow()

ilOrgUnitRecursiveUserAssignmentTableGUI::fillRow ( array $a_set )

Definition at line 158 of file class.ilOrgUnitRecursiveUserAssignmentTableGUI.php.

References $_GET, $DIC, ilTableGUI\$lng, ilObjUserTracking\_enabledLearningProgress(), ilObjUserTracking\_enabledUserRelatedData(), addActions(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilLanguage\txt().

                                          : void
     {
         global $DIC;
 
         $lng = $DIC['lng'];
         $ilAccess = $DIC['ilAccess'];
         $this->tpl->setVariable("LOGIN", $a_set["login"]);
         $this->tpl->setVariable("FIRST_NAME", $a_set["first_name"]);
         $this->tpl->setVariable("LAST_NAME", $a_set["last_name"]);
         if($a_set["active"] === false) {
             $this->tpl->setVariable("INACTIVE", $this->lng->txt('usr_account_inactive'));
         }
 
         $orgus = $a_set['orgu_assignments'];
         sort($orgus);
         $this->tpl->setVariable("ORG_UNITS", implode(',', $orgus));
         $this->ctrl->setParameterByClass(ilOrgUnitUserAssignmentGUI::class, 'usr_id', $a_set["user_id"]);
         $this->ctrl->setParameterByClass(
             ilOrgUnitUserAssignmentGUI::class,
             'position_id',
             $this->ilOrgUnitPosition->getId()
         );
         $selection = new ilAdvancedSelectionListGUI();
         $selection->setListTitle($lng->txt("Actions"));
         $selection->setId("selection_list_user_lp_" . $a_set["user_id"]);
         if ($a_set['view_lp']
             && ilObjUserTracking::_enabledLearningProgress()
             && ilObjUserTracking::_enabledUserRelatedData()
         ) {
             $selection->addItem(
                 $lng->txt("show_learning_progress"),
                 "show_learning_progress",
                 $this->ctrl->getLinkTargetByClass(array(
                     ilAdministrationGUI::class,
                     ilObjOrgUnitGUI::class,
                     ilLearningProgressGUI::class,
                 ), "")
             );
         }
         if ($ilAccess->checkAccess("write", "", $_GET["ref_id"])) {
             $this->addActions($selection);
         }
         $this->tpl->setVariable("ACTIONS", $selection->getHTML());
     }

Here is the call graph for this function:

◆ loadData()

ilOrgUnitRecursiveUserAssignmentTableGUI::loadData ( )

Definition at line 69 of file class.ilOrgUnitRecursiveUserAssignmentTableGUI.php.

References ilTableGUI\$data, $DIC, $ref_id, ilObjOrgUnitAccess\_checkAccessStaff(), ilObjOrgUnitAccess\_checkAccessStaffRec(), ilObjOrgUnitTree\_getInstance(), ilObjUser\_lookupActive(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObjOrgUnit\getRootOrgRefId(), ILIAS\Repository\int(), and mayViewLPIn().

Referenced by __construct().

                               : array
     {
         global $DIC;
         $access = $DIC['ilAccess'];
         $orgu_tree = ilObjOrgUnitTree::_getInstance();
         $data = [];
         // maybe any parent gives us recursive permission
         (int) $root = (int) ilObjOrgUnit::getRootOrgRefId();
         $parent = (int) $orgu_tree->getParent($this->orgu_ref_id);
 
         while ($parent !== $root) {
             if (ilObjOrgUnitAccess::_checkAccessStaffRec($parent)) {
                 array_merge(
                     self::$permission_access_staff_recursive,
                     $orgu_tree->getAllChildren($parent)
                 );
             }
             $parent = (int) $orgu_tree->getParent($parent);
         }
 
         foreach ($orgu_tree->getAllChildren($this->orgu_ref_id) as $ref_id) {
             $recursive = in_array($ref_id, self::$permission_access_staff_recursive);
             if (!$recursive) {
                 // ok, so no permission from above, lets check local permissions
                 if (ilObjOrgUnitAccess::_checkAccessStaffRec($ref_id)) {
                     // update recursive permissions
                     array_merge(
                         self::$permission_access_staff_recursive,
                         $orgu_tree->getAllChildren($ref_id)
                     );
                 } elseif (!ilObjOrgUnitAccess::_checkAccessStaff($ref_id)) {
                     // skip orgus in which one may not view the staff
                     continue;
                 }
             }
             $permission_view_lp = $this->mayViewLPIn($ref_id, $access, $orgu_tree);
             foreach ($orgu_tree->getAssignements($ref_id, $this->ilOrgUnitPosition) as $usr_id) {
                 $usr_id = (int) $usr_id;
                 if (!array_key_exists($usr_id, $data)) {
                     $user = new ilObjUser($usr_id);
                     $set = [
                         'login' => $user->getLogin(),
                         'first_name' => $user->getFirstname(),
                         'last_name' => $user->getLastname(),
                         'user_id' => $usr_id,
                         'active' => $user->getActive(),
                         'orgu_assignments' => [],
                         'view_lp' => false
                     ];
                     $data[$usr_id] = $set;
                 } else {
                     $data[$usr_id]["active"] = \ilObjUser::_lookupActive($usr_id);
                 }
                 $data[$usr_id]['orgu_assignments'][] = ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id));
                 $data[$usr_id]['view_lp'] = $permission_view_lp || $data[$usr_id]['view_lp'];
             }
         }
 
         return $data;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mayViewLPIn()

ilOrgUnitRecursiveUserAssignmentTableGUI::mayViewLPIn	(	int	$ref_id,
		ilAccess	$access,
		ilObjOrgUnitTree	$orgu_tree
	)

private

Definition at line 130 of file class.ilOrgUnitRecursiveUserAssignmentTableGUI.php.

References $ref_id, ilAccess\checkAccess(), ilObjOrgUnitTree\getParent(), ilObjOrgUnit\getRootOrgRefId(), and ILIAS\Repository\int().

Referenced by loadData().

                                                                                             : bool
     {
         if ($access->checkAccess("view_learning_progress", "", $ref_id)) { // admission by local
             return true;
         }
         $current = $ref_id;
         $root = ilObjOrgUnit::getRootOrgRefId();
         $checked_children = [];
         while ($current !== $root) {
             if (!array_key_exists($current, self::$permission_view_lp_recursive)) {
                 self::$permission_view_lp_recursive[$current]
                     = $access->checkAccess("view_learning_progress_rec", "", $current);
             }
             if (self::$permission_view_lp_recursive[$current]) {
                 // if an orgu may be viewed recursively, same holds for all of its children. lets cache this.
                 foreach ($checked_children as $child) {
                     self::$permission_view_lp_recursive[$child] = true;
                 }
 
                 return true;
             }
             $checked_children[] = $current;
             $current = (int) $orgu_tree->getParent($current);
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTableHeaders()

ilOrgUnitRecursiveUserAssignmentTableGUI::setTableHeaders ( )

protected

Definition at line 59 of file class.ilOrgUnitRecursiveUserAssignmentTableGUI.php.

References ilTable2GUI\addColumn(), and ILIAS\Repository\lng().

Referenced by __construct().

                                         : void
     {
         $this->addColumn($this->lng->txt("login"), "login");
         $this->addColumn($this->lng->txt("firstname"), "first_name");
         $this->addColumn($this->lng->txt("lastname"), "last_name");
         $this->addColumn($this->lng->txt("obj_orgu"), "orgus");
         $this->addColumn($this->lng->txt("action"));
     }