ilObjEmployeeTalkAccess Class Reference

Inheritance diagram for ilObjEmployeeTalkAccess:

Collaboration diagram for ilObjEmployeeTalkAccess:

Public Member Functions
	__construct ()
	canCreate (?ilObjUser $talkParticipant=null)
	Checks if the user is allowed to create a new talks series. More...
	hasPermissionToReadUnownedTalksOfUser (int $userId)
	canRead (int $refId)
	canEditTalkLockStatus (int $refId)
	canEdit (int $refId)
	canDelete (int $refId)
	isTalkReadonlyByCurrentUser (int $ref_id)
Public Member Functions inherited from ilObjectAccess
	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
	Checks whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
	canBeDelivered (ilWACPath $ilWACPath)

Static Public Member Functions
static	getInstance ()
static	_getCommands ()
	get commands More...
static	_isOffline ($obj_id)
static	_checkGoto ($target)
Static Public Member Functions inherited from ilObjectAccess
static	_getCommands ()
	get commands More...
static	_checkGoto (string $target)
	check whether goto script will succeed More...
static	_isOffline (int $obj_id)
	Type-specific implementation of general status, has to be overwritten if object type does not support centralized offline handling. More...
static	_preloadData (array $obj_ids, array $ref_ids)
	Preload data. More...

Private Member Functions
	isPermittedToExecuteOperation (int $refId, string $operation)
	getCurrentUsersId ()

Private Attributes
ilOrgUnitUserAssignmentQueries	$ua
ilOrgUnitGlobalSettings	$set
IlOrgUnitPositionAccess	$orgUnitAccess
Container	$container
ilOrgUnitObjectTypePositionSetting	$talkPositionSettings
IliasDBEmployeeTalkSeriesRepository	$seriesSettingsRepository

Static Private Attributes
static self	$instance = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilObjEmployeeTalkAccess::__construct

(

)

Definition at line 47 of file class.ilObjEmployeeTalkAccess.php.

References $GLOBALS, ilOrgUnitUserAssignmentQueries\getInstance(), ilOrgUnitGlobalSettings\getInstance(), and ilObjEmployeeTalk\TYPE.

    {
        $this->container = $GLOBALS['DIC'];

        $this->set = ilOrgUnitGlobalSettings::getInstance();
        $this->ua = ilOrgUnitUserAssignmentQueries::getInstance();
        $this->orgUnitAccess = new ilOrgUnitPositionAccess($this->container->access());
        $this->talkPositionSettings = $this->set->getObjectPositionSettingsByType(ilObjEmployeeTalk::TYPE);
        $this->seriesSettingsRepository = new IliasDBEmployeeTalkSeriesRepository($this->container->user(), $this->container->database());
    }

Here is the call graph for this function:

Member Function Documentation

_checkGoto()

static ilObjEmployeeTalkAccess::_checkGoto (   $target )

static

Definition at line 89 of file class.ilObjEmployeeTalkAccess.php.

                                              : bool
    {
        $access = new self();

        $t_arr = explode('_', $target);
        if ($t_arr[0] !== 'etal' || ((int) $t_arr[1]) <= 0) {
            return false;
        }
        if ($access->canRead(intval($t_arr[1]))) {
            return true;
        }

        return false;
    }

_getCommands()

static ilObjEmployeeTalkAccess::_getCommands ( )

static

get commands

this method returns an array of all possible commands/permission combinations

example: $commands = array ( array('permission' => 'read', 'cmd' => 'view', 'lang_var' => 'show'), array('permission' => 'write', 'cmd' => 'edit', 'lang_var' => 'edit'), );

Definition at line 70 of file class.ilObjEmployeeTalkAccess.php.

Referenced by ilObjEmployeeTalkListGUI\init().

                                         : array
    {
        $commands = [
            [
                'permission' => 'read',
                'cmd' => ControlFlowCommand::DEFAULT,
                'lang_var' => 'show',
                'default' => true,
            ]
        ];

        return $commands;
    }

Here is the caller graph for this function:

_isOffline()

static ilObjEmployeeTalkAccess::_isOffline (   $obj_id )

static

Definition at line 84 of file class.ilObjEmployeeTalkAccess.php.

                                              : bool
    {
        return false;
    }

canCreate()

ilObjEmployeeTalkAccess::canCreate

(

?ilObjUser

$talkParticipant = null

)

Checks if the user is allowed to create a new talks series.

If no user is given only the position right is checked, which can be used to display create or new buttons based on the general position rights of the user.

