ilGroupMembershipGUI Class Reference

GUI class for membership features. More...

Inheritance diagram for ilGroupMembershipGUI:

Collaboration diagram for ilGroupMembershipGUI:

Public Member Functions
	filterUserIdsByRbacOrPositionOfCurrentUser ($a_user_ids)
	Filter user ids by access. More...
	assignMembers ($user_ids, $a_type)
	@access public More...
	getLocalTypeRole ($a_translation=false)
	getPrintMemberData ($a_members)
	getAttendanceListUserData ($a_user_id)
	Callback from attendance list. More...
Public Member Functions inherited from ilMembershipGUI
	__construct (ilObjectGUI $repository_gui, ilObject $repository_obj)
	Constructor. More...
	getParentGUI ()
	Get parent gui. More...
	getParentObject ()
	Get parent object. More...
	getMembersObject ()
	Get member object. More...
	filterUserIdsByRbacOrPositionOfCurrentUser ($a_user_ids)
	Filter user ids by access. More...
	updateParticipants ()
	update members More...
	createMailSignature ()
	addMemberTab (ilTabsGUI $tabs, $a_is_participant=false)
	add member tab More...
	readMemberData (array $usr_ids, array $columns)
	Required for member table guis. More...
	getLocalRoles ()
	Get parent roles. More...
	confirmAssignSubscribers ()
	Show subscription confirmation. More...
	confirmRefuseSubscribers ()
	Refuse subscriber confirmation. More...
	assignSubscribers ()
	Do assignment of subscription request @global type $rbacsystem @global type $ilErr. More...
	confirmAssignFromWaitingList ()
	Assign from waiting list (confirmatoin) More...
	assignFromWaitingList ()
	Assign from waiting list @global type $rbacsystem. More...
	confirmRefuseFromList ()
	Refuse from waiting list (confirmation) More...

Protected Member Functions
	getMailMemberRoles ()
	updateParticipantsStatus ()
	save in participants table More...
	initParticipantTableGUI ()
	initEditParticipantTableGUI (array $participants)
	init edit participants table gui More...
	initParticipantTemplate ()
	Init participant view template. More...
	updateLPFromStatus ()
	Update lp from status. More...
	initWaitingList ()
	init waiting list More...
	getDefaultRole ()
	getMailContextOptions ()
	Returns array More...
