GUI class for membership features. More...

Inheritance diagram for ilGroupMembershipGUI:

Collaboration diagram for ilGroupMembershipGUI:

Public Member Functions
	__construct (ilObjectGUI $repository_gui, ilObject $repository_obj)

	filterUserIdsByRbacOrPositionOfCurrentUser (array $a_user_ids)
	Filter user ids by access. More...

	assignMembers (array $user_ids, string $a_type)

	getLocalTypeRole (bool $a_translation=false)

	getPrintMemberData (array $a_members)

	getAttendanceListUserData (int $user_id, array $filters=[])
	Callback from attendance list. More...

Public Member Functions inherited from ilMembershipGUI
	__construct (ilObjectGUI $repository_gui, ilObject $repository_obj)

	getParentGUI ()

	getParentObject ()

	getMembersObject ()

	filterUserIdsByRbacOrPositionOfCurrentUser (array $a_user_ids)
	Filter user ids by access. More...

	executeCommand ()

	getAttendanceListUserData (int $user_id, array $filters=[])

	updateParticipants ()
	update members More...

	createMailSignature ()
	Create Mail signature. More...

	addMemberTab (ilTabsGUI $tabs, bool $a_is_participant=false)

	readMemberData (array $usr_ids, array $columns)
	Required for member table guis. More...

	getLocalRoles ()

	confirmAssignSubscribers ()
	Show subscription confirmation. More...

	confirmRefuseSubscribers ()
	Refuse subscriber confirmation. More...

	assignSubscribers ()
	Do assignment of subscription request. More...

	confirmAssignFromWaitingList ()
	Assign from waiting list (confirmatoin) More...

	assignFromWaitingList ()
	Assign from waiting list. More...

	confirmRefuseFromList ()
	Refuse from waiting list (confirmation) More...

Protected Member Functions
	getMailMemberRoles ()

	updateParticipantsStatus ()
	save in participants table More...

	initParticipantTableGUI ()

	initEditParticipantTableGUI (array $participants)

	initParticipantTemplate ()
	Init participant view template. More...

	initWaitingList ()

	getDefaultRole ()
	@inheritDoc More...

	getMailContextOptions ()
	@inheritDoc More...

Protected Member Functions inherited from ilMembershipGUI
	initParticipantsFromPost ()

	initMemberIdFromGet ()

	initSubscribersFromPost ()

	initWaitingListIdsFromPost ()

	getLanguage ()

	getCtrl ()

	getLogger ()

	getMailMemberRoles ()

	checkPermissionBool (string $a_permission, string $a_cmd='', string $a_type='', int $a_ref_id=0)

	checkRbacOrPositionAccessBool (string $a_rbac_perm, string $a_pos_perm, int $a_ref_id=0)

	checkPermission (string $a_permission, string $a_cmd="")
	Check permission If not granted redirect to parent gui. More...

	checkRbacOrPermissionAccess (string $a_rbac_perm, string $a_pos_perm)
	check rbac or position access More...

	canAddOrSearchUsers ()
	Check if current user is allowed to add / search users. More...

	participants ()
	Show participant table, subscriber table, wating list table;. More...

	getParticipantTableTitle ()

	participantsApplyFilter ()
	Apply filter for participant table. More...

	participantsResetFilter ()
	reset participants filter More...

	editMember ()
	Edit one participant. More...

	editParticipants (array $post_participants=array())
	Edit participants. More...

	updateLPFromStatus (int $usr_id, bool $has_passed)

	confirmDeleteParticipants ()
	Show confirmation screen for participants deletion. More...

	deleteParticipants ()

	sendMailToSelectedUsers ()

	getMailContextOptions ()

	membersMap ()
	Members map. More...

	mailMembersBtn ()

	showParticipantsToolbar ()
	Show participants toolbar. More...

	showMemberExportToolbarButton (ilToolbarGUI $toolbar, ?string $a_back_cmd=null, bool $a_separator=false)

	showMailToMemberToolbarButton (ilToolbarGUI $toolbar, ?string $a_back_cmd=null, bool $a_separator=false)
	Show mail to member toolbar button. More...

	getMailButtonLabel ()

	getDefaultCommand ()

	getMemberTabName ()

	setSubTabs (ilTabsGUI $tabs)
	Set sub tabs. More...

	parseSubscriberTable ()
	Parse table of subscription request. More...

	initSubscriberTable ()

	refuseSubscribers ()

	parseWaitingListTable ()
	Parse table of subscription request. More...

	refuseFromList ()
	refuse from waiting list More...

	addToClipboard ()
	Add selected users to user clipboard. More...

	getDefaultRole ()

	activateSubTab (string $a_sub_tab)

	printMembers ()

	printMembersOutput ()
	print members output More...

	printForMembersOutput ()
	print members output More...

	jump2UsersGallery ()

	initAttendanceList (bool $a_for_members=false)

