GUI class for learning sequence membership features. More...

Inheritance diagram for ilLearningSequenceMembershipGUI:

Collaboration diagram for ilLearningSequenceMembershipGUI:

Public Member Functions
	__construct (ilObjectGUI $repository_gui, ilObject $obj, ilObjUserTracking $obj_user_tracking, ilPrivacySettings $privacy_settings, ilRbacReview $rbac_review, ilSetting $settings, ilToolbarGUI $toolbar, ILIAS\HTTP\Wrapper\RequestWrapper $request_wrapper, ArrayBasedRequestWrapper $post_wrapper, ILIAS\Refinery\Factory $refinery)

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

	assignMembers (array $user_ids, string $type)

	getParentObject ()

	getLocalTypeRole (bool $translation=false)

	readMemberData (array $usr_ids, array $columns=null)

	getPrintMemberData (array $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
	printMembers ()

	getDefaultCommand ()

	updateParticipantsStatus ()
	save in participants table More...

	initParticipantTableGUI ()

	initEditParticipantTableGUI (array $participants)

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

	initWaitingList ()

	getDefaultRole ()

	getMailMemberRoles ()

	setSubTabs (ilTabsGUI $tabs)

	showParticipantsToolbar ()

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...

	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...

	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
ilObjectGUI	$repository_gui

ilObject	$obj

ilObjUserTracking	$obj_user_tracking

ilPrivacySettings	$privacy_settings

ilRbacReview	$rbac_review

ilSetting	$settings

ilToolbarGUI	$toolbar

ILIAS HTTP Wrapper RequestWrapper	$request_wrapper

ArrayBasedRequestWrapper	$post_wrapper

ILIAS Refinery 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

array	$member_data = []

Detailed Description

GUI class for learning sequence membership features.

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

Definition at line 32 of file class.ilLearningSequenceMembershipGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilLearningSequenceMembershipGUI::__construct	(	ilObjectGUI	$repository_gui,
		ilObject	$obj,
		ilObjUserTracking	$obj_user_tracking,
		ilPrivacySettings	$privacy_settings,
		ilRbacReview	$rbac_review,
		ilSetting	$settings,
		ilToolbarGUI	$toolbar,
		ILIAS\HTTP\Wrapper\RequestWrapper	$request_wrapper,
		ArrayBasedRequestWrapper	$post_wrapper,
		ILIAS\Refinery\Factory	$refinery
	)

Definition at line 45 of file class.ilLearningSequenceMembershipGUI.php.

References $obj, $obj_user_tracking, $post_wrapper, $privacy_settings, $rbac_review, $refinery, $request_wrapper, $settings, $toolbar, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), and ILIAS\Repository\toolbar().

       {
         parent::__construct($repository_gui, $obj);
 
         $this->obj = $obj;
         $this->obj_user_tracking = $obj_user_tracking;
         $this->privacy_settings = $privacy_settings;
         $this->rbac_review = $rbac_review;
         $this->settings = $settings;
         $this->toolbar = $toolbar;
         $this->request_wrapper = $request_wrapper;
         $this->post_wrapper = $post_wrapper;
         $this->refinery = $refinery;
     }

Here is the call graph for this function:

Member Function Documentation

◆ assignMembers()

ilLearningSequenceMembershipGUI::assignMembers	(	array	$user_ids,
		string	$type
	)

Parameters

array<int> $user_ids

Definition at line 116 of file class.ilLearningSequenceMembershipGUI.php.

