OrgUnitPermissionRepository Interface Reference

Inheritance diagram for OrgUnitPermissionRepository:

Collaboration diagram for OrgUnitPermissionRepository:

Public Member Functions
	get (int $parent_id, int $position_id)
	Get local permission for parent and position If no permission exists yet, it is created from the default setting. More...
	find (int $parent_id, int $position_id)
	Find local permission for parent and position Does not create new local permissions, returns null if no local permission exists. More...
	store (ilOrgUnitPermission $permission)
	Store permission to db Returns permission with updated fields (see update()) More...
	delete (int $parent_id, int $position_id)
	Delete local permission for parent and position Returns false if no local permission exists. More...
	update (ilOrgUnitPermission $permission)
	Update/refresh the additional fields of the permssion object (e.g. More...
	getLocalorDefault (int $parent_id, int $position_id)
	Get an existing local permission. More...
	getDefaultForContext (string $context_name, int $position_id, bool $editable=false)
	Get the default setting for a specified context If the setting does not exist, it is created (if permissions are enabled for this context) More...
	getDefaultsForActiveContexts (int $position_id, bool $editable=false)
	Get an array of default settings for all active contexts If the settings don't exist yet, they will be created (if permissions are enabled for these contexts) More...

Detailed Description

Definition at line 21 of file OrgUnitPermissionRepository.php.

Member Function Documentation

delete()

OrgUnitPermissionRepository::delete	(	int	$parent_id,
		int	$position_id
	)

Delete local permission for parent and position Returns false if no local permission exists.

Exceptions

ilException
ilPositionPermissionsNotActive

Implemented in ilOrgUnitPermissionDBRepository.

find()

OrgUnitPermissionRepository::find	(	int	$parent_id,
		int	$position_id
	)

Find local permission for parent and position Does not create new local permissions, returns null if no local permission exists.

Implemented in ilOrgUnitPermissionDBRepository.

get()

OrgUnitPermissionRepository::get	(	int	$parent_id,
		int	$position_id
	)

Get local permission for parent and position If no permission exists yet, it is created from the default setting.

Exceptions

ilException
ilPositionPermissionsNotActive

Implemented in ilOrgUnitPermissionDBRepository.

getDefaultForContext()

OrgUnitPermissionRepository::getDefaultForContext	(	string	$context_name,
		int	$position_id,
		bool	$editable = false
	)

Get the default setting for a specified context If the setting does not exist, it is created (if permissions are enabled for this context)

Implemented in ilOrgUnitPermissionDBRepository.

getDefaultsForActiveContexts()

OrgUnitPermissionRepository::getDefaultsForActiveContexts	(	int	$position_id,
		bool	$editable = false
	)

Get an array of default settings for all active contexts If the settings don't exist yet, they will be created (if permissions are enabled for these contexts)

Returns

array ilOrgUnitPermission[]

Implemented in ilOrgUnitPermissionDBRepository.

getLocalorDefault()

OrgUnitPermissionRepository::getLocalorDefault	(	int	$parent_id,
		int	$position_id
	)

Get an existing local permission.

If a local permission does not exist, return a protected default setting (if permissions are enabled for the context of the parent_id)

Exceptions

ilException
ilPositionPermissionsNotActive

Implemented in ilOrgUnitPermissionDBRepository.

store()

OrgUnitPermissionRepository::store

(

ilOrgUnitPermission

$permission

)

Store permission to db Returns permission with updated fields (see update())

Implemented in ilOrgUnitPermissionDBRepository.

update()

OrgUnitPermissionRepository::update

(

ilOrgUnitPermission

$permission

)

Update/refresh the additional fields of the permssion object (e.g.

available operations)

This is done via the repository cause it also needs data from the operations/context repositories Ideally, this should be private use only but is still needed as public in the current version

Implemented in ilOrgUnitPermissionDBRepository.

---

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

• components/ILIAS/OrgUnit/classes/Positions/Permissions/OrgUnitPermissionRepository.php