Provides Role actions. More...

Collaboration diagram for ilLearningSequenceRoles:

Public Member Functions
	__construct (int $ls_ref_id, int $ls_obj_id, ilLearningSequenceParticipants $participants, ilCtrl $ctrl, ilRbacAdmin $rbacadmin, ilRbacReview $rbacreview, ilDBInterface $database, ilObjUser $user)

	initDefaultRoles ()

	getLocalLearningSequenceRoles (bool $translate=false)

	getDefaultMemberRole ()

	getDefaultAdminRole ()

	addLSMember (int $user_id, int $role)

	join (int $user_id, int $role=null)

	leaveLearningSequence ()

	getLearningSequenceMemberIds ()

	leave (int $user_id)

	getLearningSequenceMemberData (array $user_ids, int $active=1)

	getLearningSequenceAdminIds ()

	getDefaultLearningSequenceRoles (string $lso_id)

	readMemberData (array $user_ids, array $selected_columns=null)

	isMember (int $usr_id)

	isCompletedByUser (int $usr_id)

Data Fields
const	ROLE_LS_ADMIN = "il_lso_admin"

const	ROLE_LS_MEMBER = "il_lso_member"

const	TYPE_PORTFOLIO = "prtf"

Protected Member Functions
	getRoleObject (int $obj_id)

	isTrackingEnabled ()

	isPortfolio (array $columns=null)

Protected Attributes
	$object

	$participants

	$rbacadmin

	$rbacreview

	$database

	$user

	$local_roles

Detailed Description

Provides Role actions.

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

Definition at line 10 of file class.ilLearningSequenceRoles.php.

Constructor & Destructor Documentation

◆ __construct()

ilLearningSequenceRoles::__construct	(	int	$ls_ref_id,
		int	$ls_obj_id,
		ilLearningSequenceParticipants	$participants,
		ilCtrl	$ctrl,
		ilRbacAdmin	$rbacadmin,
		ilRbacReview	$rbacreview,
		ilDBInterface	$database,
		ilObjUser	$user
	)

Definition at line 53 of file class.ilLearningSequenceRoles.php.

      {
        //$this->object = $object;
        $this->ref_id = $ls_ref_id;
        $this->obj_id = $ls_obj_id;
        $this->participants = $participants;
        $this->ctrl = $ctrl;
        $this->rbacadmin = $rbacadmin;
        $this->rbacreview = $rbacreview;
        $this->database = $database;
        $this->user = $user;
 
        $this->local_roles = array();
    }

References $database, $participants, $rbacadmin, $rbacreview, $user, and user().

Here is the call graph for this function:

Member Function Documentation

◆ addLSMember()

ilLearningSequenceRoles::addLSMember	(	int	$user_id,
		int	$role
	)

Definition at line 137 of file class.ilLearningSequenceRoles.php.

                                                         : bool
    {
        return $this->join($user_id, $role);
    }

References join().

Here is the call graph for this function:

◆ getDefaultAdminRole()

ilLearningSequenceRoles::getDefaultAdminRole ( )

Definition at line 131 of file class.ilLearningSequenceRoles.php.

                                          : int
    {
        $local_ls_roles = $this->getLocalLearningSequenceRoles();
        return $local_ls_roles[self::ROLE_LS_ADMIN . "_" . $this->ref_id];
    }

References getLocalLearningSequenceRoles().

Here is the call graph for this function:

◆ getDefaultLearningSequenceRoles()

ilLearningSequenceRoles::getDefaultLearningSequenceRoles ( string $lso_id )

Definition at line 244 of file class.ilLearningSequenceRoles.php.

                                                                    : array
    {
        if (strlen($lso_id) == 0) {
            $lso_id = $this->ref_id;
        }
 
        $roles = $this->rbacreview->getRolesOfRoleFolder($lso_id);
 
        $default_roles = array();
        foreach ($roles as $role) {
            $object = $this->getRoleObject((int) $role);
 
            $member = self::ROLE_LS_MEMBER . "_" . $lso_id;
            $admin = self::ROLE_LS_ADMIN . "_" . $lso_id;
 
            if (strcmp($object->getTitle(), $member) == 0) {
                $default_roles["lso_member_role"] = $object->getId();
            }
 
            if (strcmp($object->getTitle(), $admin) == 0) {
                $default_roles["lso_admin_role"] = $object->getId();
            }
        }
 
        return $default_roles;
    }

