ilOrgUnitPermissionDBRepository Class Reference

Inheritance diagram for ilOrgUnitPermissionDBRepository:

Collaboration diagram for ilOrgUnitPermissionDBRepository:

Public Member Functions
	__construct (ilDBInterface $db, ilOrgUnitOperationDBRepository $operationRepo, ilOrgUnitOperationContextDBRepository $contextRepo)
	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...

Data Fields
const	TABLE_NAME = 'il_orgu_permissions'

Protected Attributes
ilOrgUnitOperationContextDBRepository	$contextRepo
ilDBInterface	$db
ilOrgUnitOperationDBRepository	$operationRepo

Private Member Functions
	insertDB (ilOrgUnitPermission $permission)
	updateDB (ilOrgUnitPermission $permission)
	isContextEnabled (string $context)
	convertToArray (string $operations)
	This will be replaced in a future update including a migration for existing db entries. More...
	convertToJson (array $operations)
	This will be replaced in a future update including a migration for existing db entries. More...

Detailed Description

Definition at line 21 of file class.ilOrgUnitPermissionDBRepository.php.

Constructor & Destructor Documentation

__construct()

ilOrgUnitPermissionDBRepository::__construct	(	ilDBInterface	$db,
		ilOrgUnitOperationDBRepository	$operationRepo,
		ilOrgUnitOperationContextDBRepository	$contextRepo
	)

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

References $contextRepo, $db, and $operationRepo.

    {
        $this->db = $db;
        $this->operationRepo = $operationRepo;
        $this->contextRepo = $contextRepo;
    }

Member Function Documentation

convertToArray()

ilOrgUnitPermissionDBRepository::convertToArray ( string  $operations )

private

This will be replaced in a future update including a migration for existing db entries.

Definition at line 325 of file class.ilOrgUnitPermissionDBRepository.php.

Referenced by find(), and getDefaultForContext().

    {
        $ids = json_decode($operations);
        $ret = [];
        foreach ($ids as $operation_id) {
            $ret[] = $this->operationRepo->getById((int) $operation_id);
        }
        return $ret;
    }

Here is the caller graph for this function:

convertToJson()

ilOrgUnitPermissionDBRepository::convertToJson ( array  $operations )

private

This will be replaced in a future update including a migration for existing db entries.

Definition at line 339 of file class.ilOrgUnitPermissionDBRepository.php.

Referenced by insertDB(), and updateDB().

    {
        $ids = [];
        foreach ($operations as $operation) {
            $ids[] = $operation->getOperationId();
        }
        return json_encode($ids);
    }

Here is the caller graph for this function:

delete()

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

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

Exceptions

ilException
ilPositionPermissionsNotActive

Implements OrgUnitPermissionRepository.

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

References $context, find(), and isContextEnabled().

                                                            : bool
    {
        if ($position_id === 0) {
            throw new ilException('$position_id cannot be 0');
        }
        if ($parent_id <= 0) {
            throw new ilException('$parent_id cannot be <=0');
        }

        $context = $this->contextRepo->getByRefId($parent_id);
        if (!$context) {
            throw new ilException('Context for ref_id ' . $parent_id . ' not found');
        }

        if (!$this->isContextEnabled($context->getContext())) {
            throw new ilPositionPermissionsNotActive(
                "Position-related permissions not active in {$context->getContext()}",
                $context->getContext()
            );
        }

        $permission = $this->find($parent_id, $position_id);
        if ($permission) {
            $query = 'DELETE FROM ' . self::TABLE_NAME . PHP_EOL
                . ' WHERE id = ' . $this->db->quote($permission->getId(), 'integer');
            $this->db->manipulate($query);

            return true;
        }

        return false;
    }

Here is the call graph for this function:

find()

ilOrgUnitPermissionDBRepository::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.

Implements OrgUnitPermissionRepository.

Definition at line 73 of file class.ilOrgUnitPermissionDBRepository.php.

References $context, $res, convertToArray(), isContextEnabled(), null, and update().

