GUI class for membership features. More...

Inheritance diagram for ilSessionMembershipGUI:

Collaboration diagram for ilSessionMembershipGUI:

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

	getPrintMemberData (array $a_members)

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

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

	checkRbacOrPositionAccessBool (string $a_rbac_perm, string $a_pos_perm, int $a_ref_id=0)
	No support for positions in sessions Check if rbac or position access is granted. More...

	initParticipantTemplate ()

	initWaitingList ()

	initParticipantTableGUI ()

	getParticipantTableTitle ()

	initSubscriberTable ()

	updateMembers ()

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

	deleteParticipants ()

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

	getMemberTabName ()

	getMailButtonLabel ()

	getMailContextOptions ()

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
array	$requested_visible_participants = []

array	$requested_participated = []

array	$requested_registered = []

array	$requested_contact = []

array	$requested_excused = []

array	$requested_mark = []

array	$requested_comment = []

array	$requested_notification = []

array	$requested_participants = []

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 ilSessionMembershipGUI: ilMailMemberSearchGUI, ilUsersGalleryGUI, ilRepositorySearchGUI @ilCtrl_Calls ilSessionMembershipGUI: ilSessionOverviewGUI @ilCtrl_Calls ilSessionMembershipGUI: ilMemberExportGUI

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

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ilMembershipGUI.

Definition at line 43 of file class.ilSessionMembershipGUI.php.

    {
        parent::__construct($repository_gui, $repository_obj);
 
        if ($this->http->wrapper()->post()->has('visible_participants')) {
            $this->requested_visible_participants = (array) $this->http->wrapper()->post()->retrieve(
                'visible_participants',
                $this->refinery->custom()->transformation(function ($v) {
                    return $v;
                })
            );
        } elseif ($this->http->wrapper()->query()->has('visible_participants')) {
            $this->requested_visible_participants = (array) $this->http->wrapper()->query()->retrieve(
                'visible_participants',
                $this->refinery->custom()->transformation(function ($v) {
                    return $v;
                })
            );
        }
 
        if ($this->http->wrapper()->post()->has('participated')) {
            $this->requested_participated = (array) $this->http->wrapper()->post()->retrieve(
                'participated',
                $this->refinery->custom()->transformation(function ($v) {
                    return $v;
                })
            );
        }
 
        if ($this->http->wrapper()->post()->has('registered')) {
            $this->requested_registered = (array) $this->http->wrapper()->post()->retrieve(
                'registered',
                $this->refinery->custom()->transformation(function ($v) {
                    return $v;
                })
            );
        }
 
        if ($this->http->wrapper()->post()->has('contact')) {
            $this->requested_contact = (array) $this->http->wrapper()->post()->retrieve(
                'contact',
                $this->refinery->custom()->transformation(function ($v) {
                    return $v;
                })
            );
        }
 
        if ($this->http->wrapper()->post()->has('excused')) {
            $this->requested_excused = (array) $this->http->wrapper()->post()->retrieve(
                'excused',
                $this->refinery->custom()->transformation(function ($v) {
                    return $v;
                })
            );
        }
 
        if ($this->http->wrapper()->post()->has('mark')) {
            $this->requested_mark = (array) $this->http->wrapper()->post()->retrieve(
                'mark',
                $this->refinery->custom()->transformation(function ($v) {
                    return $v;
                })
            );
        }
 
        if ($this->http->wrapper()->post()->has('comment')) {
            $this->requested_comment = (array) $this->http->wrapper()->post()->retrieve(
                'comment',
                $this->refinery->custom()->transformation(function ($v) {
                    return $v;
                })
            );
        }
 
        if ($this->http->wrapper()->post()->has('notification')) {
            $this->requested_notification = (array) $this->http->wrapper()->post()->retrieve(
                'notification',
                $this->refinery->custom()->transformation(function ($v) {
                    return $v;
                })
            );
        }
 
        if ($this->http->wrapper()->post()->has('participants')) {
            $this->requested_participants = (array) $this->http->wrapper()->post()->retrieve(
                'participants',
                $this->refinery->custom()->transformation(function ($v) {
                    return $v;
                })
            );
        }
    }

References 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

◆ canAddOrSearchUsers()

ilSessionMembershipGUI::canAddOrSearchUsers ( )

protected

Check if current user is allowed to add / search users.

Reimplemented from ilMembershipGUI.

Definition at line 328 of file class.ilSessionMembershipGUI.php.

                                            : bool
    {
        return false;
    }

◆ checkRbacOrPositionAccessBool()

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

protected

No support for positions in sessions Check if rbac or position access is granted.

Reimplemented from ilMembershipGUI.

Definition at line 145 of file class.ilSessionMembershipGUI.php.

                                                                                                                : bool
    {
        if (!$a_ref_id) {
            $a_ref_id = $this->getParentObject()->getRefId();
        }
        return $this->checkPermissionBool($a_rbac_perm, "", "", $a_ref_id);
    }

References ilMembershipGUI\checkPermissionBool(), and ilMembershipGUI\getParentObject().