If the user is given, only positions with an authority over the given user are used to check the position rights.

Parameters

ilObjUser | null

$talkParticipant

The talk participant which should get invited into the new talk.

Returns

bool True if the user has creation rights otherwise false.

Definition at line 115 of file class.ilObjEmployeeTalkAccess.php.

References getCurrentUsersId(), ilOrgUnitPermissionQueries\getTemplateSetForContextName(), null, and ilObjEmployeeTalk\TYPE.

                                                                 : bool
    {
        try {
            $currentUserId = $this->getCurrentUsersId();

            // Root has always full access
            if ($currentUserId === 6) {
                return true;
            }

            // Talks are never editable if the position rights are not active, because the talks don't use RBAC
            if (!$this->talkPositionSettings->isActive()) {
                return false;
            }

            $positions = $this->ua->getPositionsOfUserId($currentUserId);

            // If we don't have a user just check if the current user has the right in any position to create a new talk
            if ($talkParticipant === null) {
                foreach ($positions as $position) {
                    // Check if the position has any relevant position rights
                    $permissionSet = ilOrgUnitPermissionQueries::getTemplateSetForContextName(ilObjEmployeeTalk::TYPE, strval($position->getId() ?? 0));
                    $isAbleToExecuteOperation = array_reduce($permissionSet->getOperations(), function (bool $prev, ilOrgUnitOperation $it) {
                        return $prev || $it->getOperationString() === EmployeeTalkPositionAccessLevel::CREATE;
                    }, false);

                    // If the position has no rights check the next one
                    if (!$isAbleToExecuteOperation) {
                        continue;
                    }

                    return true;
                }

                // The current user was not in a position with create etal position rights
                return false;
            }

            // Validate authority and position rights over the given participant
            return $this->hasAuthorityAndOperationPermissionOverUser($talkParticipant, EmployeeTalkPositionAccessLevel::CREATE);
        } catch (\Exception $ex) {
            return false;
        }
    }

Here is the call graph for this function:

canDelete()

ilObjEmployeeTalkAccess::canDelete

(

int

$refId

)

Parameters

int

$refId

Returns

bool

Definition at line 200 of file class.ilObjEmployeeTalkAccess.php.