Protected Member Functions inherited from ilMembershipGUI
	getLanguage ()
	getCtrl ()
	getLogger ()
	getMailMemberRoles ()
	checkPermissionBool ($a_permission, $a_cmd='', $a_type='', $a_ref_id=0)
	Check permission. More...
	checkRbacOrPositionAccessBool ($a_rbac_perm, $a_pos_perm, $a_ref_id=0)
	Check if rbac or position access is granted. More...
	checkPermission ($a_permission, $a_cmd="")
	Check permission If not granted redirect to parent gui. More...
	checkRbacOrPermissionAccess ($a_rbac_perm, $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...
	participantsApplyFilter ()
	Apply filter for participant table. More...
	participantsResetFilter ()
	reset participants filter More...
	editMember ()
	Edit one participant. More...
	editParticipants ($post_participants=array())
	Edit participants. More...
	confirmDeleteParticipants ()
	Show confirmation screen for participants deletion. More...
	deleteParticipants ()
	sendMailToSelectedUsers ()
	Send mail to selected users. More...
	getMailContextOptions ()
	membersMap ()
	Members map. More...
	mailMembersBtn ()
	Mail to members view @global type $ilToolbar. More...
	showParticipantsToolbar ()
	Show participants toolbar. More...
	showMemberExportToolbarButton (ilToolbarGUI $toolbar, $a_back_cmd=null, $a_separator=false)
	Show member export button. More...
	showMailToMemberToolbarButton (ilToolbarGUI $toolbar, $a_back_cmd=null, $a_separator=false)
	Show mail to member toolbar button. More...
	getDefaultCommand ()
	Get default command. More...
	getMemberTabName ()
	Get member tab name. More...
	setSubTabs (ilTabsGUI $tabs)
	Set sub tabs. More...
	parseSubscriberTable ()
	Parse table of subscription request. More...
	initSubscriberTable ()
	refuseSubscribers ()
	Refuse subscribers @global type $rbacsystem. More...
	parseWaitingListTable ()
	Parse table of subscription request. More...
	refuseFromList ()
	refuse from waiting list More...
	addToClipboard ()
	Add selected users to user clipboard. More...
	getDefaultRole ()
	printMembers ()
	Print members. More...
	printMembersOutput ()
	print members output More...
	printForMembersOutput ()
	print members output More...
	jump2UsersGallery ()

Additional Inherited Members
Protected Attributes inherited from ilMembershipGUI
	$lng = null
	$ctrl = null
	$logger = null
	$tpl
	$access

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 18 of file class.ilGroupMembershipGUI.php.

Member Function Documentation

assignMembers()

ilGroupMembershipGUI::assignMembers	(		$user_ids,
			$a_type
	)

@access public

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

    {
        if (empty($user_ids[0])) {
            $this->lng->loadLanguageModule('search');
            ilUtil::sendFailure($this->lng->txt('search_err_user_not_exist'), true);
            return false;
        }
 
        $assigned = false;
        foreach ((array) $user_ids as $new_member) {
            if ($this->getMembersObject()->isAssigned($new_member)) {
                continue;
            }
            switch ($a_type) {
                case $this->getParentObject()->getDefaultAdminRole():
                    $this->getMembersObject()->add($new_member, IL_GRP_ADMIN);
                    include_once './Modules/Group/classes/class.ilGroupMembershipMailNotification.php';
                    $this->getMembersObject()->sendNotification(
                        ilGroupMembershipMailNotification::TYPE_ADMISSION_MEMBER,
                        $new_member
                    );
                    $assigned = true;
                    break;
                
                case $this->getParentObject()->getDefaultMemberRole():
                    $this->getMembersObject()->add($new_member, IL_GRP_MEMBER);
                    include_once './Modules/Group/classes/class.ilGroupMembershipMailNotification.php';
                    $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, 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.');
                        ilUtil::sendFailure($this->lng->txt("crs_cannot_find_role"), true);
                        return false;
                    }
                    include_once './Modules/Group/classes/class.ilGroupMembershipMailNotification.php';
                    $this->getMembersObject()->sendNotification(
                        ilGroupMembershipMailNotification::TYPE_ADMISSION_MEMBER,
                        $new_member
                    );
                    $assigned = true;
                    break;
            }
        }
        
        if ($assigned) {
            ilUtil::sendSuccess($this->lng->txt("grp_msg_member_assigned"), true);
        } else {
            ilUtil::sendSuccess($this->lng->txt('grp_users_already_assigned'), true);
        }
        $this->ctrl->redirect($this, 'participants');
    }

References ilLoggerFactory\getLogger(), ilMembershipGUI\getMembersObject(), ilMembershipGUI\getParentObject(), IL_GRP_ADMIN, IL_GRP_MEMBER, ilUtil\sendFailure(), and ilGroupMembershipMailNotification\TYPE_ADMISSION_MEMBER.

Here is the call graph for this function:

filterUserIdsByRbacOrPositionOfCurrentUser()

ilGroupMembershipGUI::filterUserIdsByRbacOrPositionOfCurrentUser

(

$a_user_ids

)

Filter user ids by access.

Parameters

int[]

$a_user_ids

Returns

int[]

Reimplemented from ilMembershipGUI.

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

    {
        return $GLOBALS['DIC']->access()->filterUserIdsByRbacOrPositionOfCurrentUser(
            'manage_members',
            'manage_members',
            $this->getParentObject()->getRefId(),
            $a_user_ids
        );
    }

References $GLOBALS, and ilMembershipGUI\getParentObject().

Here is the call graph for this function:

getAttendanceListUserData()

ilGroupMembershipGUI::getAttendanceListUserData

(

$a_user_id

)

Callback from attendance list.

Parameters

int

$a_user_id

Returns

array

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

    {
        if (is_array($this->member_data) && array_key_exists($a_user_id, $this->member_data)) {
            $user_data = $this->member_data[$a_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($user_data['progress'])) {
                $user_data['progress'] = $this->lng->txt($user_data['progress']);
            }
 
            return $user_data;
        }
        return [];
    }