Here is the call graph for this function:

◆ confirmDeleteParticipants()

ilSessionMembershipGUI::confirmDeleteParticipants ( )

protected

Show confirmation screen for participants deletion.

Reimplemented from ilMembershipGUI.

Definition at line 263 of file class.ilSessionMembershipGUI.php.

                                                  : void
    {
        $participants = $this->requested_participants;
 
        if (!count($participants)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_checkbox'), true);
            $this->ctrl->redirect($this, 'participants');
        }
 
        $confirm = new ilConfirmationGUI();
        $confirm->setFormAction($this->ctrl->getFormAction($this, 'confirmDeleteParticipants'));
        $confirm->setHeaderText($this->lng->txt($this->getParentObject()->getType() . '_header_delete_members'));
        $confirm->setConfirm($this->lng->txt('confirm'), 'deleteParticipants');
        $confirm->setCancel($this->lng->txt('cancel'), 'participants');
 
        foreach ($participants as $usr_id) {
            $name = ilObjUser::_lookupName($usr_id);
 
            $confirm->addItem(
                'participants[]',
                $name['user_id'],
                $name['lastname'] . ', ' . $name['firstname'] . ' [' . $name['login'] . ']',
                ilUtil::getImagePath('standard/icon_usr.svg')
            );
        }
 
        $this->tpl->setContent($confirm->getHTML());
    }

References ilMembershipGUI\$participants, $requested_participants, ilObjUser\_lookupName(), ILIAS\Repository\ctrl(), ilUtil\getImagePath(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ deleteParticipants()

ilSessionMembershipGUI::deleteParticipants ( )

protected

Reimplemented from ilMembershipGUI.

Definition at line 292 of file class.ilSessionMembershipGUI.php.

                                           : void
    {
        $this->checkPermission('manage_members');
 
        $participants = $this->requested_participants;
 
        if (!is_array($participants) || !count($participants)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, 'participants');
        }
 
        foreach ($participants as $part_id) {
            // delete role assignment
            $this->getMembersObject()->delete($part_id);
            // delete further settings
            $event_part = new ilEventParticipants($this->getParentObject()->getId());
            $event_part->setUserId($part_id);
            $event_part->setParticipated(false);
            $event_part->setRegistered(false);
            $event_part->setMark('');
            $event_part->setComment('');
            $event_part->updateUser();
        }
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt($this->getParentObject()->getType() . "_members_deleted"), true);
        $this->ctrl->redirect($this, "participants");
    }