Protected Attributes
GlobalHttpState	$http

Factory	$refinery

Protected Attributes inherited from ilMembershipGUI
GlobalHttpState	$http

Factory	$refinery

ilLanguage	$lng

ilCtrlInterface	$ctrl

ilLogger	$logger

ilGlobalTemplateInterface	$tpl

ilAccessHandler	$access

ilParticipants	$participants = null

ilObjUser	$user

ilErrorHandling	$error

ilTabsGUI	$tabs

ilToolbarGUI	$toolbar

ilRbacSystem	$rbacsystem

ilRbacReview	$rbacreview

ilTree	$tree

Profile	$profile

array	$member_data = []

Detailed Description

GUI class for membership features.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

@ilCtrl_Calls ilGroupMembershipGUI: ilMailMemberSearchGUI, ilUsersGalleryGUI, ilRepositorySearchGUI @ilCtrl_Calls ilGroupMembershipGUI: ilCourseParticipantsGroupsGUI, ilObjectCustomuserFieldsGUI @ilCtrl_Calls ilGroupMembershipGUI: ilSessionOverviewGUI @ilCtrl_Calls ilGroupMembershipGUI: ilMemberExportGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilGroupMembershipGUI::__construct	(	ilObjectGUI	$repository_gui,
		ilObject	$repository_obj
	)

Reimplemented from ilMembershipGUI.

Definition at line 39 of file class.ilGroupMembershipGUI.php.

    {
        global $DIC;
 
        parent::__construct($repository_gui, $repository_obj);
        $this->refinery = $DIC->refinery();
        $this->http = $DIC->http();
    }

References $DIC, ilMembershipGUI\$repository_gui, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

◆ assignMembers()

ilGroupMembershipGUI::assignMembers	(	array	$user_ids,
		string	$a_type
	)

Definition at line 72 of file class.ilGroupMembershipGUI.php.

                                                                  : bool
    {
        $a_type = (int) $a_type;
        if (!count($user_ids)) {
            $this->lng->loadLanguageModule('search');
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('search_err_user_not_exist'), true);
            return false;
        }
 
        $assigned = false;
        foreach ($user_ids as $new_member) {
            $new_member = (int) $new_member;
            if ($this->getMembersObject()->isAssigned($new_member)) {
                continue;
            }
            switch ($a_type) {
                case $this->getParentObject()->getDefaultAdminRole():
                    $this->getMembersObject()->add($new_member, ilParticipants::IL_GRP_ADMIN);
                    $this->getMembersObject()->sendNotification(
                        ilGroupMembershipMailNotification::TYPE_ADMISSION_MEMBER,
                        $new_member
                    );
                    $assigned = true;
                    break;
 
                case $this->getParentObject()->getDefaultMemberRole():
                    $this->getMembersObject()->add($new_member, ilParticipants::IL_GRP_MEMBER);
                    $this->getMembersObject()->sendNotification(
                        ilGroupMembershipMailNotification::TYPE_ADMISSION_MEMBER,
                        $new_member
                    );
                    $assigned = true;
                    break;
 
                default:
                    if (in_array($a_type, $this->getParentObject()->getLocalGroupRoles(true))) {
                        $this->getMembersObject()->add($new_member, ilParticipants::IL_GRP_MEMBER);
                        $this->getMembersObject()->updateRoleAssignments($new_member, (array) $a_type);
                    } else {
                        ilLoggerFactory::getLogger('crs')->notice('Can not find role with id .' . $a_type . ' to assign users.');
                        $this->tpl->setOnScreenMessage('failure', $this->lng->txt("crs_cannot_find_role"), true);
                        return false;
                    }
                    $this->getMembersObject()->sendNotification(
                        ilGroupMembershipMailNotification::TYPE_ADMISSION_MEMBER,
                        $new_member
                    );
                    $assigned = true;
                    break;
            }
        }
 
        if ($assigned) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("grp_msg_member_assigned"), true);
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('grp_users_already_assigned'), true);
        }
        $this->ctrl->redirect($this, 'participants');
        return true;
    }

References ILIAS\Repository\ctrl(), ilLoggerFactory\getLogger(), ilMembershipGUI\getMembersObject(), ilMembershipGUI\getParentObject(), ilParticipants\IL_GRP_ADMIN, ilParticipants\IL_GRP_MEMBER, ILIAS\Repository\int(), ILIAS\Repository\lng(), and ilGroupMembershipMailNotification\TYPE_ADMISSION_MEMBER.

