ilSessionMembershipGUI Class Reference

GUI class for membership features. More...

Inheritance diagram for ilSessionMembershipGUI:

Collaboration diagram for ilSessionMembershipGUI:

Public Member Functions
	getPrintMemberData ($a_members)
	getAttendanceListUserData ($a_user_id, $a_filters)
	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 ()
	checkRbacOrPositionAccessBool ($a_rbac_perm, $a_pos_perm, $a_ref_id=0)
	No support for positions in sessions Check if rbac or position access is granted. More...
	initParticipantTemplate ()
	Init participant view template. More...
	initWaitingList ()
	init waiting list More...
	initParticipantTableGUI ()
	initSubscriberTable ()
	updateMembers ()
	update entries from member table More...
	confirmDeleteParticipants ()
	Show confirmation screen for participants deletion. More...
	deleteParticipants ()
	Delete participants @global type $rbacreview @global type $rbacsystem @global type $ilAccess @global type $ilUser. More...
	canAddOrSearchUsers ()
	Check if current user is allowed to add / search users. Returns bool More...
	getMemberTabName ()
	Get member tab name. More...
	getMailContextOptions ()
	Get mail context options. 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 ()
	Get mail context options. More...
	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 ilSessionMembershipGUI: ilMailMemberSearchGUI, ilUsersGalleryGUI, ilRepositorySearchGUI @ilCtrl_Calls ilSessionMembershipGUI: ilSessionOverviewGUI @ilCtrl_Calls ilSessionMembershipGUI: ilMemberExportGUI

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

Member Function Documentation

canAddOrSearchUsers()

ilSessionMembershipGUI::canAddOrSearchUsers ( )

protected

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

Returns

bool

Reimplemented from ilMembershipGUI.

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

    {
        return false;
    }

checkRbacOrPositionAccessBool()

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

protected

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

Parameters

string	$a_rbac_perm
string	$a_pos_perm
int	$a_ref_id

Reimplemented from ilMembershipGUI.

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

    {
        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 139 of file class.ilSessionMembershipGUI.php.

    {
        $participants = (array) $_POST['participants'];
        
        if (!count($participants)) {
            ilUtil::sendFailure($this->lng->txt('no_checkbox'), true);
            $this->ctrl->redirect($this, 'participants');
        }
 
        include_once('./Services/Utilities/classes/class.ilConfirmationGUI.php');
        $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('icon_usr.svg')
            );
        }
        
        $this->tpl->setContent($confirm->getHTML());
    }

References $_POST, $name, ilObjUser\_lookupName(), ilUtil\getImagePath(), and ilUtil\sendFailure().

Here is the call graph for this function:

deleteParticipants()

ilSessionMembershipGUI::deleteParticipants ( )

protected

Delete participants @global type $rbacreview @global type $rbacsystem @global type $ilAccess @global type $ilUser.

Returns

boolean

Reimplemented from ilMembershipGUI.

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

    {
        $this->checkPermission('manage_members');
                
        $participants = (array) $_POST['participants'];
        
        if (!is_array($participants) or !count($participants)) {
            ilUtil::sendFailure($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();
        }
        
        ilUtil::sendSuccess($this->lng->txt($this->getParentObject()->getType() . "_members_deleted"), true);
        $this->ctrl->redirect($this, "participants");
 
        return true;
    }

References $_POST, ilMembershipGUI\checkPermission(), ilMembershipGUI\getMembersObject(), ilMembershipGUI\getParentObject(), and ilUtil\sendFailure().

Here is the call graph for this function:

getAttendanceListUserData()

ilSessionMembershipGUI::getAttendanceListUserData	(		$a_user_id,
			$a_filters
	)

Callback from attendance list.

Parameters

int

$a_user_id

Returns

array

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

    {
        $data = $this->getMembersObject()->getEventParticipants()->getUser($a_user_id);
        
        if ($a_filters && $a_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, and ilMembershipGUI\getMembersObject().

Here is the call graph for this function:

getMailContextOptions()

ilSessionMembershipGUI::getMailContextOptions ( )

protected

Get mail context options.

Returns

array

Reimplemented from ilMembershipGUI.

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

    {
        $context_options = [];
 
        $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

Returns

ilAbstractMailMemberRoles|null

Reimplemented from ilMembershipGUI.

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

    {
        return new ilMailMemberSessionRoles();
    }

getMemberTabName()

ilSessionMembershipGUI::getMemberTabName ( )

protected

Get member tab name.

Returns

string

Reimplemented from ilMembershipGUI.

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

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

References ilMembershipGUI\getParentObject().

Here is the call graph for this function:

getPrintMemberData()

ilSessionMembershipGUI::getPrintMemberData

(

$a_members

)

Parameters

array

$a_members

Returns

array

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

    {
        return $a_members;
    }

initParticipantTableGUI()

ilSessionMembershipGUI::initParticipantTableGUI ( )

protected

Returns

\ilParticpantTableGUI

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

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

References $table, and ilMembershipGUI\getParentObject().

Here is the call graph for this function:

initParticipantTemplate()

ilSessionMembershipGUI::initParticipantTemplate ( )

protected

Init participant view template.

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

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

initSubscriberTable()

ilSessionMembershipGUI::initSubscriberTable ( )

protected

Returns

\ilSubscriberTableGUI

Reimplemented from ilMembershipGUI.

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

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

References ilMembershipGUI\getParentObject().

Here is the call graph for this function:

initWaitingList()

ilSessionMembershipGUI::initWaitingList ( )

protected

init waiting list

Returns

ilGroupWaitingList

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

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

References ilMembershipGUI\getParentObject().

Here is the call graph for this function:

updateMembers()

ilSessionMembershipGUI::updateMembers ( )

protected

update entries from member table

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

    {
        $this->checkPermission('manage_members');
        
        $part = ilParticipants::getInstance($this->getParentObject()->getRefId());
 
 
        $wait = new ilSessionWaitingList($this->getParentObject()->getId());
        $waiting = $wait->getUserIds();
 
        foreach ((array) $_REQUEST['visible_participants'] as $part_id) {
            if (in_array($part_id, $waiting)) {
                // so not update users on waiting list
                continue;
            }
 
            $participated = (bool) $_POST['participated'][$part_id];
            $registered = (bool) $_POST['registered'][$part_id];
            $contact = (bool) $_POST['contact'][$part_id];
            
            if ($part->isAssigned($part_id)) {
                if (!$participated && !$registered && !$contact) {
                    $part->delete($part_id);
                }
            } else {
                if ($participated || $registered || $contact) {
                    $part->add($part_id, IL_SESS_MEMBER);
                }
            }
            $event_part = new ilEventParticipants($this->getParentObject()->getId());
            $event_part->setUserId($part_id);
            $event_part->setMark(ilUtil::stripSlashes($_POST['mark'][$part_id]));
            $event_part->setComment(ilUtil::stripSlashes($_POST['comment'][$part_id]));
            $event_part->setParticipated($participated);
            $event_part->setRegistered($registered);
            $event_part->setContact($contact);
            $event_part->updateUser();
        }
        
        ilUtil::sendSuccess($this->getLanguage()->txt('settings_saved'), true);
        $this->getCtrl()->redirect($this, 'participants');
    }

References $_POST, ilMembershipGUI\checkPermission(), ilMembershipGUI\getCtrl(), ilParticipants\getInstance(), ilMembershipGUI\getLanguage(), ilMembershipGUI\getParentObject(), IL_SESS_MEMBER, and ilUtil\stripSlashes().

Here is the call graph for this function:

---

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

• Modules/Session/classes/class.ilSessionMembershipGUI.php