References $object, and getRoleObject().

Referenced by getLearningSequenceAdminIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultMemberRole()

ilLearningSequenceRoles::getDefaultMemberRole ( )

Definition at line 125 of file class.ilLearningSequenceRoles.php.

                                           : int
    {
        $local_ls_roles = $this->getLocalLearningSequenceRoles();
        return $local_ls_roles[self::ROLE_LS_MEMBER . "_" . $this->ref_id];
    }

References getLocalLearningSequenceRoles().

Referenced by join().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLearningSequenceAdminIds()

ilLearningSequenceRoles::getLearningSequenceAdminIds ( )

Definition at line 232 of file class.ilLearningSequenceRoles.php.

    {
        $users = array();
        $roles = $this->getDefaultLearningSequenceRoles((string) $this->ref_id);
 
        foreach ($this->rbacreview->assignedUsers($this->getDefaultAdminRole()) as $admin_id) {
            array_push($users, $admin_id);
        }
 
        return $users;
    }

References getDefaultLearningSequenceRoles().

Referenced by leaveLearningSequence().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLearningSequenceMemberData()

ilLearningSequenceRoles::getLearningSequenceMemberData	(	array	$user_ids,
		int	$active = `1`
	)

Definition at line 200 of file class.ilLearningSequenceRoles.php.

    {
        $users = array();
        $additional_where = "";
 
        if (is_numeric($active) && $active > -1) {
            $additional_where = "AND active = '$active'" . PHP_EOL;
        }
 
        $query =
             "SELECT login, firstname, lastname, title, usr_id, last_login" . PHP_EOL
            . "FROM usr_data " . PHP_EOL
            . "WHERE usr_id IN (" . implode(',', ilUtil::quoteArray($user_ids)) . ") " . PHP_EOL
            . $additional_where . PHP_EOL
            . "ORDER BY lastname, firstname" . PHP_EOL
        ;
 
        $result = $this->database->query($query);
 
        while ($row = $result->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $users[] = [
                "id" => $row->usr_id,
                "login" => $row->login,
                "firstname" => $row->firstname,
                "lastname" => $row->lastname,
                "last_login" => $row->last_login
            ];
        }
 
        return $users;
    }

References $query, $result, ilDBConstants\FETCHMODE_OBJECT, and ilUtil\quoteArray().

Here is the call graph for this function:

◆ getLearningSequenceMemberIds()

ilLearningSequenceRoles::getLearningSequenceMemberIds ( )

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

                                                   : array
    {
        $users = array();
        $roles = $this->getLocalLearningSequenceRoles();
 
        foreach ($roles as $role) {
            foreach ($this->rbacreview->assignedUsers($role) as $member_id) {
                array_push($users, $member_id);
            }
        }
 
        $users = array_unique($users);
 
        return $users;
    }

References getLocalLearningSequenceRoles().

Referenced by leaveLearningSequence().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLocalLearningSequenceRoles()

ilLearningSequenceRoles::getLocalLearningSequenceRoles ( bool $translate = false )

Returns: array [title|id] of roles...

Definition at line 96 of file class.ilLearningSequenceRoles.php.

                                                                           : array
    {
        if (count($this->local_roles) == 0) {
            $role_ids = $this->rbacreview->getRolesOfRoleFolder(
                $this->ref_id
            );
 
            foreach ($role_ids as $role_id) {
                if ($this->rbacreview->isAssignable(
                    $role_id,
                    $this->ref_id
                ) == true
                ) {
                    $role = $this->getRoleObject((int) $role_id);
 
                    if ($translate) {
                        $role_name = ilObjRole::_getTranslation($role->getTitle());
                    } else {
                        $role_name = $role->getTitle();
                    }
 
                    $this->local_roles[$role_name] = (int) $role->getId();
                }
            }
        }
 
        return $this->local_roles;
    }