References ILIAS\Repository\ctrl(), ilLoggerFactory\getLogger(), getParentObject(), ilParticipants\IL_LSO_ADMIN, ilParticipants\IL_LSO_MEMBER, ILIAS\Repository\int(), ILIAS\Repository\lng(), and ilLearningSequenceMembershipMailNotification\TYPE_ADMISSION_MEMBER.

                                                                 : bool
     {
         $object = $this->getParentObject();
         $members = $this->getParentObject()->getLSParticipants();
 
         if (count($user_ids) == 0) {
             $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 ($members->isAssigned($new_member)) {
                 continue;
             }
 
             switch ($type) {
                 case $object->getDefaultAdminRole():
                     $members->add($new_member, ilParticipants::IL_LSO_ADMIN);
                     $members->sendNotification(
                         ilLearningSequenceMembershipMailNotification::TYPE_ADMISSION_MEMBER,
                         $new_member
                     );
                     $assigned = true;
                     break;
                 case $object->getDefaultMemberRole():
                     $members->add($new_member, ilParticipants::IL_LSO_MEMBER);
                     $members->sendNotification(
                         ilLearningSequenceMembershipMailNotification::TYPE_ADMISSION_MEMBER,
                         $new_member
                     );
                     $assigned = true;
                     break;
                 default:
                     if (in_array($type, $object->getLocalLearningSequenceRoles(true))) {
                         $members->add($new_member, ilParticipants::IL_LSO_MEMBER);
                         $members->updateRoleAssignments($new_member, array($type));
                     } else {
                         ilLoggerFactory::getLogger('lso')->notice(
                             'Can not find role with id .' . $type . ' to assign users.'
                         );
                         $this->tpl->setOnScreenMessage('failure', $this->lng->txt("lso_cannot_find_role"), true);
                         return false;
                     }
 
                     $members->sendNotification(
                         ilLearningSequenceMembershipMailNotification::TYPE_ADMISSION_MEMBER,
                         $new_member
                     );
                     $assigned = true;
                     break;
             }
         }
 
         if ($assigned) {
             $this->tpl->setOnScreenMessage('success', $this->lng->txt("lso_msg_member_assigned"), true);
         } else {
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('lso_users_already_assigned'), true);
         }
 
         $this->ctrl->redirect($this, 'participants');
         return $assigned;
     }

Here is the call graph for this function:

◆ filterUserIdsByRbacOrPositionOfCurrentUser()

ilLearningSequenceMembershipGUI::filterUserIdsByRbacOrPositionOfCurrentUser ( array $a_user_ids )

Filter user ids by access.

Parameters

int[] $a_user_ids

Returns: int[]

Definition at line 103 of file class.ilLearningSequenceMembershipGUI.php.

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

Referenced by getAttendanceListUserData().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAttendanceListUserData()

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

Returns: array<string, mixed>

Definition at line 303 of file class.ilLearningSequenceMembershipGUI.php.

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

                                                                                 : array
     {
         $data = array();
 
         if ($this->filterUserIdsByRbacOrPositionOfCurrentUser([$user_id])) {
             $data = $this->member_data[$user_id];
             if (array_key_exists('access_time', $data)) {
                 $data['access'] = $data['access_time'];
             }
             $data['progress'] = $this->lng->txt($data['progress']);
         }
 
         return $data;
     }

Here is the call graph for this function:

◆ getDefaultCommand()

ilLearningSequenceMembershipGUI::getDefaultCommand ( )

protected

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

References $refinery.

                                           : string
     {
         $r = $this->refinery;
         return $this->request_wrapper->retrieve("back_cmd", $r->byTrying([$r->kindlyTo()->string(), $r->always("members")]));
     }

◆ getDefaultRole()

ilLearningSequenceMembershipGUI::getDefaultRole ( )

protected

Definition at line 285 of file class.ilLearningSequenceMembershipGUI.php.

References getParentObject().

Referenced by showParticipantsToolbar().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLocalTypeRole()

ilLearningSequenceMembershipGUI::getLocalTypeRole ( bool $translation = false )

Returns: array<string, int>

Definition at line 264 of file class.ilLearningSequenceMembershipGUI.php.

References getParentObject().

                                                                : array
     {
         return $this->getParentObject()->getLocalLearningSequenceRoles($translation);
     }

Here is the call graph for this function:

◆ getMailMemberRoles()

ilLearningSequenceMembershipGUI::getMailMemberRoles ( )

protected

Definition at line 318 of file class.ilLearningSequenceMembershipGUI.php.

                                            : ?ilAbstractMailMemberRoles
     {
         return new ilMailMemberLearningSequenceRoles();
     }

