This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. 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, ilLanguage $lng)

	initDefaultRoles ()

	getLocalLearningSequenceRoles (bool $translate=false)

	getDefaultMemberRole ()

	getDefaultAdminRole ()

	addLSMember (int $user_id, int $role)

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

	leave (int $user_id)

	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
int	$ref_id

int	$obj_id

ilLearningSequenceParticipants	$participants

ilCtrl	$ctrl

ilRbacAdmin	$rbacadmin

ilRbacReview	$rbacreview

ilDBInterface	$database

ilObjUser	$user

ilLanguage	$lng

array	$local_roles

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Provides Role actions.

Definition at line 24 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,
		ilLanguage	$lng
	)

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

References $ctrl, $database, $lng, $participants, $rbacadmin, $rbacreview, $user, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

       {
         $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->lng = $lng;
 
         $this->local_roles = array();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addLSMember()

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

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

References join().

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

Here is the call graph for this function:

◆ getDefaultAdminRole()

ilLearningSequenceRoles::getDefaultAdminRole ( )

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

References $ref_id, and getLocalLearningSequenceRoles().

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

Here is the call graph for this function:

◆ getDefaultLearningSequenceRoles()

ilLearningSequenceRoles::getDefaultLearningSequenceRoles ( string $lso_id )

Returns: array<string, int>|[]

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

References $ref_id, and getRoleObject().

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

Here is the call graph for this function:

◆ getDefaultMemberRole()

ilLearningSequenceRoles::getDefaultMemberRole ( )

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

References $ref_id, and getLocalLearningSequenceRoles().

Referenced by join().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLearningSequenceAdminIds()

ilLearningSequenceRoles::getLearningSequenceAdminIds ( )

Returns: array<int>

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

References ILIAS\Repository\int().

                                                  : array
     {
         $users = array();
         foreach ($this->rbacreview->assignedUsers($this->getDefaultAdminRole()) as $admin_id) {
             $users[] = (int) $admin_id;
         }
 
         return $users;
     }

Here is the call graph for this function:

◆ getLocalLearningSequenceRoles()

ilLearningSequenceRoles::getLocalLearningSequenceRoles ( bool $translate = false )

Returns: array<string, int>

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

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

Referenced by getDefaultAdminRole(), and getDefaultMemberRole().

                                                                           : 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($role_id);
 
                     if ($translate) {
                         $role_name = ilObjRole::_getTranslation($role->getTitle());
                     } else {
                         $role_name = $role->getTitle();
                     }
 
                     $this->local_roles[$role_name] = $role->getId();
                 }
             }
         }
 
         return $this->local_roles;
     }

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 192 of file class.ilLearningSequenceRoles.php.

References ilObjectFactory\getInstanceByObjId().

Referenced by getDefaultLearningSequenceRoles(), and getLocalLearningSequenceRoles().

                                                  : ?\ilObject
     {
         return ilObjectFactory::getInstanceByObjId($obj_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initDefaultRoles()

ilLearningSequenceRoles::initDefaultRoles ( )

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

References ilObjRole\createDefaultRole().

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

Here is the call graph for this function:

◆ isCompletedByUser()

ilLearningSequenceRoles::isCompletedByUser ( int $usr_id )

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

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

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

Here is the call graph for this function:

◆ isMember()

ilLearningSequenceRoles::isMember ( int $usr_id )

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

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

◆ isPortfolio()

ilLearningSequenceRoles::isPortfolio ( array $columns = null )

protected

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

Referenced by readMemberData().

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

Here is the caller graph for this function:

◆ isTrackingEnabled()

ilLearningSequenceRoles::isTrackingEnabled ( )

protected

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

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

Referenced by readMemberData().

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

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 129 of file class.ilLearningSequenceRoles.php.

References getDefaultMemberRole().

Referenced by addLSMember().

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

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 138 of file class.ilLearningSequenceRoles.php.

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

◆ readMemberData()

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

Parameters

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

Returns: array<int|string, array>

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

References $data, $name, ilLPStatusWrapper\_lookupCompletedForObject(), ilLPStatusWrapper\_lookupFailedForObject(), ilLPStatusWrapper\_lookupInProgressForObject(), ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), ilLearningProgress\_lookupProgressByObjId(), ilObjUser\_readUsersProfileData(), ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ilObjPortfolio\getAvailablePortfolioLinksForUserIds(), ilObjectLP\getInstance(), ilPrivacySettings\getInstance(), IL_CAL_UNIX, isPortfolio(), isTrackingEnabled(), ILIAS\Repository\lng(), ilLPStatus\LP_STATUS_COMPLETED, ilLPStatus\LP_STATUS_FAILED, ilLPStatus\LP_STATUS_IN_PROGRESS, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED.

                                                                                    : 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']) && $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 && array_key_exists($usr_id, $portfolios)) {
                 $data['prtf'] = $portfolios[$usr_id];
             }
 
             $members[$usr_id] = $data;
         }
 
         return $members;
     }