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

Inheritance diagram for ilLearningSequenceMembershipGUI:

Collaboration diagram for ilLearningSequenceMembershipGUI:

Public Member Functions
	__construct (ilObjectGUI $repository_gui, ilObject $repository_obj, ilObjUserTracking $obj_user_tracking, ilPrivacySettings $privacy_settings, ilLanguage $lng, ilCtrl $ctrl, ilAccess $access, ilRbacReview $rbac_review, ilSetting $settings, ilToolbarGUI $toolbar)

	getDefaultCommand ()
	Get default command. More...

	filterUserIdsByRbacOrPositionOfCurrentUser ($user_ids)
	Filter user ids by access. More...

	assignMembers (array $user_ids, string $type)

	getLocalTypeRole ($a_translation=false)

	readMemberData (array $user_ids, array $columns=null)
	Required for member table guis. More...

	getPrintMemberData (array $members)

	getAttendanceListUserData (int $user_id)

	getMembersObject ()
	Get member object. 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
	printMembers ()
	Print members. More...

	updateParticipantsStatus ()
	save in participants table More...

	initParticipantTableGUI ()

	initEditParticipantTableGUI (array $participants)

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

	updateLPFromStatus ()

	initWaitingList ()

	getDefaultRole ()

	getMailMemberRoles ()

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

	showParticipantsToolbar ()
	Show participants toolbar. 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 learning sequence membership features.

Author: Daniel Weise danie.nosp@m.l.we.nosp@m.ise@c.nosp@m.once.nosp@m.pts-a.nosp@m.nd-t.nosp@m.raini.nosp@m.ng.d.nosp@m.e

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

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

Constructor & Destructor Documentation

◆ __construct()

ilLearningSequenceMembershipGUI::__construct	(	ilObjectGUI	$repository_gui,
		ilObject	$repository_obj,
		ilObjUserTracking	$obj_user_tracking,
		ilPrivacySettings	$privacy_settings,
		ilLanguage	$lng,
		ilCtrl	$ctrl,
		ilAccess	$access,
		ilRbacReview	$rbac_review,
		ilSetting	$settings,
		ilToolbarGUI	$toolbar
	)

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

      {
        parent::__construct($repository_gui, $repository_obj);
 
        $this->obj_user_tracking = $obj_user_tracking;
        $this->privacy_settings = $privacy_settings;
        $this->lng = $lng;
        $this->ctrl = $ctrl;
        $this->access = $access;
        $this->rbac_review = $rbac_review;
        $this->settings = $settings;
        $this->obj = $repository_obj;
        $this->toolbar = $toolbar;
    }

References ilMembershipGUI\$access, ilMembershipGUI\$ctrl, ilMembershipGUI\$lng, ilMembershipGUI\$repository_gui, ILIAS\GlobalScreen\Provider\__construct(), and settings().

Here is the call graph for this function:

Member Function Documentation

◆ assignMembers()

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

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

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

References $type, ilLoggerFactory\getLogger(), ilMembershipGUI\getParentObject(), IL_LSO_ADMIN, IL_LSO_MEMBER, ilUtil\sendFailure(), and ilLearningSequenceMembershipMailNotification\TYPE_ADMISSION_MEMBER.

Here is the call graph for this function:

◆ filterUserIdsByRbacOrPositionOfCurrentUser()

ilLearningSequenceMembershipGUI::filterUserIdsByRbacOrPositionOfCurrentUser ( $user_ids )

Filter user ids by access.

Parameters

int[] $a_user_ids

Returns: int[]

Reimplemented from ilMembershipGUI.

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

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

References ilMembershipGUI\getParentObject().

Referenced by getAttendanceListUserData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAttendanceListUserData()

ilLearningSequenceMembershipGUI::getAttendanceListUserData ( int $user_id )

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

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

References $data, and filterUserIdsByRbacOrPositionOfCurrentUser().

Here is the call graph for this function:

◆ getDefaultCommand()

ilLearningSequenceMembershipGUI::getDefaultCommand ( )

Get default command.

Returns: string

Reimplemented from ilMembershipGUI.

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

    {
        $back_cmd = $_GET['back_cmd'];
        return $back_cmd;
    }

References $_GET.

◆ getDefaultRole()

ilLearningSequenceMembershipGUI::getDefaultRole ( )

protected

Returns: null

Reimplemented from ilMembershipGUI.

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

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

References ilMembershipGUI\getParentObject().

Referenced by showParticipantsToolbar().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLocalTypeRole()

