ILIAS\Survey\Access\AccessManager Class Reference

Collaboration diagram for ILIAS\Survey\Access\AccessManager:

Public Member Functions
	__construct (InternalDomainService $domain_service, \ilAccessHandler $access, int $ref_id, int $user_id)
	canRead ()
	canManageCodes ()
	canAccessInfoScreen ()
	Can access info screen: This is possible for external raters, or users with read or visible permission. More...
	canStartSurvey ()
	Can start the survey This is possible for external raters, or users with read or visible permission Note: This is true before entering the code, the code is not checked yet. More...
	canEditSettings ()
	canAccessEvaluation ()
	Can access evaluation. More...
	useCodeFromSession ()
	Is it possible to take the survey by providing an access code? More...
	canReadResultOfParticipants (?array $a_finished_ids=null)
	Gets all participants or a subset of participants (by run ids) where the current user can access the results. More...

Protected Member Functions
	getSurvey ()
	checkRbacOrPositionPermission (string $a_rbac_permission, string $a_position_permission)

Protected Attributes
ilAccessHandler	$access
int	$ref_id
int	$user_id
InternalDomainService	$domain_service

Detailed Description

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ILIAS\Survey\Access\AccessManager::__construct	(	InternalDomainService	$domain_service,
		\ilAccessHandler	$access,
		int	$ref_id,
		int	$user_id
	)

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

      {
        $this->domain_service = $domain_service;
        $this->access = $access;
        $this->user_id = $user_id;
        $this->ref_id = $ref_id;
    }

References ILIAS\Survey\Access\AccessManager\$access, ILIAS\Survey\Access\AccessManager\$domain_service, ILIAS\Survey\Access\AccessManager\$ref_id, ILIAS\Survey\Access\AccessManager\$user_id, and ILIAS\Repository\access().

Here is the call graph for this function:

Member Function Documentation

canAccessEvaluation()

ILIAS\Survey\Access\AccessManager::canAccessEvaluation

(

)

Can access evaluation.

Definition at line 125 of file class.AccessManager.php.

                                         : bool
    {
        $survey = $this->getSurvey();
        if ($this->access->checkAccessOfUser($this->user_id, "write", "", $this->ref_id) ||
            $this->checkRbacOrPositionPermission('read_results', 'access_results') ||
            \ilObjSurveyAccess::_hasEvaluationAccess($survey->getId(), $this->user_id)) {
            return true;
        }
        return false;
    }

References ilObjSurveyAccess\_hasEvaluationAccess(), ILIAS\Repository\access(), and ILIAS\Survey\Access\AccessManager\getSurvey().

Here is the call graph for this function:

canAccessInfoScreen()

ILIAS\Survey\Access\AccessManager::canAccessInfoScreen

(

)

Can access info screen: This is possible for external raters, or users with read or visible permission.

Definition at line 82 of file class.AccessManager.php.

                                         : bool
    {
        $participant_status = $this->domain_service
            ->participants()
            ->status($this->getSurvey(), $this->user_id);
        if ($participant_status->isExternalRater() ||
            $this->access->checkAccessOfUser($this->user_id, "read", "", $this->ref_id) ||
            $this->access->checkAccessOfUser($this->user_id, "visible", "", $this->ref_id)) {
            return true;
        }
        return false;
    }

References ILIAS\Survey\Access\AccessManager\getSurvey().

Here is the call graph for this function:

canEditSettings()

ILIAS\Survey\Access\AccessManager::canEditSettings

(

)

Definition at line 117 of file class.AccessManager.php.

                                     : bool
    {
        return $this->access->checkAccessOfUser($this->user_id, "write", "", $this->ref_id);
    }

References ILIAS\Repository\access().

Here is the call graph for this function:

canManageCodes()

ILIAS\Survey\Access\AccessManager::canManageCodes

(

)

Definition at line 62 of file class.AccessManager.php.

                                    : bool
    {
        return $this->access->checkAccessOfUser(
            $this->user_id,
            "write",
            "",
            $this->ref_id
        ) ||
            $this->access->checkAccessOfUser(       // see #35369
                $this->user_id,
                "delete",
                "",
                $this->ref_id
            );
    }

References ILIAS\Repository\access().

Here is the call graph for this function:

canRead()

ILIAS\Survey\Access\AccessManager::canRead

(

)

Definition at line 52 of file class.AccessManager.php.

                             : bool
    {
        return $this->access->checkAccessOfUser(
            $this->user_id,
            "read",
            "",
            $this->ref_id
        );
    }

