ilOrgUnitPositionAccessHandler Interface Reference

Interface ilOrgUnitPositionAccessHandler Provides access checks due to a users OrgUnit-Positions. More...

Inheritance diagram for ilOrgUnitPositionAccessHandler:

Collaboration diagram for ilOrgUnitPositionAccessHandler:

Public Member Functions
	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)

Detailed Description

Interface ilOrgUnitPositionAccessHandler Provides access checks due to a users OrgUnit-Positions.

Author

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

Definition at line 8 of file class.ilOrgUnitPositionAccessHandler.php.

Member Function Documentation

checkPositionAccess()

ilOrgUnitPositionAccessHandler::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

Implemented in ilOrgUnitPositionAccess, and ilAccess.

filterUserIdsByPositionOfCurrentUser()

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

Parameters

string	$pos_perm
int	$ref_id
int[]	$user_ids

Returns

int[]

See also

getAvailablePositionRelatedPermissions for available permissions

Implemented in ilOrgUnitPositionAccess, and ilAccess.

filterUserIdsByPositionOfUser()

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

Parameters

int	$user_id
string	$pos_perm
int	$ref_id
int[]	$user_ids

Returns

int[]

See also

getAvailablePositionRelatedPermissions for available permissions

Implemented in ilOrgUnitPositionAccess, and ilAccess.

filterUserIdsForCurrentUsersPositionsAndPermission()

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

Parameters

int[]	$user_ids	List of ILIAS-User-IDs which shall be filtered
string	$permission

Returns

int[] Filtered List of ILIAS-User-IDs

Exceptions

ilOrgUnitAccessException when a unknown permission is used. See the list of available permissions in interface ilOrgUnitPositionAccessHandler

See also

getAvailablePositionRelatedPermissions for available permissions

Implemented in ilOrgUnitPositionAccess, and ilAccess.

filterUserIdsForUsersPositionsAndPermission()

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

Parameters

int[]	$user_ids	List of ILIAS-User-IDs which shall be filtered
int	$for_user_id
string	$permission

Returns

int[] Filtered List of ILIAS-User-IDs

Exceptions

ilOrgUnitAccessException when a unknown permission is used. See the list of available permissions in interface ilOrgUnitPositionAccessHandler

See also

getAvailablePositionRelatedPermissions for available permissions

Implemented in ilOrgUnitPositionAccess, and ilAccess.

hasCurrentUserAnyPositionAccess()

ilOrgUnitPositionAccessHandler::hasCurrentUserAnyPositionAccess

(

int

$ref_id

)

Parameters

int

$ref_id

Returns

bool

Implemented in ilOrgUnitPositionAccess, and ilAccess.

isCurrentUserBasedOnPositionsAllowedTo()

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

Parameters

string	$permission
int[]	$on_user_ids	List of ILIAS-User-IDs

Returns

bool

See also

getAvailablePositionRelatedPermissions for available permissions

Implemented in ilOrgUnitPositionAccess, and ilAccess.

isUserBasedOnPositionsAllowedTo()

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

Parameters

int	$which_user_id	Permission check for this ILIAS-User-ID
string	$permission
int[]	$on_user_ids	List of ILIAS-User-IDs

Returns

bool

See also

getAvailablePositionRelatedPermissions for available permissions

Implemented in ilOrgUnitPositionAccess, and ilAccess.

---

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

• Modules/OrgUnit/interfaces/class.ilOrgUnitPositionAccessHandler.php