References $local_roles, ilObjRole\_getTranslation(), and getRoleObject().

Referenced by getDefaultAdminRole(), getDefaultMemberRole(), and getLearningSequenceMemberIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRoleObject()

ilLearningSequenceRoles::getRoleObject ( int $obj_id )

protected

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

    {
        return ilObjectFactory::getInstanceByObjId($obj_id);
    }

References ilObjectFactory\getInstanceByObjId().

Referenced by getDefaultLearningSequenceRoles(), and getLocalLearningSequenceRoles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initDefaultRoles()

ilLearningSequenceRoles::initDefaultRoles ( )

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

    {
        ilObjRole::createDefaultRole(
            self::ROLE_LS_ADMIN . '_' . $this->ref_id,
            "LSO admin learning sequence obj_no." . $this->obj_id,
            self::ROLE_LS_ADMIN,
            $this->ref_id
        );
 
        ilObjRole::createDefaultRole(
            self::ROLE_LS_MEMBER . '_' . $this->ref_id,
            "LSO member of learning sequence obj_no." . $this->obj_id,
            self::ROLE_LS_MEMBER,
            $this->ref_id
        );
    }

References ilObjRole\createDefaultRole().

Here is the call graph for this function:

◆ isCompletedByUser()

ilLearningSequenceRoles::isCompletedByUser ( int $usr_id )

Definition at line 377 of file class.ilLearningSequenceRoles.php.

                                                   : bool
    {
        \ilLPStatusWrapper::_updateStatus($this->obj_id, $usr_id);
        $tracking_active = ilObjUserTracking::_enabledLearningProgress();
        $user_completion = ilLPStatus::_hasUserCompleted($this->obj_id, $usr_id);
        return ($tracking_active && $user_completion);
    }

References ilObjUserTracking\_enabledLearningProgress(), ilLPStatus\_hasUserCompleted(), and ilLPStatusWrapper\_updateStatus().

Here is the call graph for this function:

◆ isMember()

ilLearningSequenceRoles::isMember ( int $usr_id )

Definition at line 372 of file class.ilLearningSequenceRoles.php.

    {
        return $this->participants->isMember($usr_id);
    }

◆ isPortfolio()

ilLearningSequenceRoles::isPortfolio ( array $columns = null )

protected

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

                                                          : bool
    {
        if (is_null($columns)) {
            return false;
        }
        return in_array(self::TYPE_PORTFOLIO, $columns);
    }

References $columns.

Referenced by readMemberData().

Here is the caller graph for this function:

◆ isTrackingEnabled()

ilLearningSequenceRoles::isTrackingEnabled ( )

protected

Definition at line 356 of file class.ilLearningSequenceRoles.php.

                                           : bool
    {
        return
            ilObjUserTracking::_enabledLearningProgress() &&
            ilObjUserTracking::_enabledUserRelatedData()
        ;
    }

References ilObjUserTracking\_enabledLearningProgress(), and ilObjUserTracking\_enabledUserRelatedData().

Referenced by readMemberData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ join()

ilLearningSequenceRoles::join	(	int	$user_id,
		int	$role = `null`
	)

Definition at line 142 of file class.ilLearningSequenceRoles.php.

                                                         : bool
    {
        if (is_null($role)) {
            $role = $this->getDefaultMemberRole();
        }
        $this->rbacadmin->assignUser($role, $user_id);
        return true;
    }

References getDefaultMemberRole().

Referenced by addLSMember().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ leave()

ilLearningSequenceRoles::leave ( int $user_id )

Definition at line 185 of file class.ilLearningSequenceRoles.php.

                                        : bool
    {
        $roles = $this->participants::getMemberRoles($this->ref_id);
 
        if (!is_array($roles)) {
            return $this->rbacadmin->deassignUser($roles, $user_id);
        }
 
        foreach ($roles as $role) {
            $this->rbacadmin->deassignUser($role, $user_id);
        }
 
        return true;
    }

Referenced by leaveLearningSequence().

Here is the caller graph for this function:

◆ leaveLearningSequence()

