GUI class for membership features. More...

Inheritance diagram for ilGroupMembershipGUI:

Collaboration diagram for ilGroupMembershipGUI:

Public Member Functions
	assignMembers ($user_ids, $a_type)
	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...

	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 type $rbacsystem type $ilErr. More...

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

	assignFromWaitingList ()
	Assign from waiting list type $rbacsystem. More...

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

Protected Member Functions
	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 ()

Protected Member Functions inherited from ilMembershipGUI
	checkPermissionBool ($a_permission, $a_cmd='', $a_type='', $a_ref_id=0)
	Check permission. 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...

	membersMap ()
	Members map. More...

	mailMembersBtn ()
	Mail to members view type $ilToolbar. More...

	showParticipantsToolbar ()
	Show participants toolbar. More...

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

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

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

	refuseSubscribers ()
	Refuse subscribers 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...

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

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

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

Member Function Documentation

◆ assignMembers()

ilGroupMembershipGUI::assignMembers	(	$user_ids,
		$a_type
	)

public

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

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

         {
                 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');
         }

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

References $data.

         {               
                 $data = $this->member_data[$a_user_id];
                 
                 $this->logger->dump($data);
                 
                 $data['access'] = $data['access_time'];
                 $data['progress'] = $this->lng->txt($data['progress']);
                 
                 return $data;
         }

◆ getDefaultRole()

ilGroupMembershipGUI::getDefaultRole ( )

protected

Returns: int

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

References ilMembershipGUI\getParentGUI().

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

Here is the call graph for this function:

◆ getLocalTypeRole()

ilGroupMembershipGUI::getLocalTypeRole ( $a_translation = false )

Todo:: refactor delete

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

References ilMembershipGUI\getParentObject().

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

Here is the call graph for this function:

◆ getPrintMemberData()

ilGroupMembershipGUI::getPrintMemberData ( $a_members )

Parameters

array $a_members

Returns: array

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

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

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

Here is the call graph for this function:

◆ initEditParticipantTableGUI()

ilGroupMembershipGUI::initEditParticipantTableGUI ( array $participants )

protected

init edit participants table gui

Parameters

array $participants

Returns

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

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

         {
                 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;
         }

Here is the call graph for this function:

◆ initParticipantTableGUI()

ilGroupMembershipGUI::initParticipantTableGUI ( )

protected

Returns

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

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

         {
                 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
                 );
         }

Here is the call graph for this function:

◆ initParticipantTemplate()

ilGroupMembershipGUI::initParticipantTemplate ( )

protected

Init participant view template.

Definition at line 161 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 186 of file class.ilGroupMembershipGUI.php.

References ilMembershipGUI\getParentObject().

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

Here is the call graph for this function:

◆ updateLPFromStatus()

ilGroupMembershipGUI::updateLPFromStatus ( )

protected

Update lp from status.

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

         {
                 return null;
         }

◆ updateParticipantsStatus()

ilGroupMembershipGUI::updateParticipantsStatus ( )

protected

save in participants table

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

References $_POST, array, ilMembershipGUI\getMembersObject(), and ilUtil\sendSuccess().

         {
                 $participants = (array) $_POST['visible_member_ids'];
                 $notification = (array) $_POST['notification'];
                 foreach($participants as $mem_id)
                 {
                         if($this->getMembersObject()->isAdmin($mem_id))
                         {
                                 $this->getMembersObject()->updateNotification($mem_id, in_array($mem_id, $notification));
                         }
                         else
                         {
                                 $this->getMembersObject()->updateNotification($mem_id, false);
                         }
                 }
                 ilUtil::sendSuccess($this->lng->txt('settings_saved'),true);
                 $this->ctrl->redirect($this, 'participants');
         }

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ assignMembers()

◆ getAttendanceListUserData()

◆ getDefaultRole()

◆ getLocalTypeRole()

◆ getPrintMemberData()

◆ initEditParticipantTableGUI()

◆ initParticipantTableGUI()

◆ initParticipantTemplate()

◆ initWaitingList()

◆ updateLPFromStatus()

◆ updateParticipantsStatus()