Referenced by delete(), get(), and getLocalorDefault().

                                                          : ?ilOrgUnitPermission
    {
        if ($position_id === 0) {
            throw new ilException('$position_id cannot be 0');
        }
        if ($parent_id <= 0) {
            throw new ilException('$parent_id cannot be <=0');
        }

        $context = $this->contextRepo->getByRefId($parent_id);
        if (!$context) {
            return null;
        }

        if (!$this->isContextEnabled($context->getContext())) {
            return null;
        }

        $query = 'SELECT id, parent_id, context_id, position_id, protected, operations FROM' . PHP_EOL
            . self::TABLE_NAME
            . ' WHERE ' . self::TABLE_NAME . '.parent_id = ' . $this->db->quote($parent_id, 'integer') . PHP_EOL
            . ' AND ' . self::TABLE_NAME . '.position_id = ' . $this->db->quote($position_id, 'integer') . PHP_EOL
            . ' AND ' . self::TABLE_NAME . '.context_id = ' . $this->db->quote($context->getId(), 'integer') . PHP_EOL;
        $res = $this->db->query($query);
        if ($res->numRows() === 0) {
            return null;
        }

        $rec = $this->db->fetchAssoc($res);
        $ret = (new ilOrgUnitPermission((int) $rec['id']))
            ->withParentId((int) $rec["parent_id"])
            ->withContextId((int) $rec['context_id'])
            ->withPositionId((int) $rec['position_id'])
            ->withProtected((bool) $rec['protected'])
            ->withOperations($this->convertToArray((string) $rec["operations"]));

        $ret = $this->update($ret);
        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

get()

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

Implements OrgUnitPermissionRepository.

Definition at line 35 of file class.ilOrgUnitPermissionDBRepository.php.

References $context, find(), getDefaultForContext(), isContextEnabled(), and store().

                                                         : ilOrgUnitPermission
    {
        if ($position_id === 0) {
            throw new ilException('$position_id cannot be 0');
        }
        if ($parent_id <= 0) {
            throw new ilException('$parent_id cannot be <=0');
        }

        $context = $this->contextRepo->getByRefId($parent_id);
        if (!$context) {
            throw new ilException('Context for ref_id ' . $parent_id . ' not found');
        }

        if (!$this->isContextEnabled($context->getContext())) {
            throw new ilPositionPermissionsNotActive(
                "Position-related permissions not active in {$context->getContext()}",
                $context->getContext()
            );
        }

        $permission = $this->find($parent_id, $position_id);
        if ($permission) {
            return $permission;
        }

        $template = $this->getDefaultForContext($context->getContext(), $position_id);
        $permission = (new ilOrgUnitPermission())
            ->withParentId($parent_id)
            ->withContextId($context->getId())
            ->withPositionId($position_id)
            ->withOperations($template->getOperations())
            ->withProtected(false);
        $permission = $this->store($permission);

        return $permission;
    }

Here is the call graph for this function:

getDefaultForContext()

ilOrgUnitPermissionDBRepository::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)

Implements OrgUnitPermissionRepository.

Definition at line 249 of file class.ilOrgUnitPermissionDBRepository.php.

References $context, $res, convertToArray(), ilOrgUnitPermission\PARENT_TEMPLATE, store(), and update().