Here is the call graph for this function:

◆ filterUserIdsByRbacOrPositionOfCurrentUser()

ilGroupMembershipGUI::filterUserIdsByRbacOrPositionOfCurrentUser ( array $a_user_ids )

Filter user ids by access.

Parameters

int[] $a_user_ids

Returns: int[]

Reimplemented from ilMembershipGUI.

Definition at line 62 of file class.ilGroupMembershipGUI.php.

                                                                                 : array
    {
        return $this->access->filterUserIdsByRbacOrPositionOfCurrentUser(
            'manage_members',
            'manage_members',
            $this->getParentObject()->getRefId(),
            $a_user_ids
        );
    }

References ILIAS\Repository\access(), and ilMembershipGUI\getParentObject().

Here is the call graph for this function:

◆ getAttendanceListUserData()

ilGroupMembershipGUI::getAttendanceListUserData	(	int	$user_id,
		array	$filters = `[]`
	)

Callback from attendance list.

Reimplemented from ilMembershipGUI.

Definition at line 244 of file class.ilGroupMembershipGUI.php.

                                                                                : array
    {
        if (is_array($this->member_data) && array_key_exists($user_id, $this->member_data)) {
            $user_data = $this->member_data[$user_id];
            if (isset($user_data['access_time_unix'])) {
                ilDatePresentation::setUseRelativeDates(false);
                $user_data['access'] = ilDatePresentation::formatDate(
                    new ilDateTime($user_data['access_time_unix'], IL_CAL_UNIX)
                );
                ilDatePresentation::setUseRelativeDates(true);
            }
            if (isset($this->member_data['progress'])) {
                $user_data['progress'] = $this->lng->txt($this->member_data['progress']);
            }
            return $user_data;
        }
        return [];
    }

References $user_id, ilDatePresentation\formatDate(), IL_CAL_UNIX, ILIAS\Repository\lng(), and ilDatePresentation\setUseRelativeDates().

Here is the call graph for this function:

◆ getDefaultRole()

ilGroupMembershipGUI::getDefaultRole ( )

protected

@inheritDoc

Reimplemented from ilMembershipGUI.

Definition at line 229 of file class.ilGroupMembershipGUI.php.

                                       : ?int
    {
        return $this->getParentGUI()->getObject()->getDefaultMemberRole();
    }

References ilMembershipGUI\getParentGUI().

Here is the call graph for this function:

◆ getLocalTypeRole()

ilGroupMembershipGUI::getLocalTypeRole ( bool $a_translation = false )

Definition at line 215 of file class.ilGroupMembershipGUI.php.

                                                                 : array
    {
        return $this->getParentObject()->getLocalGroupRoles($a_translation);
    }

References ilMembershipGUI\getParentObject().

Here is the call graph for this function:

◆ getMailContextOptions()

ilGroupMembershipGUI::getMailContextOptions ( )

protected

@inheritDoc

Reimplemented from ilMembershipGUI.

Definition at line 266 of file class.ilGroupMembershipGUI.php.

                                              : array
    {
        $context_options = [
            ilMail::PROP_CONTEXT_SUBJECT_PREFIX => ilContainer::_lookupContainerSetting(
                $this->getParentObject()->getId(),
                ilObjectServiceSettingsGUI::EXTERNAL_MAIL_PREFIX,
                ''
            ),
        ];
 
        return $context_options;
    }

References ilContainer\_lookupContainerSetting(), ilObjectServiceSettingsGUI\EXTERNAL_MAIL_PREFIX, ILIAS\Survey\Mode\getId(), ilMembershipGUI\getParentObject(), and ilMail\PROP_CONTEXT_SUBJECT_PREFIX.

Here is the call graph for this function:

◆ getMailMemberRoles()

ilGroupMembershipGUI::getMailMemberRoles ( )

protected

Returns: ilAbstractMailMemberRoles | null

Reimplemented from ilMembershipGUI.

Definition at line 51 of file class.ilGroupMembershipGUI.php.

                                           : ?ilAbstractMailMemberRoles
    {
        return new ilMailMemberGroupRoles();
    }

◆ getPrintMemberData()

ilGroupMembershipGUI::getPrintMemberData ( array $a_members )

Definition at line 234 of file class.ilGroupMembershipGUI.php.

                                                        : array
    {
        $member_data = $this->readMemberData($a_members, array());
        $member_data = $this->getParentGUI()->addCustomData($member_data);
        return $member_data;
    }

References ilMembershipGUI\$member_data, ilMembershipGUI\getParentGUI(), and ilMembershipGUI\readMemberData().

