Both role and OrgU-based permissions are relevant in many places of the PRG. More...

Collaboration diagram for ilPRGPermissionsHelper:

Public Member Functions
	__construct (ilAccess $access, ilOrgUnitGlobalSettings $orgu_settings, ilObjectDataCache $data_cache, ilOrgUnitPositionAccess $orgu_access, int $prg_ref_id)

	may (string $operation)

	mayAnyOf (array $operations)

	getUserIdsSusceptibleTo (string $operation)

	filterUserIds (array $user_ids, string $operation)

	isOrguAccessEnabledGlobally ()

Data Fields
const	ORGU_OPERATIONS

const	ROLEPERM_VIEW = 'rp_visible'

const	ROLEPERM_READ = 'rp_read'

const	ROLEPERM_WRITE = 'rp_write'

const	ROLEPERM_MANAGE_MEMBERS = 'rp_manage_members'

Protected Member Functions
	throwForInvalidOperation (string $operation)

	getUserIdsInPrgAccessibleForOperation (string $orgu_operation)

	getAllAssignedUserIds ()

	getProgrammeRefId ()

Protected Attributes
const ilAccess	$access

ilOrgUnitGlobalSettings	$orgu_settings

ilObjectDataCache	$data_cache

ilOrgUnitPositionAccess	$orgu_access

int	$prg_ref_id

array	$cache = []

array	$user_id_cache

Private Attributes
const	ROLEMAPPINGS

Detailed Description

Both role and OrgU-based permissions are relevant in many places of the PRG.

This is to bundle permission-checks.

Please note that the 'manage_members'-permission granted via global or local roles will include all the ORGU_OPERATIONS listed here and is thus very different from the OrgUnitOperation 'manage_members'.

Definition at line 29 of file ilPRGPermissionsHelper.php.

Constructor & Destructor Documentation

◆ __construct()

ilPRGPermissionsHelper::__construct	(	ilAccess	$access,
		ilOrgUnitGlobalSettings	$orgu_settings,
		ilObjectDataCache	$data_cache,
		ilOrgUnitPositionAccess	$orgu_access,
		int	$prg_ref_id
	)

Definition at line 65 of file ilPRGPermissionsHelper.php.

References $access, $data_cache, $orgu_access, $orgu_settings, $prg_ref_id, and ILIAS\Repository\access().

       {
         $this->access = $access;
         $this->orgu_settings = $orgu_settings;
         $this->data_cache = $data_cache;
         $this->orgu_access = $orgu_access;
         $this->prg_ref_id = $prg_ref_id;
     }

Here is the call graph for this function:

Member Function Documentation

◆ filterUserIds()

ilPRGPermissionsHelper::filterUserIds	(	array	$user_ids,
		string	$operation
	)

Parameters

int[] $user_ids

Definition at line 128 of file ilPRGPermissionsHelper.php.

References getProgrammeRefId(), and may().

                                                                      : array
     {
         if ($this->may(self::ROLEPERM_MANAGE_MEMBERS)) { //RBAC overrides OrgUs
             return $user_ids;
         }
 
         return $this->orgu_access->filterUserIdsByPositionOfCurrentUser(
             $operation,
             $this->getProgrammeRefId(),
             $user_ids
         );
     }

Here is the call graph for this function:

◆ getAllAssignedUserIds()

ilPRGPermissionsHelper::getAllAssignedUserIds ( )

protected

Returns: int[]

Definition at line 177 of file ilPRGPermissionsHelper.php.

References ilObjStudyProgramme\getInstanceByRefId(), and getProgrammeRefId().