ilLearningSequenceMembershipGUI::getLocalTypeRole ( $a_translation = false )

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

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

References ilMembershipGUI\getParentObject().

Here is the call graph for this function:

◆ getMailMemberRoles()

ilLearningSequenceMembershipGUI::getMailMemberRoles ( )

protected

Returns: \ilMailMemberLearningSequenceRoles

Reimplemented from ilMembershipGUI.

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

    {
        return new ilMailMemberLearningSequenceRoles();
    }

◆ getMembersObject()

ilLearningSequenceMembershipGUI::getMembersObject ( )

Get member object.

Returns: ilParticipants

Reimplemented from ilMembershipGUI.

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

    {
        if ($this->participants instanceof ilParticipants) {
            return $this->participants;
        }
        return $this->participants = ilParticipants::getInstance($this->getParentObject()->getRefId());
    }

References ilParticipants\getInstance(), ilMembershipGUI\getParentObject(), and ilMembershipGUI\participants().

Here is the call graph for this function:

◆ getPrintMemberData()

ilLearningSequenceMembershipGUI::getPrintMemberData ( array $members )

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

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

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

Here is the call graph for this function:

◆ initEditParticipantTableGUI()

ilLearningSequenceMembershipGUI::initEditParticipantTableGUI ( array $participants )

protected

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

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

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

Here is the call graph for this function:

◆ initParticipantTableGUI()

ilLearningSequenceMembershipGUI::initParticipantTableGUI ( )

protected

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

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

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

Here is the call graph for this function:

◆ initParticipantTemplate()

ilLearningSequenceMembershipGUI::initParticipantTemplate ( )

protected

Init participant view template.

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

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

◆ initWaitingList()

ilLearningSequenceMembershipGUI::initWaitingList ( )

protected

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

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

References ilMembershipGUI\getParentObject().

Here is the call graph for this function:

◆ printMembers()

ilLearningSequenceMembershipGUI::printMembers ( )

protected

Print members.

Todo:: : refactor to own class

Reimplemented from ilMembershipGUI.

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

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

References $DIC, ilMembershipGUI\checkPermission(), and ilMembershipGUI\checkRbacOrPositionAccessBool().

Here is the call graph for this function:

◆ readMemberData()

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

Required for member table guis.

Has to be refactored and should be locate in ilObjCourse, ilObjGroup instead of GUI

Returns: array

Reimplemented from ilMembershipGUI.

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

    {
        return $this->getParentObject()->readMemberData($user_ids, $columns);
    }

References $columns, and ilMembershipGUI\getParentObject().

Referenced by getPrintMemberData(), and initEditParticipantTableGUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSubTabs()

ilLearningSequenceMembershipGUI::setSubTabs ( ilTabsGUI $tabs )

protected

Set sub tabs.

Reimplemented from ilMembershipGUI.

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

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

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

Here is the call graph for this function:

◆ showParticipantsToolbar()

ilLearningSequenceMembershipGUI::showParticipantsToolbar ( )

protected

Show participants toolbar.

Reimplemented from ilMembershipGUI.

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

    {
        $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(
            (int) $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', false);
    }

References ilRepositorySearchGUI\fillAutoCompleteToolbar(), getDefaultRole(), ilMembershipGUI\getParentGUI(), and ilMembershipGUI\showMailToMemberToolbarButton().

Here is the call graph for this function:

◆ updateLPFromStatus()

ilLearningSequenceMembershipGUI::updateLPFromStatus ( )

protected

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

    {
        return null;
    }

◆ updateParticipantsStatus()

ilLearningSequenceMembershipGUI::updateParticipantsStatus ( )

protected

save in participants table

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

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

References $_POST, and ilMembershipGUI\getParentObject().

Here is the call graph for this function:

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

Modules/LearningSequence/classes/Members/class.ilLearningSequenceMembershipGUI.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assignMembers()

◆ filterUserIdsByRbacOrPositionOfCurrentUser()

◆ getAttendanceListUserData()

◆ getDefaultCommand()

◆ getDefaultRole()

◆ getLocalTypeRole()

◆ getMailMemberRoles()

◆ getMembersObject()

◆ getPrintMemberData()

◆ initEditParticipantTableGUI()

◆ initParticipantTableGUI()

◆ initParticipantTemplate()

◆ initWaitingList()

◆ printMembers()

◆ readMemberData()

◆ setSubTabs()

◆ showParticipantsToolbar()

◆ updateLPFromStatus()

◆ updateParticipantsStatus()