◆ getParentObject()

ilLearningSequenceMembershipGUI::getParentObject ( )

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

References $obj.

Referenced by assignMembers(), filterUserIdsByRbacOrPositionOfCurrentUser(), getDefaultRole(), getLocalTypeRole(), initEditParticipantTableGUI(), initParticipantTableGUI(), initWaitingList(), readMemberData(), setSubTabs(), and updateParticipantsStatus().

                                      : ilObjLearningSequence
     {
         $obj = parent::getParentObject();
         if (!$obj instanceof ilObjLearningSequence) {
             throw new Exception('Invalid class type ' . get_class($obj) . ". Expected ilObjLearningSequence.");
         }
         return $obj;
     }

Here is the caller graph for this function:

◆ getPrintMemberData()

ilLearningSequenceMembershipGUI::getPrintMemberData ( array $members )

Returns: array<string, mixed>

Definition at line 293 of file class.ilLearningSequenceMembershipGUI.php.

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

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

Here is the call graph for this function:

◆ initEditParticipantTableGUI()

ilLearningSequenceMembershipGUI::initEditParticipantTableGUI ( array $participants )

protected

Definition at line 238 of file class.ilLearningSequenceMembershipGUI.php.

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

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

Here is the call graph for this function:

◆ initParticipantTableGUI()

ilLearningSequenceMembershipGUI::initParticipantTableGUI ( )

protected

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