Referenced by getUserIdsInPrgAccessibleForOperation(), and getUserIdsSusceptibleTo().

                                               : array
     {
         if (!isset($this->cache[self::ROLEPERM_MANAGE_MEMBERS])) {
             $prg = ilObjStudyProgramme::getInstanceByRefId($this->getProgrammeRefId());
             $this->cache[self::ROLEPERM_MANAGE_MEMBERS] = array_unique($prg->getMembers());
         }
         return $this->cache[self::ROLEPERM_MANAGE_MEMBERS];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProgrammeRefId()

ilPRGPermissionsHelper::getProgrammeRefId ( )

protected

Definition at line 186 of file ilPRGPermissionsHelper.php.

References $prg_ref_id.

Referenced by filterUserIds(), getAllAssignedUserIds(), isOrguAccessEnabledGlobally(), and may().

                                           : int
     {
         return $this->prg_ref_id;
     }

Here is the caller graph for this function:

◆ getUserIdsInPrgAccessibleForOperation()

ilPRGPermissionsHelper::getUserIdsInPrgAccessibleForOperation ( string $orgu_operation )

protected

Definition at line 158 of file ilPRGPermissionsHelper.php.

References getAllAssignedUserIds().

Referenced by getUserIdsSusceptibleTo().

                                                                                     : array
     {
         if (!isset($this->cache[$orgu_operation])) {
             $user_ids = array_map(
                 'intval',
                 $this->orgu_access->filterUserIdsByPositionOfCurrentUser(
                     $orgu_operation,
                     $this->getProgrammeRefId(),
                     $this->getAllAssignedUserIds()
                 )
             );
             $this->cache[$orgu_operation] = array_unique($user_ids);
         }
         return $this->cache[$orgu_operation];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserIdsSusceptibleTo()

ilPRGPermissionsHelper::getUserIdsSusceptibleTo ( string $operation )

Returns: int[]

Definition at line 111 of file ilPRGPermissionsHelper.php.

References getAllAssignedUserIds(), getUserIdsInPrgAccessibleForOperation(), may(), and throwForInvalidOperation().

Referenced by ilStudyProgrammeUserTable\__construct().

                                                               : array
     {
         $this->throwForInvalidOperation($operation);
 
         if ($this->may(self::ROLEPERM_MANAGE_MEMBERS)) { //RBAC overrides OrgUs
             return $this->getAllAssignedUserIds();
         }
 
         if (in_array($operation, self::ORGU_OPERATIONS) && $this->may($operation)) {
             return $this->getUserIdsInPrgAccessibleForOperation($operation);
         }
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isOrguAccessEnabledGlobally()

ilPRGPermissionsHelper::isOrguAccessEnabledGlobally ( )

Definition at line 191 of file ilPRGPermissionsHelper.php.

References getProgrammeRefId().

                                                  : bool
     {
         $obj_id = $this->data_cache->lookupObjId($this->getProgrammeRefId());
         $type_settings = $this->orgu_settings->getObjectPositionSettingsByType('prg');
 
         return $type_settings->isActive() && $type_settings->isChangeableForObject();
     }

Here is the call graph for this function:

◆ may()

ilPRGPermissionsHelper::may ( string $operation )

Definition at line 79 of file ilPRGPermissionsHelper.php.

References ILIAS\Repository\access(), getProgrammeRefId(), and throwForInvalidOperation().

Referenced by filterUserIds(), getUserIdsSusceptibleTo(), and mayAnyOf().

                                           : bool
     {
         $this->throwForInvalidOperation($operation);
         if (in_array($operation, self::ORGU_OPERATIONS)) {
             return
                 $this->access->checkAccess( //RBAC overrides OrgUs
                     self::ROLEMAPPINGS[self::ROLEPERM_MANAGE_MEMBERS],
                     '',
                     $this->getProgrammeRefId()
                 )
                 || $this->access->checkPositionAccess($operation, $this->getProgrammeRefId());
         }
 
         return $this->access->checkAccess(self::ROLEMAPPINGS[$operation], '', $this->getProgrammeRefId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mayAnyOf()

ilPRGPermissionsHelper::mayAnyOf ( array $operations )

Parameters

string[] $operations

Definition at line 98 of file ilPRGPermissionsHelper.php.

References may().

Referenced by ilStudyProgrammeMembersTableGUI\__construct().

                                                : bool
     {
         foreach ($operations as $operation) {
             if ($this->may($operation)) {
                 return true;
             }
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ throwForInvalidOperation()

ilPRGPermissionsHelper::throwForInvalidOperation ( string $operation )

protected

Definition at line 141 of file ilPRGPermissionsHelper.php.

References $valid.

Referenced by getUserIdsSusceptibleTo(), and may().

                                                                   : void
     {
         $valid = array_merge(
             self::ORGU_OPERATIONS,
             [
                 self::ROLEPERM_VIEW,
                 self::ROLEPERM_READ,
                 self::ROLEPERM_WRITE,
                 self::ROLEPERM_MANAGE_MEMBERS
             ]
         );
 
         if (!in_array($operation, $valid)) {
             throw new ilException('prg does not provide this permission: ' . $operation);
         }
     }

Here is the caller graph for this function:

Field Documentation

◆ $access

const ilAccess ilPRGPermissionsHelper::$access

protected

Initial value:

=> 'read',
        'rp_write' => 'write',
        'rp_manage_members' => 'manage_members'
    ]

Definition at line 48 of file ilPRGPermissionsHelper.php.

Referenced by __construct().

◆ $cache

array ilPRGPermissionsHelper::$cache = []

protected

Definition at line 58 of file ilPRGPermissionsHelper.php.

◆ $data_cache

ilObjectDataCache ilPRGPermissionsHelper::$data_cache

protected

Definition at line 55 of file ilPRGPermissionsHelper.php.

Referenced by __construct().

◆ $orgu_access

ilOrgUnitPositionAccess ilPRGPermissionsHelper::$orgu_access

protected

Definition at line 56 of file ilPRGPermissionsHelper.php.

Referenced by __construct().

◆ $orgu_settings

ilOrgUnitGlobalSettings ilPRGPermissionsHelper::$orgu_settings

protected

Definition at line 54 of file ilPRGPermissionsHelper.php.

Referenced by __construct().

◆ $prg_ref_id

int ilPRGPermissionsHelper::$prg_ref_id

protected

Definition at line 57 of file ilPRGPermissionsHelper.php.

Referenced by __construct(), and getProgrammeRefId().

◆ $user_id_cache

array ilPRGPermissionsHelper::$user_id_cache

protected

Definition at line 63 of file ilPRGPermissionsHelper.php.

◆ ORGU_OPERATIONS

const ilPRGPermissionsHelper::ORGU_OPERATIONS

Initial value:

= [
        ilOrgUnitOperation::OP_VIEW_MEMBERS,
        ilOrgUnitOperation::OP_READ_LEARNING_PROGRESS,
        ilOrgUnitOperation::OP_VIEW_INDIVIDUAL_PLAN,
        ilOrgUnitOperation::OP_EDIT_INDIVIDUAL_PLAN,
        ilOrgUnitOperation::OP_MANAGE_MEMBERS
    ]

Definition at line 31 of file ilPRGPermissionsHelper.php.

◆ ROLEMAPPINGS

const ilPRGPermissionsHelper::ROLEMAPPINGS

private

Initial value:

= [

'rp_visible' => 'visible'

Definition at line 46 of file ilPRGPermissionsHelper.php.

◆ ROLEPERM_MANAGE_MEMBERS

const ilPRGPermissionsHelper::ROLEPERM_MANAGE_MEMBERS = 'rp_manage_members'

Definition at line 44 of file ilPRGPermissionsHelper.php.

Referenced by ilObjStudyProgrammeGUI\executeCommand(), and ilObjStudyProgrammeGUI\getSubTabs().

◆ ROLEPERM_READ

const ilPRGPermissionsHelper::ROLEPERM_READ = 'rp_read'

Definition at line 40 of file ilPRGPermissionsHelper.php.

Referenced by ilObjStudyProgrammeGUI\addToNavigationHistory(), ilObjStudyProgrammeGUI\executeCommand(), ilObjStudyProgrammeGUI\getTabs(), and ilObjStudyProgrammeGUI\view().

◆ ROLEPERM_VIEW

const ilPRGPermissionsHelper::ROLEPERM_VIEW = 'rp_visible'

Definition at line 39 of file ilPRGPermissionsHelper.php.

Referenced by ilObjStudyProgrammeGUI\denyAccessIfNotAnyOf(), and ilObjStudyProgrammeGUI\executeCommand().

◆ ROLEPERM_WRITE

const ilPRGPermissionsHelper::ROLEPERM_WRITE = 'rp_write'

Definition at line 41 of file ilPRGPermissionsHelper.php.

Referenced by ilObjStudyProgrammeGUI\edit(), ilObjStudyProgrammeGUI\editAdvancedSettings(), ilObjStudyProgrammeGUI\executeCommand(), ilObjStudyProgrammeGUI\getTabs(), and ilObjStudyProgrammeGUI\updateAdvancedSettings().

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

components/ILIAS/StudyProgramme/classes/helpers/ilPRGPermissionsHelper.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ filterUserIds()

◆ getAllAssignedUserIds()

◆ getProgrammeRefId()

◆ getUserIdsInPrgAccessibleForOperation()

◆ getUserIdsSusceptibleTo()

◆ isOrguAccessEnabledGlobally()

◆ may()

◆ mayAnyOf()

◆ throwForInvalidOperation()

Field Documentation

◆ $access

◆ $cache

◆ $data_cache

◆ $orgu_access

◆ $orgu_settings

◆ $prg_ref_id

◆ $user_id_cache

◆ ORGU_OPERATIONS

◆ ROLEMAPPINGS

◆ ROLEPERM_MANAGE_MEMBERS

◆ ROLEPERM_READ

◆ ROLEPERM_VIEW

◆ ROLEPERM_WRITE