Here is the call graph for this function:

◆ initEditParticipantTableGUI()

ilGroupMembershipGUI::initEditParticipantTableGUI ( array $participants )

protected

Definition at line 196 of file class.ilGroupMembershipGUI.php.

                                                                       : ilGroupEditParticipantsTableGUI
    {
        $table = new ilGroupEditParticipantsTableGUI($this, $this->getParentObject());
        $table->setTitle($this->lng->txt($this->getParentObject()->getType() . '_header_edit_members'));
        $table->setData($this->getParentGUI()->readMemberData($participants));
 
        return $table;
    }

References ilMembershipGUI\getParentGUI(), ilMembershipGUI\getParentObject(), ILIAS\Repository\lng(), and ilMembershipGUI\readMemberData().

Here is the call graph for this function:

◆ initParticipantTableGUI()

ilGroupMembershipGUI::initParticipantTableGUI ( )

protected

Definition at line 179 of file class.ilGroupMembershipGUI.php.

                                                : ilGroupParticipantsTableGUI
    {
        $show_tracking =
            (ilObjUserTracking::_enabledLearningProgress() && ilObjUserTracking::_enabledUserRelatedData())
        ;
        if ($show_tracking) {
            $olp = ilObjectLP::getInstance($this->getParentObject()->getId());
            $show_tracking = $olp->isActive();
        }
 
        return new ilGroupParticipantsTableGUI(
            $this,
            $this->getParentObject(),
            $show_tracking
        );
    }

References ilObjUserTracking\_enabledLearningProgress(), ilObjUserTracking\_enabledUserRelatedData(), ILIAS\Survey\Mode\getId(), ilObjectLP\getInstance(), and ilMembershipGUI\getParentObject().

Here is the call graph for this function:

◆ initParticipantTemplate()

ilGroupMembershipGUI::initParticipantTemplate ( )

protected

Init participant view template.

Definition at line 210 of file class.ilGroupMembershipGUI.php.

                                                : void
    {
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.grp_edit_members.html', 'components/ILIAS/Group');
    }

◆ initWaitingList()

ilGroupMembershipGUI::initWaitingList ( )

protected

Definition at line 221 of file class.ilGroupMembershipGUI.php.

                                        : ilGroupWaitingList
    {
        return new ilGroupWaitingList($this->getParentObject()->getId());
    }

References ILIAS\Survey\Mode\getId(), and ilMembershipGUI\getParentObject().

Here is the call graph for this function:

◆ updateParticipantsStatus()

ilGroupMembershipGUI::updateParticipantsStatus ( )

protected

save in participants table

Definition at line 136 of file class.ilGroupMembershipGUI.php.

                                                 : void
    {
        $participants = [];
        if ($this->http->wrapper()->post()->has('visible_member_ids')) {
            $participants = $this->http->wrapper()->post()->retrieve(
                'visible_member_ids',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }
        $notification = [];
        if ($this->http->wrapper()->post()->has('notification')) {
            $notification = $this->http->wrapper()->post()->retrieve(
                'notification',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }
        $contact = [];
        if ($this->http->wrapper()->post()->has('contact')) {
            $contact = $this->http->wrapper()->post()->retrieve(
                'contact',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }
        foreach ($participants as $mem_id) {
            if ($this->getMembersObject()->isAdmin($mem_id)) {
                $this->getMembersObject()->updateContact($mem_id, in_array($mem_id, $contact));
                $this->getMembersObject()->updateNotification($mem_id, in_array($mem_id, $notification));
            } else {
                $this->getMembersObject()->updateContact($mem_id, false);
                $this->getMembersObject()->updateNotification($mem_id, false);
            }
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, 'participants');
    }

References ilMembershipGUI\$participants, ILIAS\Repository\ctrl(), ilMembershipGUI\getMembersObject(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Field Documentation

◆ $http

GlobalHttpState ilGroupMembershipGUI::$http

protected

Definition at line 36 of file class.ilGroupMembershipGUI.php.

◆ $refinery

Factory ilGroupMembershipGUI::$refinery

protected

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

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

components/ILIAS/Group/classes/class.ilGroupMembershipGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assignMembers()

◆ filterUserIdsByRbacOrPositionOfCurrentUser()

◆ getAttendanceListUserData()

◆ getDefaultRole()

◆ getLocalTypeRole()

◆ getMailContextOptions()

◆ getMailMemberRoles()

◆ getPrintMemberData()

◆ initEditParticipantTableGUI()

◆ initParticipantTableGUI()

◆ initParticipantTemplate()

◆ initWaitingList()

◆ updateParticipantsStatus()

Field Documentation

◆ $http

◆ $refinery