References ilMembershipGUI\$participants, $requested_participants, ilMembershipGUI\checkPermission(), ILIAS\Repository\ctrl(), ILIAS\Survey\Mode\getId(), ilMembershipGUI\getMembersObject(), ilMembershipGUI\getParentObject(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getAttendanceListUserData()

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

Reimplemented from ilMembershipGUI.

Definition at line 333 of file class.ilSessionMembershipGUI.php.

                                                                                : array
    {
        $data = $this->getMembersObject()->getEventParticipants()->getUser($user_id);
        $data['registered'] = (bool) ($data['registered'] ?? false);
        $data['participated'] = (bool) ($data['participated'] ?? false);
 
        if ($filters && $filters["registered"] && !$data["registered"]) {
            return [];
        }
 
 
        $data['registered'] = $data['registered'] ?
            $this->lng->txt('yes') :
            $this->lng->txt('no');
        $data['participated'] = $data['participated'] ?
            $this->lng->txt('yes') :
            $this->lng->txt('no');
 
        return $data;
    }

References $data, ilMembershipGUI\getMembersObject(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getMailButtonLabel()

ilSessionMembershipGUI::getMailButtonLabel ( )

protected

Reimplemented from ilMembershipGUI.

Definition at line 359 of file class.ilSessionMembershipGUI.php.

                                           : string
    {
        return $this->lng->txt("sess_mail_type");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getMailContextOptions()

ilSessionMembershipGUI::getMailContextOptions ( )

protected

Reimplemented from ilMembershipGUI.

Definition at line 364 of file class.ilSessionMembershipGUI.php.

                                              : array
    {
        $context_options = [
            ilMailFormCall::CONTEXT_KEY => ilSessionMailTemplateParticipantContext::ID,
            'ref_id' => $this->getParentObject()->getRefId(),
            'ts' => time()
        ];
 
        return $context_options;
    }

References ilMailFormCall\CONTEXT_KEY, ilMembershipGUI\getParentObject(), and ilSessionMailTemplateParticipantContext\ID.

Here is the call graph for this function:

◆ getMailMemberRoles()

ilSessionMembershipGUI::getMailMemberRoles ( )

protected

Reimplemented from ilMembershipGUI.

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

                                           : ?ilAbstractMailMemberRoles
    {
        return new ilMailMemberSessionRoles();
    }

◆ getMemberTabName()

ilSessionMembershipGUI::getMemberTabName ( )

protected

Reimplemented from ilMembershipGUI.

Definition at line 354 of file class.ilSessionMembershipGUI.php.

                                         : string
    {
        return $this->lng->txt($this->getParentObject()->getType() . '_members');
    }

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

Here is the call graph for this function:

◆ getParticipantTableTitle()

ilSessionMembershipGUI::getParticipantTableTitle ( )

protected

Reimplemented from ilMembershipGUI.

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

                                                 : string
    {
        /*
         * TODO this exact logic is also in ilSessionParticipantsTableGUI and ilMembershipGUI,
         *  should be centralized.
         */
        if ($member_ref = $this->tree->checkForParentType(
            $this->getParentObject()->getRefId(),
            'grp'
        )) {
            $member_ref_id = $member_ref;
        } elseif ($member_ref = $this->tree->checkForParentType(
            $this->getParentObject()->getRefId(),
            'crs'
        )) {
            $member_ref_id = $member_ref;
        } else {
            $this->logger->warning('Cannot find parent course or group for ref_id: ' . $this->getParentObject()->getRefId());
            $member_ref_id = $this->getParentObject()->getRefId();
        }
 
        return sprintf(
            $this->lng->txt('sess_mem_tbl_header'),
            ilObjectFactory::getInstanceByRefId($member_ref_id)->getTitle(),
        );
    }

References ilObjectFactory\getInstanceByRefId(), ilMembershipGUI\getParentObject(), ILIAS\Repository\lng(), and ILIAS\Repository\logger().

Here is the call graph for this function:

◆ getPrintMemberData()

ilSessionMembershipGUI::getPrintMemberData ( array $a_members )

Definition at line 320 of file class.ilSessionMembershipGUI.php.

                                                        : array
    {
        return $a_members;
    }

◆ initParticipantTableGUI()

ilSessionMembershipGUI::initParticipantTableGUI ( )

protected

Definition at line 173 of file class.ilSessionMembershipGUI.php.

                                                : ilSessionParticipantsTableGUI
    {
        $table = new ilSessionParticipantsTableGUI(
            $this,
            $this->getParentObject(),
            'participants'
        );
        $table->init();
        return $table;
    }

References ilMembershipGUI\getParentObject().

Here is the call graph for this function:

◆ initParticipantTemplate()

ilSessionMembershipGUI::initParticipantTemplate ( )

protected

Definition at line 153 of file class.ilSessionMembershipGUI.php.

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

◆ initSubscriberTable()

ilSessionMembershipGUI::initSubscriberTable ( )

protected

Reimplemented from ilMembershipGUI.

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

                                            : ilSubscriberTableGUI
    {
        $subscriber = new ilSubscriberTableGUI($this, $this->getParentObject(), true, false);
        $subscriber->setTitle($this->lng->txt('group_new_registrations'));
        return $subscriber;
    }

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

Here is the call graph for this function:

◆ initWaitingList()

ilSessionMembershipGUI::initWaitingList ( )

protected

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

                                        : ilSessionWaitingList
    {
        $wait = new ilSessionWaitingList($this->getParentObject()->getId());
        return $wait;
    }

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

Here is the call graph for this function:

◆ updateMembers()

ilSessionMembershipGUI::updateMembers ( )

protected

Definition at line 218 of file class.ilSessionMembershipGUI.php.

                                      : void
    {
        $this->checkPermission('manage_members');
 
        $part = ilParticipants::getInstance($this->getParentObject()->getRefId());
 
 
        $wait = new ilSessionWaitingList($this->getParentObject()->getId());
        $waiting = $wait->getUserIds();
 
        foreach ($this->requested_visible_participants as $part_id) {
            if (in_array($part_id, $waiting)) {
                // so not update users on waiting list
                continue;
            }
 
            $participated = (bool) ($this->requested_participated[$part_id] ?? false);
            $registered = (bool) ($this->requested_registered[$part_id] ?? false);
            $contact = (bool) ($this->requested_contact[$part_id] ?? false);
            $excused = (bool) ($this->requested_excused[$part_id] ?? false);
 
            $part_id = (int) $part_id;
 
            if ($part->isAssigned($part_id) && !$participated && !$registered) {
                $part->delete($part_id);
            }
            if (!$part->isAssigned($part_id) && ($participated || $registered)) {
                $part->add($part_id, ilParticipants::IL_SESS_MEMBER);
            }
            $event_part = new ilEventParticipants($this->getParentObject()->getId());
            $event_part->setUserId($part_id);
            $event_part->setMark(ilUtil::stripSlashes($this->requested_mark[$part_id]));
            $event_part->setComment(ilUtil::stripSlashes($this->requested_comment[$part_id]));
            $event_part->setNotificationEnabled((bool) ($this->requested_notification[$part_id] ?? false));
            $event_part->setParticipated($participated);
            $event_part->setRegistered($registered);
            $event_part->setContact($contact);
            $event_part->setExcused($excused);
            $event_part->updateUser();
        }
 
        $this->tpl->setOnScreenMessage('success', $this->getLanguage()->txt('settings_saved'), true);
        $this->getCtrl()->redirect($this, 'participants');
    }