Provides Role actions. More...

Collaboration diagram for ilLearningSequenceRoles:

Public Member Functions
	__construct (ilObjLearningSequence $object, 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, $roles)

	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)

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	(	ilObjLearningSequence	$object,
		ilLearningSequenceParticipants	$participants,
		ilCtrl	$ctrl,
		ilRbacAdmin	$rbacadmin,
		ilRbacReview	$rbacreview,
		ilDBInterface	$database,
		ilObjUser	$user
	)

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

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

       {
         $this->object = $object;
         $this->participants = $participants;
         $this->ctrl = $ctrl;
         $this->rbacadmin = $rbacadmin;
         $this->rbacreview = $rbacreview;
         $this->database = $database;
         $this->user = $user;
 
         $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 133 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 127 of file class.ilLearningSequenceRoles.php.

References getLocalLearningSequenceRoles().

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

Here is the call graph for this function:

◆ getDefaultLearningSequenceRoles()

ilLearningSequenceRoles::getDefaultLearningSequenceRoles ( string $lso_id )

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

References $object, and getRoleObject().

Referenced by getLearningSequenceAdminIds().

                                                                     : array
     {
         if (strlen($lso_id) == 0) {
             $lso_id = $this->object->getRefId();
         }
 
         $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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultMemberRole()

ilLearningSequenceRoles::getDefaultMemberRole ( )

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

References getLocalLearningSequenceRoles().

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

Here is the call graph for this function:

◆ getLearningSequenceAdminIds()

ilLearningSequenceRoles::getLearningSequenceAdminIds ( )

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

References $users, and getDefaultLearningSequenceRoles().

Referenced by leaveLearningSequence().

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

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.

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

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

Here is the call graph for this function:

◆ getLearningSequenceMemberIds()

ilLearningSequenceRoles::getLearningSequenceMemberIds ( )

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

References $users, and getLocalLearningSequenceRoles().

Referenced by leaveLearningSequence().

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

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

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

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

                                                                            : array
     {
         if (count($this->local_roles) == 0) {
             $role_ids = $this->rbacreview->getRolesOfRoleFolder(
                 $this->object->getRefId()
             );
 
             foreach ($role_ids as $role_id) {
                 if ($this->rbacreview->isAssignable(
                     $role_id,
                     $this->object->getRefId()
                 ) == 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;
     }

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.

References ilObjectFactory\getInstanceByObjId().

Referenced by getDefaultLearningSequenceRoles(), and getLocalLearningSequenceRoles().

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

References ilObjRole\createDefaultRole().

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

Here is the call graph for this function:

◆ isPortfolio()

ilLearningSequenceRoles::isPortfolio ( array $columns = null )

protected

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

References $columns.

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 356 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,
			$roles
	)

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

Referenced by addLSMember().

                                                : bool
     {
         if (is_array($roles)) {
             foreach ($roles as $role) {
                 $this->rbacadmin->assignUser($role, $user_id, false);
             }
         } else {
             $this->rbacadmin->assignUser($roles, $user_id, false);
         }
 
         return true;
     }

Here is the caller graph for this function:

◆ leave()

ilLearningSequenceRoles::leave ( int $user_id )

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

Referenced by leaveLearningSequence().

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

Here is the caller graph for this function:

◆ leaveLearningSequence()

ilLearningSequenceRoles::leaveLearningSequence ( )

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

References ilObjUser\dropDesktopItem(), getLearningSequenceAdminIds(), getLearningSequenceMemberIds(), leave(), and user().

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

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.

References $data, $failed, $name, ilPrivacySettings\_getInstance(), ilLPStatusWrapper\_lookupCompletedForObject(), ilLPStatusWrapper\_lookupFailedForObject(), ilLPStatusWrapper\_lookupInProgressForObject(), ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), ilLearningProgress\_lookupProgressByObjId(), ilObjUser\_readUsersProfileData(), ilDatePresentation\formatDate(), ilObjPortfolio\getAvailablePortfolioLinksForUserIds(), ilObjectLP\getInstance(), IL_CAL_UNIX, isPortfolio(), isTrackingEnabled(), 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->object->getId());
             $tracking_enabled = $olp->isActive();
 
             $completed = ilLPStatusWrapper::_lookupCompletedForObject($this->object->getId());
             $in_progress = ilLPStatusWrapper::_lookupInProgressForObject($this->object->getId());
             $failed = ilLPStatusWrapper::_lookupFailedForObject($this->object->getId());
         }
 
         if ($privacy->enabledLearningSequenceAccessTimes()) {
             $progress = ilLearningProgress::_lookupProgressByObjId($this->object->getId());
         }
 
         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->object->getLSParticipants()->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;
     }