References getCurrentUsersId(), and SYSTEM_ROLE_ID.

                                         : bool
    {
        $talk = new ilObjEmployeeTalk($refId);
        $user = $this->getCurrentUsersId();
        if ($user === $talk->getOwner()) {
            return true;
        }
        // global admins can delete
        if ($this->container->rbac()->review()->isAssigned(
            $user,
            SYSTEM_ROLE_ID
        )) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

canEdit()

ilObjEmployeeTalkAccess::canEdit

(

int

$refId

)

Parameters

int

$refId

Returns

bool

Definition at line 191 of file class.ilObjEmployeeTalkAccess.php.

References isPermittedToExecuteOperation().

Referenced by isTalkReadonlyByCurrentUser().

                                       : bool
    {
        return $this->isPermittedToExecuteOperation($refId, EmployeeTalkPositionAccessLevel::EDIT);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

canEditTalkLockStatus()

ilObjEmployeeTalkAccess::canEditTalkLockStatus

(

int

$refId

)

Definition at line 174 of file class.ilObjEmployeeTalkAccess.php.

References getCurrentUsersId().

                                                     : bool
    {
        $currentUserId = $this->getCurrentUsersId();

        // Root has always full access
        if ($currentUserId === 6) {
            return true;
        }

        $talk = new ilObjEmployeeTalk($refId);
        return $talk->getOwner() === $currentUserId;
    }

Here is the call graph for this function:

canRead()

ilObjEmployeeTalkAccess::canRead

(

int

$refId

)

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

References isPermittedToExecuteOperation().

                                       : bool
    {
        return $this->isPermittedToExecuteOperation($refId, EmployeeTalkPositionAccessLevel::VIEW);
    }

Here is the call graph for this function:

getCurrentUsersId()

ilObjEmployeeTalkAccess::getCurrentUsersId ( )

private

Returns

int

Definition at line 285 of file class.ilObjEmployeeTalkAccess.php.

References ilObject\getId(), ilOrgUnitPermissionQueries\getTemplateSetForContextName(), and ilObjEmployeeTalk\TYPE.

Referenced by canCreate(), canDelete(), canEditTalkLockStatus(), and isPermittedToExecuteOperation().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getInstance()

static ilObjEmployeeTalkAccess::getInstance ( )

static

Definition at line 38 of file class.ilObjEmployeeTalkAccess.php.

Referenced by ilObjEmployeeTalkGUI\__construct().

                                        : self
    {
        if (is_null(self::$instance)) {
            self::$instance = new ilObjEmployeeTalkAccess();
        }

        return self::$instance;
    }

Here is the caller graph for this function:

hasPermissionToReadUnownedTalksOfUser()

ilObjEmployeeTalkAccess::hasPermissionToReadUnownedTalksOfUser

(

int

$userId

)

Definition at line 160 of file class.ilObjEmployeeTalkAccess.php.

                                                                      : bool
    {
        try {
            return $this->hasAuthorityAndOperationPermissionOverUser(new ilObjUser($userId), EmployeeTalkPositionAccessLevel::VIEW);
        } catch (\Exception $ex) {
            return false;
        }
    }

isPermittedToExecuteOperation()

ilObjEmployeeTalkAccess::isPermittedToExecuteOperation ( int  $refId, string  $operation  )

private

Definition at line 217 of file class.ilObjEmployeeTalkAccess.php.

References $data, and getCurrentUsersId().

Referenced by canEdit(), and canRead().

                                                                                 : bool
    {
        $currentUserId = $this->getCurrentUsersId();

        // Root has always full access
        if ($currentUserId === 6) {
            return true;
        }

        // Talks are never editable if the position rights are not active, because the talks don't use RBAC
        if (!$this->talkPositionSettings->isActive()) {
            return false;
        }

        $talk = new ilObjEmployeeTalk($refId);
        $series = $talk->getParent();
        $hasAuthority = $this->hasAuthorityAndOperationPermissionOverUser(new ilObjUser($talk->getData()->getEmployee()), $operation);
        $data = $talk->getData();
        $seriesSettings = $this->seriesSettingsRepository->readEmployeeTalkSerieSettings($series->getId());
        $canExecuteOperation = $this->orgUnitAccess->checkPositionAccess($operation, $refId);
        $isOwner = $talk->getOwner() === $currentUserId;

        if ($isOwner) {
            return true;
        }

        if ($currentUserId === $data->getEmployee()) {
            // The Employee can never edit their own talks
            if ($operation !== EmployeeTalkPositionAccessLevel::VIEW) {
                return false;
            }

            // The Employee can always read their own talks
            return true;
        }

        //Only owner can edit talks with enabled write lock
        if ($seriesSettings->isLockedEditing() && $operation === EmployeeTalkPositionAccessLevel::EDIT) {
            return false;
        }

        // Has no authority over the employee
        if (!$hasAuthority) {
            return false;
        }

        // Has Authority and is permitted to execute the given permission
        if ($canExecuteOperation) {
            return true;
        }

        // Has authority but no permission
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isTalkReadonlyByCurrentUser()

ilObjEmployeeTalkAccess::isTalkReadonlyByCurrentUser

(

int

$ref_id

)

Parameters

int

$ref_id

Returns

bool

Definition at line 277 of file class.ilObjEmployeeTalkAccess.php.

References canEdit().

                                                            : bool
    {
        return !$this->canEdit($ref_id);
    }

Here is the call graph for this function:

Field Documentation

$container

Container ilObjEmployeeTalkAccess::$container

private

Definition at line 34 of file class.ilObjEmployeeTalkAccess.php.

$instance

self ilObjEmployeeTalkAccess::$instance = null

staticprivate

Definition at line 30 of file class.ilObjEmployeeTalkAccess.php.

$orgUnitAccess

IlOrgUnitPositionAccess ilObjEmployeeTalkAccess::$orgUnitAccess

private

Definition at line 33 of file class.ilObjEmployeeTalkAccess.php.

$seriesSettingsRepository

IliasDBEmployeeTalkSeriesRepository ilObjEmployeeTalkAccess::$seriesSettingsRepository

private

Definition at line 36 of file class.ilObjEmployeeTalkAccess.php.

$set

ilOrgUnitGlobalSettings ilObjEmployeeTalkAccess::$set

private

Definition at line 32 of file class.ilObjEmployeeTalkAccess.php.

$talkPositionSettings

ilOrgUnitObjectTypePositionSetting ilObjEmployeeTalkAccess::$talkPositionSettings

private

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

$ua

ilOrgUnitUserAssignmentQueries ilObjEmployeeTalkAccess::$ua

private

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

---

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

• components/ILIAS/EmployeeTalk/classes/Talk/class.ilObjEmployeeTalkAccess.php