References ILIAS\Repository\access().

Here is the call graph for this function:

canReadResultOfParticipants()

ILIAS\Survey\Access\AccessManager::canReadResultOfParticipants

(

?array

$a_finished_ids = null

)

Gets all participants or a subset of participants (by run ids) where the current user can access the results.

Definition at line 168 of file class.AccessManager.php.

     : array {
        $all_participants = $this->getSurvey()->getSurveyParticipants($a_finished_ids);
        $participant_ids = [];
        foreach ($all_participants as $participant) {
            if (isset($participant['usr_id'])) {
                $participant_ids[] = $participant['usr_id'];
            }
        }
 
        $filtered_participant_ids = $this->access->filterUserIdsByRbacOrPositionOfCurrentUser(
            'read_results',
            'access_results',
            $this->getSurvey()->getRefId(),
            $participant_ids
        );
        $participants = [];
        foreach ($all_participants as $username => $user_data) {
            if (!isset($user_data['usr_id'])) {
                $participants[$username] = $user_data;
            }
            if (in_array(($user_data['usr_id'] ?? null), $filtered_participant_ids)) {
                $participants[$username] = $user_data;
            }
        }
        return $participants;
    }

canStartSurvey()

ILIAS\Survey\Access\AccessManager::canStartSurvey

(

)

Can start the survey This is possible for external raters, or users with read or visible permission Note: This is true before entering the code, the code is not checked yet.

Definition at line 100 of file class.AccessManager.php.

                                    : bool
    {
        $survey = $this->getSurvey();
        $participant_status = $this->domain_service
            ->participants()
            ->status($survey, $this->user_id);
        if ($participant_status->isExternalRater() ||
            $this->access->checkAccessOfUser($this->user_id, "read", "", $this->ref_id)) {
            if (!$survey->getOfflineStatus() &&
                $survey->hasStarted() &&
                !$survey->hasEnded()) {
                return true;
            }
        }
        return false;
    }

References ILIAS\Survey\Access\AccessManager\getSurvey().

Here is the call graph for this function:

checkRbacOrPositionPermission()

ILIAS\Survey\Access\AccessManager::checkRbacOrPositionPermission ( string  $a_rbac_permission, string  $a_position_permission  )

protected

Definition at line 136 of file class.AccessManager.php.

     : bool {
        $access = $this->access;
        return $access->checkRbacOrPositionPermissionAccess(
            $a_rbac_permission,
            $a_position_permission,
            $this->ref_id
        );
    }

getSurvey()

ILIAS\Survey\Access\AccessManager::getSurvey ( )

protected

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

                                  : \ilObjSurvey
    {
        return new \ilObjSurvey($this->ref_id);
    }

Referenced by ILIAS\Survey\Access\AccessManager\canAccessEvaluation(), ILIAS\Survey\Access\AccessManager\canAccessInfoScreen(), and ILIAS\Survey\Access\AccessManager\canStartSurvey().

Here is the caller graph for this function:

useCodeFromSession()

ILIAS\Survey\Access\AccessManager::useCodeFromSession

(

)

Is it possible to take the survey by providing an access code?

Definition at line 151 of file class.AccessManager.php.

                                        : bool
    {
        $survey = $this->getSurvey();
        $participant_status = $this->domain_service
            ->participants()
            ->status($this->getSurvey(), $this->user_id);
        if ($participant_status->isExternalRater() ||
            $survey->getAnonymize() || $this->user_id === ANONYMOUS_USER_ID || !$survey->isAccessibleWithoutCode()) {
            return true;
        }
        return false;
    }

References ANONYMOUS_USER_ID.

Field Documentation

$access

ilAccessHandler ILIAS\Survey\Access\AccessManager::$access

protected

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

Referenced by ILIAS\Survey\Access\AccessManager\__construct().

$domain_service

InternalDomainService ILIAS\Survey\Access\AccessManager::$domain_service

protected

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

Referenced by ILIAS\Survey\Access\AccessManager\__construct().

$ref_id

int ILIAS\Survey\Access\AccessManager::$ref_id

protected

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

Referenced by ILIAS\Survey\Access\AccessManager\__construct().

$user_id

int ILIAS\Survey\Access\AccessManager::$user_id

protected

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

Referenced by ILIAS\Survey\Access\AccessManager\__construct().

---

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

• components/ILIAS/Survey/Access/class.AccessManager.php