References ILIAS\Repository\access(), getParentObject(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

                                                 : ilLearningSequenceParticipantsTableGUI
     {
         return new ilLearningSequenceParticipantsTableGUI(
             $this,
             $this->getParentObject(),
             $this->obj_user_tracking,
             $this->privacy_settings,
             $this->lng,
             $this->access,
             $this->rbac_review,
             $this->settings
         );
     }

Here is the call graph for this function:

◆ initParticipantTemplate()

ilLearningSequenceMembershipGUI::initParticipantTemplate ( )

protected

Init participant view template.

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

                                                 : void
     {
         $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.lso_edit_members.html', 'Modules/LearningSequence');
     }

◆ initWaitingList()

ilLearningSequenceMembershipGUI::initWaitingList ( )

protected

Definition at line 280 of file class.ilLearningSequenceMembershipGUI.php.

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

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

Here is the call graph for this function:

◆ printMembers()

ilLearningSequenceMembershipGUI::printMembers ( )

protected

Definition at line 70 of file class.ilLearningSequenceMembershipGUI.php.

References $DIC, ilMembershipGUI\checkPermission(), ilMembershipGUI\checkRbacOrPositionAccessBool(), ILIAS\Repository\ctrl(), ilMembershipGUI\initAttendanceList(), and ILIAS\Repository\lng().

                                      : void
     {
         $this->checkPermission('read');
         if ($this->checkRbacOrPositionAccessBool('manage_members', 'manage_members')) {
             $back_cmd = 'participants';
         } else {
             $back_cmd = 'jump2UsersGallery';
         }
 
         global $DIC;
         $ilTabs = $DIC['ilTabs'];
         $ilTabs->clearTargets();
         $ilTabs->setBackTarget(
             $this->lng->txt('back'),
             $this->ctrl->getLinkTarget($this, $back_cmd)
         );
 
         $list = $this->initAttendanceList();
         $form = $list->initForm('printMembersOutput');
         $this->tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

◆ readMemberData()

ilLearningSequenceMembershipGUI::readMemberData	(	array	$usr_ids,
		array	$columns = `null`
	)

Parameters

array<int\|string>	$user_ids
string[]	$columns

Returns: array<int|string, array>

Definition at line 274 of file class.ilLearningSequenceMembershipGUI.php.

References getParentObject().

Referenced by getPrintMemberData(), and initEditParticipantTableGUI().

                                                                          : array
     {
         return $this->getParentObject()->readMemberData($usr_ids, $columns);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSubTabs()

ilLearningSequenceMembershipGUI::setSubTabs ( ilTabsGUI $tabs )

protected

Definition at line 323 of file class.ilLearningSequenceMembershipGUI.php.

References ilMembershipGUI\$access, ilTabsGUI\addSubTabTarget(), ilMembershipGUI\checkRbacOrPositionAccessBool(), ILIAS\Repository\ctrl(), and getParentObject().

                                                   : void
     {
         $access = $this->checkRbacOrPositionAccessBool(
             'manage_members',
             'manage_members',
             $this->getParentObject()->getRefId()
         );
 
         if ($access) {
             $tabs->addSubTabTarget(
                 $this->getParentObject()->getType() . "_member_administration",
                 $this->ctrl->getLinkTarget($this, 'participants'),
                 "members",
                 get_class($this)
             );
 
             $tabs->addSubTabTarget(
                 $this->getParentObject()->getType() . '_members_gallery',
                 $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilUsersGalleryGUI')),
                 'view',
                 'ilUsersGalleryGUI'
             );
         } elseif ($this->getParentObject()->getShowMembers()) {
             $tabs->addSubTabTarget(
                 $this->getParentObject()->getType() . '_members_gallery',
                 $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilUsersGalleryGUI')),
                 'view',
                 'ilUsersGalleryGUI'
             );
         }
     }

Here is the call graph for this function:

◆ showParticipantsToolbar()

ilLearningSequenceMembershipGUI::showParticipantsToolbar ( )

protected

Definition at line 355 of file class.ilLearningSequenceMembershipGUI.php.

References ILIAS\Repository\ctrl(), ilRepositorySearchGUI\fillAutoCompleteToolbar(), getDefaultRole(), ilMembershipGUI\getParentGUI(), ILIAS\Repository\lng(), ilMembershipGUI\showMailToMemberToolbarButton(), and ILIAS\Repository\toolbar().

                                                 : void
     {
         $toolbar_entries = [
             'auto_complete_name' => $this->lng->txt('user'),
             'user_type' => $this->getParentGUI()->getLocalRoles(),
             'user_type_default' => $this->getDefaultRole(),
             'submit_name' => $this->lng->txt('add'),
             'add_search' => true
         ];
 
         $search_params = ['crs', 'grp'];
         $parent_container = $this->obj->getParentObjectInfo(
             $this->obj->getRefId(),
             $search_params
         );
         if (!is_null($parent_container)) {
             $container_id = $parent_container['ref_id'];
             $toolbar_entries['add_from_container'] = $container_id;
         }
 
         ilRepositorySearchGUI::fillAutoCompleteToolbar(
             $this,
             $this->toolbar,
             $toolbar_entries
         );
 
         $this->toolbar->addSeparator();
 
         $this->toolbar->addButton(
             $this->lng->txt($this->getParentObject()->getType() . "_print_list"),
             $this->ctrl->getLinkTarget($this, 'printMembers')
         );
 
         $this->showMailToMemberToolbarButton($this->toolbar, 'participants');
     }

Here is the call graph for this function:

◆ updateParticipantsStatus()

ilLearningSequenceMembershipGUI::updateParticipantsStatus ( )

protected

save in participants table

Definition at line 186 of file class.ilLearningSequenceMembershipGUI.php.

References ilMembershipGUI\$participants, ILIAS\Repository\ctrl(), getParentObject(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilParticipants\updateNotification().

                                                  : void
     {
         $members = $this->getParentObject()->getLSParticipants();
 
         $participants = $this->post_wrapper->retrieve(
             "visible_member_ids",
             $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
         );
 
         $notification = [];
         if ($this->post_wrapper->has('notification')) {
             $notification = $this->post_wrapper->retrieve(
                 "notification",
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
             );
         }
 
         foreach ($participants as $participant) {
             if ($members->isAdmin($participant)) {
                 $members->updateNotification($participant, in_array($participant, $notification));
                 continue;
             }
             $members->updateNotification($participant, false);
         }
 
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
         $this->ctrl->redirect($this, 'participants');
     }