References ilDatePresentation\formatDate(), IL_CAL_UNIX, and ilDatePresentation\setUseRelativeDates().

Here is the call graph for this function:

getDefaultRole()

ilGroupMembershipGUI::getDefaultRole ( )

protected

Returns

int

Reimplemented from ilMembershipGUI.

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

    {
        return $this->getParentGUI()->object->getDefaultMemberRole();
    }

References ilMembershipGUI\getParentGUI().

Here is the call graph for this function:

getLocalTypeRole()

ilGroupMembershipGUI::getLocalTypeRole

(

$a_translation = false

)

Todo:

refactor delete

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

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

References ilMembershipGUI\getParentObject().

Here is the call graph for this function:

getMailContextOptions()

ilGroupMembershipGUI::getMailContextOptions ( )

protected

Returns

array

Reimplemented from ilMembershipGUI.

Definition at line 257 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, 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 23 of file class.ilGroupMembershipGUI.php.

    {
        return new ilMailMemberGroupRoles();
    }

getPrintMemberData()

ilGroupMembershipGUI::getPrintMemberData

(

$a_members

)

Parameters

array

$a_members

Returns

array

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

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

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

Here is the call graph for this function:

initEditParticipantTableGUI()

ilGroupMembershipGUI::initEditParticipantTableGUI ( array  $participants )

protected

init edit participants table gui

Parameters

array

$participants

Returns

\ilGroupEditParticipantsTableGUI

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

    {
        include_once './Modules/Group/classes/class.ilGroupEditParticipantsTableGUI.php';
        $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(), and ilMembershipGUI\readMemberData().

Here is the call graph for this function:

initParticipantTableGUI()

ilGroupMembershipGUI::initParticipantTableGUI ( )

protected

Returns

\ilParticpantTableGUI

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

    {
        include_once './Services/Tracking/classes/class.ilObjUserTracking.php';
        $show_tracking =
            (ilObjUserTracking::_enabledLearningProgress() && ilObjUserTracking::_enabledUserRelatedData())
        ;
        if ($show_tracking) {
            include_once('./Services/Object/classes/class.ilObjectLP.php');
            $olp = ilObjectLP::getInstance($this->getParentObject()->getId());
            $show_tracking = $olp->isActive();
        }
 
        include_once './Modules/Group/classes/class.ilGroupParticipantsTableGUI.php';
        return new ilGroupParticipantsTableGUI(
            $this,
            $this->getParentObject(),
            $show_tracking
        );
    }

References ilObjUserTracking\_enabledLearningProgress(), ilObjUserTracking\_enabledUserRelatedData(), ilObjectLP\getInstance(), and ilMembershipGUI\getParentObject().

Here is the call graph for this function:

initParticipantTemplate()

ilGroupMembershipGUI::initParticipantTemplate ( )

protected

Init participant view template.

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

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

initWaitingList()

ilGroupMembershipGUI::initWaitingList ( )

protected

init waiting list

Returns

ilGroupWaitingList

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

    {
        include_once './Modules/Group/classes/class.ilGroupWaitingList.php';
        $wait = new ilGroupWaitingList($this->getParentObject()->getId());
        return $wait;
    }

References ilMembershipGUI\getParentObject().

Here is the call graph for this function:

updateLPFromStatus()

ilGroupMembershipGUI::updateLPFromStatus ( )

protected

Update lp from status.

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

    {
        return null;
    }

updateParticipantsStatus()

ilGroupMembershipGUI::updateParticipantsStatus ( )

protected

save in participants table

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

    {
        $participants = (array) $_POST['visible_member_ids'];
        $notification = (array) $_POST['notification'];
        $contact = (array) $_POST['contact'];
 
        ilLoggerFactory::getLogger('grp')->dump($contact);
 
        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);
            }
        }
        ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, 'participants');
    }

References $_POST, ilLoggerFactory\getLogger(), and ilMembershipGUI\getMembersObject().

Here is the call graph for this function:

---

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

• Modules/Group/classes/class.ilGroupMembershipGUI.php