Referenced by get(), getDefaultsForActiveContexts(), and getLocalorDefault().

                                                                                                        : ilOrgUnitPermission
    {
        if ($position_id === 0) {
            throw new ilException('$position_id cannot be 0');
        }

        $context = $this->contextRepo->find($context_name);
        if (!$context) {
            throw new ilException('Context ' . $context_name . ' not found');
        }

        $template = false;
        $query = 'SELECT id, parent_id, context_id, position_id, protected, operations FROM' . PHP_EOL
            . self::TABLE_NAME
            . ' WHERE ' . self::TABLE_NAME . '.parent_id = ' . $this->db->quote(ilOrgUnitPermission::PARENT_TEMPLATE, 'integer') . PHP_EOL
            . ' AND ' . self::TABLE_NAME . '.position_id = ' . $this->db->quote($position_id, 'integer') . PHP_EOL
            . ' AND ' . self::TABLE_NAME . '.context_id = ' . $this->db->quote($context->getId(), 'integer') . PHP_EOL;
        $res = $this->db->query($query);
        if ($res->numRows() > 0) {
            $rec = $this->db->fetchAssoc($res);
            $template = (new ilOrgUnitPermission((int) $rec['id']))
                ->withParentId((int) $rec["parent_id"])
                ->withContextId((int) $rec['context_id'])
                ->withPositionId((int) $rec['position_id'])
                ->withProtected((bool) $rec['protected'])
                ->withOperations($this->convertToArray((string) $rec["operations"]));
            $template = $this->update($template);
        }

        if (!$template) {
            $template = (new ilOrgUnitPermission())
                ->withParentId(ilOrgUnitPermission::PARENT_TEMPLATE)
                ->withContextId($context->getId())
                ->withPositionId($position_id)
                ->withProtected(true);
            $template = $this->store($template);
        }

        $template = $template->withProtected(!$editable);
        $template = $this->update($template);

        return $template;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultsForActiveContexts()

ilOrgUnitPermissionDBRepository::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[]

Implements OrgUnitPermissionRepository.

Definition at line 293 of file class.ilOrgUnitPermissionDBRepository.php.

References $context, getDefaultForContext(), and ilOrgUnitGlobalSettings\getInstance().

                                                                                          : array
    {
        $active_contexts = [];
        foreach (ilOrgUnitGlobalSettings::getInstance()->getPositionSettings() as $ilOrgUnitObjectPositionSetting) {
            if ($ilOrgUnitObjectPositionSetting->isActive()) {
                $active_contexts[] = $ilOrgUnitObjectPositionSetting->getType();
            }
        }

        $permissions = [];
        foreach ($active_contexts as $context) {
            $permissions[] = $this->getDefaultForContext($context, $position_id, $editable);
        }

        return $permissions;
    }

Here is the call graph for this function:

getLocalorDefault()

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

Implements OrgUnitPermissionRepository.

Definition at line 223 of file class.ilOrgUnitPermissionDBRepository.php.

References $context, find(), getDefaultForContext(), and isContextEnabled().

                                                                       : ilOrgUnitPermission
    {
        if ($position_id === 0) {
            throw new ilException('$position_id cannot be 0');
        }

        $context = $this->contextRepo->getByRefId($parent_id);
        if (!$context) {
            throw new ilException('Context for ref_id ' . $parent_id . ' not found');
        }

        if (!$this->isContextEnabled($context->getContext())) {
            throw new ilPositionPermissionsNotActive(
                "Position-related permissions not active in {$context->getContext()}",
                $context->getContext()
            );
        }

        $permission = $this->find($parent_id, $position_id);
        if ($permission) {
            return $permission;
        }

        return $this->getDefaultForContext($context->getContext(), $position_id);
    }

Here is the call graph for this function:

insertDB()

ilOrgUnitPermissionDBRepository::insertDB ( ilOrgUnitPermission  $permission )

private

Definition at line 131 of file class.ilOrgUnitPermissionDBRepository.php.

References $id, convertToJson(), ilOrgUnitPermission\getContextId(), ilOrgUnitPermission\getOperations(), ilOrgUnitPermission\getParentId(), ilOrgUnitPermission\getPositionId(), and ilOrgUnitPermission\isProtected().

Referenced by store().

                                                              : ilOrgUnitPermission
    {
        $id = $this->db->nextId(self::TABLE_NAME);

        $values = [
            'id' => [ 'integer', $id ],
            'parent_id' => [ 'string', $permission->getParentId()],
            'context_id' => [ 'string', $permission->getContextId()],
            'position_id' => [ 'integer', $permission->getPositionId() ],
            'protected' => [ 'integer',  ($permission->isProtected()) ? 1 : 0],
            'operations' => [ 'string', $this->convertToJson($permission->getOperations())]
        ];

        $this->db->insert(self::TABLE_NAME, $values);

        return (new ilOrgUnitPermission($id))
            ->withParentId($permission->getParentId())
            ->withContextId($permission->getContextId())
            ->withPositionId($permission->getPositionId())
            ->withProtected($permission->isProtected())
            ->withOperations($permission->getOperations());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isContextEnabled()

ilOrgUnitPermissionDBRepository::isContextEnabled ( string  $context )

private

Definition at line 310 of file class.ilOrgUnitPermissionDBRepository.php.

References ilOrgUnitGlobalSettings\getInstance().

Referenced by delete(), find(), get(), and getLocalorDefault().

                                                      : bool
    {
        $ilOrgUnitGlobalSettings = ilOrgUnitGlobalSettings::getInstance();
        $ilOrgUnitObjectPositionSetting = $ilOrgUnitGlobalSettings->getObjectPositionSettingsByType($context);
        if (!$ilOrgUnitObjectPositionSetting->isActive()) {
            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

store()

ilOrgUnitPermissionDBRepository::store

(

ilOrgUnitPermission

$permission

)

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

Implements OrgUnitPermissionRepository.

Definition at line 113 of file class.ilOrgUnitPermissionDBRepository.php.

References ilOrgUnitPermission\getId(), ilOrgUnitPermission\getParentId(), insertDB(), ilOrgUnitPermission\isProtected(), ilOrgUnitPermission\PARENT_TEMPLATE, update(), updateDB(), and ilOrgUnitPermission\withProtected().

Referenced by get(), and getDefaultForContext().

                                                          : ilOrgUnitPermission
    {
        if ($permission->getId() === 0) {
            $permission = $this->insertDB($permission);
        } else {
            if ($permission->isProtected()) {
                throw new ilException("Protected permission " . $permission->getId() . " can not be updated");
            }
            if ($permission->getParentId() == ilOrgUnitPermission::PARENT_TEMPLATE) {
                $permission = $permission->withProtected(true);
            }
            $this->updateDB($permission);
        }

        $permission = $this->update($permission);
        return $permission;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

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

Implements OrgUnitPermissionRepository.

Definition at line 203 of file class.ilOrgUnitPermissionDBRepository.php.

References ilOrgUnitPermission\getContextId(), ilOrgUnitPermission\getOperations(), ilOrgUnitPermission\withContext(), ilOrgUnitPermission\withOperations(), ilOrgUnitPermission\withPossibleOperations(), and ilOrgUnitPermission\withSelectedOperationIds().

Referenced by find(), getDefaultForContext(), and store().

                                                           : ilOrgUnitPermission
    {
        $permission = $permission->withPossibleOperations(
            $this->operationRepo->getOperationsByContextId($permission->getContextId())
        );
        $permission = $permission->withOperations(
            is_array($permission->getOperations()) ? $permission->getOperations() : []
        );
        $selected_operation_ids = [];
        foreach ($permission->getOperations() as $operation) {
            $selected_operation_ids[] = $operation->getOperationId();
        }
        $permission = $permission->withSelectedOperationIds($selected_operation_ids);
        $permission = $permission->withContext(
            $this->contextRepo->getById($permission->getContextId())
        );

        return $permission;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateDB()

ilOrgUnitPermissionDBRepository::updateDB ( ilOrgUnitPermission  $permission )

private

Definition at line 154 of file class.ilOrgUnitPermissionDBRepository.php.

References convertToJson(), ilOrgUnitPermission\getContextId(), ilOrgUnitPermission\getId(), ilOrgUnitPermission\getOperations(), ilOrgUnitPermission\getParentId(), ilOrgUnitPermission\getPositionId(), and ilOrgUnitPermission\isProtected().

Referenced by store().

                                                              : void
    {
        $where = [ 'id' => [ 'integer', $permission->getId() ] ];

        $values = [
            'parent_id' => [ 'string', $permission->getParentId()],
            'context_id' => [ 'string', $permission->getContextId()],
            'position_id' => [ 'integer', $permission->getPositionId() ],
            'protected' => [ 'integer',  ($permission->isProtected()) ? 1 : 0],
            'operations' => [ 'string', $this->convertToJson($permission->getOperations())]
        ];

        $this->db->update(self::TABLE_NAME, $values, $where);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$contextRepo

ilOrgUnitOperationContextDBRepository ilOrgUnitPermissionDBRepository::$contextRepo

protected

Definition at line 24 of file class.ilOrgUnitPermissionDBRepository.php.

Referenced by __construct().

$db

ilDBInterface ilOrgUnitPermissionDBRepository::$db

protected

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

Referenced by __construct().

$operationRepo

ilOrgUnitOperationDBRepository ilOrgUnitPermissionDBRepository::$operationRepo

protected

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

Referenced by __construct().

TABLE_NAME

const ilOrgUnitPermissionDBRepository::TABLE_NAME = 'il_orgu_permissions'

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

---

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

• components/ILIAS/OrgUnit/classes/Positions/Permissions/class.ilOrgUnitPermissionDBRepository.php