ilLearningSequenceRoles::leaveLearningSequence ( )

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

                                            : int
    {
        $member_ids = $this->getLearningSequenceMemberIds();
 
        if (count($member_ids) <= 1 || !in_array($this->user->getId(), $member_ids)) {
            return 2;
        } else {
            if (!$this->isAdmin($this->user->getId())) {
                $this->leave($this->user->getId());
                //$member = new ilObjUser($this->user->getId());
                //$member->dropDesktopItem($this->getRefId(), "lso");
                return 0;
            } elseif (count($this->getLearningSequenceAdminIds()) == 1) {
                return 1;
            }
        }
    }

References getLearningSequenceAdminIds(), getLearningSequenceMemberIds(), leave(), and user().

Here is the call graph for this function:

◆ readMemberData()

ilLearningSequenceRoles::readMemberData	(	array	$user_ids,
		array	$selected_columns = `null`
	)

Definition at line 276 of file class.ilLearningSequenceRoles.php.

                                                                                    : array
    {
        $portfolio_enabled = $this->isPortfolio($selected_columns);
        $tracking_enabled = $this->isTrackingEnabled();
        $privacy = ilPrivacySettings::_getInstance();
 
        if ($tracking_enabled) {
            $olp = ilObjectLP::getInstance($this->obj_id);
            $tracking_enabled = $olp->isActive();
 
            $completed = ilLPStatusWrapper::_lookupCompletedForObject($this->obj_id);
            $in_progress = ilLPStatusWrapper::_lookupInProgressForObject($this->obj_id);
            $failed = ilLPStatusWrapper::_lookupFailedForObject($this->obj_id);
        }
 
        if ($privacy->enabledLearningSequenceAccessTimes()) {
            $progress = ilLearningProgress::_lookupProgressByObjId($this->obj_id);
        }
 
        if ($portfolio_enabled) {
            $portfolios = ilObjPortfolio::getAvailablePortfolioLinksForUserIds(
                $user_ids,
                $this->ctrl->getLinkTargetByClass("ilLearningSequenceMembershipGUI", "members")
            );
        }
 
        $members = array();
        $profile_data = ilObjUser::_readUsersProfileData($user_ids);
        foreach ($user_ids as $usr_id) {
            $data = array();
            $name = ilObjUser::_lookupName($usr_id);
 
            $data['firstname'] = $name['firstname'];
            $data['lastname'] = $name['lastname'];
            $data['login'] = ilObjUser::_lookupLogin($usr_id);
            $data['usr_id'] = $usr_id;
 
            $data['notification'] = 0;
            if ($this->participants->isNotificationEnabled($usr_id)) {
                $data['notification'] = 1;
            }
 
            foreach ($profile_data[$usr_id] as $field => $value) {
                $data[$field] = $value;
            }
 
            if ($tracking_enabled) {
                if (in_array($usr_id, $completed)) {
                    $data['progress'] = ilLPStatus::LP_STATUS_COMPLETED;
                } elseif (in_array($usr_id, $in_progress)) {
                    $data['progress'] = ilLPStatus::LP_STATUS_IN_PROGRESS;
                } elseif (in_array($usr_id, $failed)) {
                    $data['progress'] = ilLPStatus::LP_STATUS_FAILED;
                } else {
                    $data['progress'] = ilLPStatus::LP_STATUS_NOT_ATTEMPTED;
                }
            }
 
            if ($privacy->enabledLearningSequenceAccessTimes()) {
                if (isset($progress[$usr_id]['ts']) and $progress[$usr_id]['ts']) {
                    $data['access_time'] = ilDatePresentation::formatDate(
                        $date = new ilDateTime($progress[$usr_id]['ts'], IL_CAL_UNIX)
                    );
                    $data['access_time_unix'] = $date->get(IL_CAL_UNIX);
                } else {
                    $data['access_time'] = $this->lng->txt('no_date');
                    $data['access_time_unix'] = 0;
                }
            }
 
            if ($portfolio_enabled) {
                $data['prtf'] = $portfolios[$usr_id];
            }
 
            $members[$usr_id] = $data;
        }
 
        return $members;
    }