ilOrgUnitPositionAccess Class Reference

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

Inheritance diagram for ilOrgUnitPositionAccess:

Collaboration diagram for ilOrgUnitPositionAccess:

Public Member Functions
	__construct (ilAccess $access)
	filterUserIdsForCurrentUsersPositionsAndPermission (array $user_ids, string $permission)
	filterUserIdsForUsersPositionsAndPermission (array $user_ids, int $for_user_id, string $permission)
	isCurrentUserBasedOnPositionsAllowedTo (string $permission, array $on_user_ids)
	isUserBasedOnPositionsAllowedTo (int $which_user_id, string $permission, array $on_user_ids)
	filterUserIdsByPositionOfCurrentUser (string $pos_perm, int $ref_id, array $user_ids)
	filterUserIdsByPositionOfUser (int $user_id, string $pos_perm, int $ref_id, array $user_ids)
	checkPositionAccess (string $pos_perm, int $ref_id)
	hasCurrentUserAnyPositionAccess (int $ref_id)
	checkRbacOrPositionPermissionAccess (string $rbac_perm, string $pos_perm, int $ref_id)
	filterUserIdsByRbacOrPositionOfCurrentUser (string $rbac_perm, string $pos_perm, int $ref_id, array $user_ids)
	hasUserRBACorAnyPositionAccess (string $rbac_perm, int $ref_id)
	filterUserIdsForCurrentUsersPositionsAndPermission (array $user_ids, string $permission)
	filterUserIdsForUsersPositionsAndPermission (array $user_ids, int $for_user_id, string $permission)
	isCurrentUserBasedOnPositionsAllowedTo (string $permission, array $on_user_ids)
	isUserBasedOnPositionsAllowedTo (int $which_user_id, string $permission, array $on_user_ids)
	checkPositionAccess (string $pos_perm, int $ref_id)
	hasCurrentUserAnyPositionAccess (int $ref_id)
	filterUserIdsByPositionOfCurrentUser (string $pos_perm, int $ref_id, array $user_ids)
	filterUserIdsByPositionOfUser (int $user_id, string $pos_perm, int $ref_id, array $user_ids)
	checkRbacOrPositionPermissionAccess (string $rbac_perm, string $pos_perm, int $ref_id)
	filterUserIdsByRbacOrPositionOfCurrentUser (string $rbac_perm, string $pos_perm, int $ref_id, array $user_ids)
	hasUserRBACorAnyPositionAccess (string $rbac_perm, int $ref_id)

Static Protected Attributes
static array	$ref_id_obj_type_map = array()

Private Member Functions
	getCurrentUsersId ()
	getTypeForRefId (int $ref_id)
	getObjIdForRefId (int $ref_id)
	isPositionActiveForRefId (int $ref_id)

Private Attributes
ilOrgUnitUserAssignmentQueries	$ua
ilOrgUnitGlobalSettings	$set
ilAccess	$access
ilObjUser	$user

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 Class ilOrgUnitPositionAccess

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 23 of file class.ilOrgUnitPositionAccess.php.

Constructor & Destructor Documentation

__construct()

ilOrgUnitPositionAccess::__construct

(

ilAccess

$access

)

Definition at line 31 of file class.ilOrgUnitPositionAccess.php.

    {
        global $DIC;
        $this->set = ilOrgUnitGlobalSettings::getInstance();
        $this->ua = ilOrgUnitUserAssignmentQueries::getInstance();
        $this->access = $access;
        $this->user = $DIC->user();
    }

References $access, $DIC, ILIAS\Repository\access(), ilOrgUnitUserAssignmentQueries\getInstance(), ilOrgUnitGlobalSettings\getInstance(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

checkPositionAccess()

ilOrgUnitPositionAccess::checkPositionAccess	(	string	$pos_perm,
		int	$ref_id
	)

Parameters

string	$pos_perm
int	$ref_id	Reference-ID of the desired Object in the tree

Returns

bool

See also

getAvailablePositionRelatedPermissions for available permissions

Implements ilOrgUnitPositionAccessHandler.

Definition at line 172 of file class.ilOrgUnitPositionAccess.php.

                                                                      : bool
    {
        if (!$this->isPositionActiveForRefId($ref_id)) {
            return false;
        }
 
        $operation = ilOrgUnitOperationQueries::findByOperationString($pos_perm, $this->getTypeForRefId($ref_id));
        if (!$operation) {
            return false;
        }
        $current_user_id = $this->getCurrentUsersId();
 
        foreach ($this->ua->getPositionsOfUserId($current_user_id) as $position) {
            $permissions = ilOrgUnitPermissionQueries::getSetForRefId($ref_id, $position->getId());
            if ($permissions->isOperationIdSelected($operation->getOperationId())) {
                return true;
            }
        }
 
        return false;
    }

References $ref_id, and ilOrgUnitOperationQueries\findByOperationString().

Referenced by ilAccess\checkPositionAccess().

Here is the call graph for this function:

Here is the caller graph for this function:

checkRbacOrPositionPermissionAccess()

ilOrgUnitPositionAccess::checkRbacOrPositionPermissionAccess	(	string	$rbac_perm,
		string	$pos_perm,
		int	$ref_id
	)

Parameters

string	$rbac_perm
string	$pos_perm	See the list of available permissions in interface ilOrgUnitPositionAccessHandler
int	$ref_id	Reference-ID of the desired Object in the tree

Returns

bool

Implements ilOrgUnitPositionAndRBACAccessHandler.

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

                                                                                                         : bool
    {
        // If RBAC allows, just return true
        if ($this->access->checkAccess($rbac_perm, '', $ref_id)) {
            return true;
        }
 
        if (!$this->isPositionActiveForRefId($ref_id)) {
            return false;
        }
 
        return $this->checkPositionAccess($pos_perm, $ref_id);
    }

References $ref_id, and ILIAS\Repository\access().

Referenced by ilAccess\checkRbacOrPositionPermissionAccess().

Here is the call graph for this function:

Here is the caller graph for this function:

filterUserIdsByPositionOfCurrentUser()

ilOrgUnitPositionAccess::filterUserIdsByPositionOfCurrentUser	(	string	$pos_perm,
		int	$ref_id,
		array	$user_ids
	)

Parameters

int[]

$user_ids

Implements ilOrgUnitPositionAccessHandler.

Definition at line 94 of file class.ilOrgUnitPositionAccess.php.

                                                                                                        : array
    {
        $current_user_id = $this->getCurrentUsersId();
 
        return $this->filterUserIdsByPositionOfUser($current_user_id, $pos_perm, $ref_id, $user_ids);
    }

References $ref_id.

Referenced by ilAccess\filterUserIdsByPositionOfCurrentUser().

Here is the caller graph for this function:

filterUserIdsByPositionOfUser()

ilOrgUnitPositionAccess::filterUserIdsByPositionOfUser	(	int	$user_id,
		string	$pos_perm,
		int	$ref_id,
		array	$user_ids
	)

Parameters

int[]

$user_ids

Implements ilOrgUnitPositionAccessHandler.

Definition at line 103 of file class.ilOrgUnitPositionAccess.php.

     : array {
        // $all_available_users = $this->ua->getUserIdsOfOrgUnit()
        $operation = ilOrgUnitOperationQueries::findByOperationString($pos_perm, $this->getTypeForRefId($ref_id));
        if (!$operation) {
            return [];
        }
 
        $allowed_user_ids = [];
        foreach ($this->ua->getPositionsOfUserId($user_id) as $position) {
            $permissions = ilOrgUnitPermissionQueries::getSetForRefId($ref_id, $position->getId());
            $permissions->afterObjectLoad();
            if (!$permissions->isOperationIdSelected($operation->getOperationId())) {
                continue;
            }
 
            $position->afterObjectLoad();
            foreach ($position->getAuthorities() as $authority) {
                switch ($authority->getOver()) {
                    case ilOrgUnitAuthority::OVER_EVERYONE:
                        switch ($authority->getScope()) {
                            case ilOrgUnitAuthority::SCOPE_SAME_ORGU:
                                $allowed = $this->ua->getUserIdsOfOrgUnitsOfUsersPosition($position->getId(), $user_id);
                                $allowed_user_ids = array_merge($allowed_user_ids, $allowed);
                                break;
                            case ilOrgUnitAuthority::SCOPE_SUBSEQUENT_ORGUS:
                                $allowed = $this->ua->getUserIdsOfOrgUnitsOfUsersPosition(
                                    $position->getId(),
                                    $user_id,
                                    true
                                );
                                $allowed_user_ids = array_merge($allowed_user_ids, $allowed);
                                break;
                        }
                        break;
                    default:
                        switch ($authority->getScope()) {
                            case ilOrgUnitAuthority::SCOPE_SAME_ORGU:
                                $allowed = $this->ua->getUserIdsOfUsersOrgUnitsInPosition(
                                    $user_id,
                                    $authority->getPositionId(),
                                    $authority->getOver(),
                                    false
                                );
                                $allowed_user_ids = array_merge($allowed_user_ids, $allowed);
                                break;
                            case ilOrgUnitAuthority::SCOPE_SUBSEQUENT_ORGUS:
                                $allowed = $this->ua->getUserIdsOfUsersOrgUnitsInPosition(
                                    $user_id,
                                    $authority->getPositionId(),
                                    $authority->getOver(),
                                    true
                                );
                                $allowed_user_ids = array_merge($allowed_user_ids, $allowed);
                                break;
                        }
                        break;
                }
            }
        }
        $allowed_user_ids[] = $this->user->getId();
        return array_intersect($user_ids, $allowed_user_ids);
    }

Referenced by ilAccess\filterUserIdsByPositionOfUser().

Here is the caller graph for this function:

filterUserIdsByRbacOrPositionOfCurrentUser()

ilOrgUnitPositionAccess::filterUserIdsByRbacOrPositionOfCurrentUser	(	string	$rbac_perm,
		string	$pos_perm,
		int	$ref_id,
		array	$user_ids
	)

Parameters

string	$rbac_perm
string	$pos_perm	See the list of available permissions in interface ilOrgUnitPositionAccessHandler
int	$ref_id	Reference-ID of the desired Object in the tree
int[]	$user_ids

Returns

int[]

Implements ilOrgUnitPositionAndRBACAccessHandler.

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

     : array {
        global $DIC;
 
        // If RBAC allows, just return true
        if ($this->access->checkAccess($rbac_perm, '', $ref_id)) {
            return $user_ids;
        }
 
        return $this->filterUserIdsByPositionOfCurrentUser($pos_perm, $ref_id, $user_ids);
    }

Referenced by ilAccess\filterUserIdsByRbacOrPositionOfCurrentUser().

Here is the caller graph for this function:

filterUserIdsForCurrentUsersPositionsAndPermission()

ilOrgUnitPositionAccess::filterUserIdsForCurrentUsersPositionsAndPermission	(	array	$user_ids,
		string	$permission
	)

Returns

int[] Filtered List of ILIAS-User-IDs

Implements ilOrgUnitPositionAccessHandler.

Definition at line 42 of file class.ilOrgUnitPositionAccess.php.

     : array {
        $current_user_id = $this->getCurrentUsersId();
        return $this->filterUserIdsForUsersPositionsAndPermission($user_ids, $current_user_id, $permission);
    }

Referenced by ilAccess\filterUserIdsForCurrentUsersPositionsAndPermission().

Here is the caller graph for this function:

filterUserIdsForUsersPositionsAndPermission()

ilOrgUnitPositionAccess::filterUserIdsForUsersPositionsAndPermission	(	array	$user_ids,
		int	$for_user_id,
		string	$permission
	)

Returns

int[] Filtered List of ILIAS-User-IDs

Implements ilOrgUnitPositionAccessHandler.

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

     : array {
        $assignment_of_user = $this->ua->getAssignmentsOfUserId($for_user_id);
        $other_users_in_same_org_units = [];
        foreach ($assignment_of_user as $assignment) {
            $other_users_in_same_org_units += $this->ua->getUserIdsOfOrgUnit($assignment->getOrguId());
        }
 
        return array_intersect($user_ids, $other_users_in_same_org_units);
    }

Referenced by ilAccess\filterUserIdsForUsersPositionsAndPermission().

Here is the caller graph for this function:

getCurrentUsersId()

ilOrgUnitPositionAccess::getCurrentUsersId ( )

private

Definition at line 260 of file class.ilOrgUnitPositionAccess.php.

                                        : int
    {
        return $this->user->getId();
    }

References ILIAS\Repository\user().

Here is the call graph for this function:

getObjIdForRefId()

ilOrgUnitPositionAccess::getObjIdForRefId ( int  $ref_id )

private

Definition at line 275 of file class.ilOrgUnitPositionAccess.php.

                                                  : int
    {
        return ilObject2::_lookupObjectId($ref_id);
    }

References $ref_id, and ilObject\_lookupObjectId().

Here is the call graph for this function:

getTypeForRefId()

ilOrgUnitPositionAccess::getTypeForRefId ( int  $ref_id )

private

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

                                                 : string
    {
        if (!isset(self::$ref_id_obj_type_map[$ref_id])) {
            self::$ref_id_obj_type_map[$ref_id] = ilObject2::_lookupType($ref_id, true);
        }
 
        return self::$ref_id_obj_type_map[$ref_id];
    }

References $ref_id, and ilObject\_lookupType().

Here is the call graph for this function:

hasCurrentUserAnyPositionAccess()

ilOrgUnitPositionAccess::hasCurrentUserAnyPositionAccess

(

int

$ref_id

)

Parameters

int

$ref_id

Returns

bool

Implements ilOrgUnitPositionAccessHandler.

Definition at line 195 of file class.ilOrgUnitPositionAccess.php.

                                                                : bool
    {
        if (!$this->isPositionActiveForRefId($ref_id)) {
            return false;
        }
 
        $current_user_id = $this->getCurrentUsersId();
 
        foreach ($this->ua->getPositionsOfUserId($current_user_id) as $position) {
            $permissions = ilOrgUnitPermissionQueries::getSetForRefId($ref_id, $position->getId());
            if (count($permissions->getOperations()) > 0) {
                return true;
            }
        }
 
        return false;
    }

References $ref_id.

Referenced by ilAccess\hasCurrentUserAnyPositionAccess().

Here is the caller graph for this function:

hasUserRBACorAnyPositionAccess()

ilOrgUnitPositionAccess::hasUserRBACorAnyPositionAccess	(	string	$rbac_perm,
		int	$ref_id
	)

Implements ilOrgUnitPositionAndRBACAccessHandler.

Definition at line 246 of file class.ilOrgUnitPositionAccess.php.

                                                                                  : bool
    {
        if ($this->access->checkAccess($rbac_perm, '', $ref_id)) {
            return true;
        }
 
        return $this->hasCurrentUserAnyPositionAccess($ref_id);
    }

References $ref_id, and ILIAS\Repository\access().

Referenced by ilAccess\hasUserRBACorAnyPositionAccess().

Here is the call graph for this function:

Here is the caller graph for this function:

isCurrentUserBasedOnPositionsAllowedTo()

ilOrgUnitPositionAccess::isCurrentUserBasedOnPositionsAllowedTo	(	string	$permission,
		array	$on_user_ids
	)

Parameters

int[]

$on_user_ids

Implements ilOrgUnitPositionAccessHandler.

Definition at line 68 of file class.ilOrgUnitPositionAccess.php.

                                                                                                  : bool
    {
        $current_user_id = $this->getCurrentUsersId();
 
        return $this->isUserBasedOnPositionsAllowedTo($current_user_id, $permission, $on_user_ids);
    }

Referenced by ilAccess\isCurrentUserBasedOnPositionsAllowedTo().

Here is the caller graph for this function:

isPositionActiveForRefId()

ilOrgUnitPositionAccess::isPositionActiveForRefId ( int  $ref_id )

private

Definition at line 280 of file class.ilOrgUnitPositionAccess.php.

                                                          : bool
    {
        $obj_id = $this->getObjIdForRefId($ref_id); // TODO this will change to ref_id!!
 
        return $this->set->isPositionAccessActiveForObject($obj_id);
    }

References $ref_id.

isUserBasedOnPositionsAllowedTo()

ilOrgUnitPositionAccess::isUserBasedOnPositionsAllowedTo	(	int	$which_user_id,
		string	$permission,
		array	$on_user_ids
	)

Parameters

int[]

$on_user_ids

Implements ilOrgUnitPositionAccessHandler.

Definition at line 77 of file class.ilOrgUnitPositionAccess.php.

     : bool {
        $filtered_user_ids = $this->filterUserIdsForUsersPositionsAndPermission(
            $on_user_ids,
            $which_user_id,
            $permission
        );
 
        return ($on_user_ids === array_intersect($on_user_ids, $filtered_user_ids)
            && $filtered_user_ids === array_intersect($filtered_user_ids, $on_user_ids));
    }

Referenced by ilAccess\isUserBasedOnPositionsAllowedTo().

Here is the caller graph for this function:

Field Documentation

$access

ilAccess ilOrgUnitPositionAccess::$access

private

Definition at line 28 of file class.ilOrgUnitPositionAccess.php.

Referenced by __construct().

$ref_id_obj_type_map

array ilOrgUnitPositionAccess::$ref_id_obj_type_map = array()

staticprotected

Definition at line 25 of file class.ilOrgUnitPositionAccess.php.

$set

ilOrgUnitGlobalSettings ilOrgUnitPositionAccess::$set

private

Definition at line 27 of file class.ilOrgUnitPositionAccess.php.

$ua

ilOrgUnitUserAssignmentQueries ilOrgUnitPositionAccess::$ua

private

Definition at line 26 of file class.ilOrgUnitPositionAccess.php.

$user

ilObjUser ilOrgUnitPositionAccess::$user

private

Definition at line 29 of file class.ilOrgUnitPositionAccess.php.

---

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

• Modules/OrgUnit/classes/class.ilOrgUnitPositionAccess.php