ilTestAccess Class Reference

Collaboration diagram for ilTestAccess:

Public Member Functions
	getAccess ()
	setAccess (ilAccessHandler $access)
	getRefId ()
	checkCorrectionsAccess ()
	checkScoreParticipantsAccess ()
	checkScoreParticipantsAccessAnon ()
	checkManageParticipantsAccess ()
	checkParticipantsResultsAccess ()
	checkOtherParticipantsLearningProgressAccess ()
	checkResultsAccessForActiveId (int $active_id, int $test_id)
	checkScoreParticipantsAccessForActiveId (int $active_id, int $test_id)
	isParticipantAllowed (int $obj_id, int $user_id)

Protected Member Functions
	checkAccessForActiveId (Closure $access_filter, int $active_id, int $test_id)

Protected Attributes
ilAccessHandler	$access
ilDBInterface	$db
ilLanguage	$lng
MainSettingsDatabaseRepository	$main_settings_repository
ilTestParticipantAccessFilterFactory	$participant_access_filter
ParticipantRepository	$participant_repository

Private Member Functions
	isParticipantExplicitelyAllowedByIndividualIPRange (?Participant $participant, string $ip)
	isIpAllowedToAccessTest (string $ip, SettingsAccess $access_settings)
	isIpTypeOf (int $ip_type_flag, string $ip, string $range_start, string $range_end)
	isIpv4Between (string $ip, string $range_start, string $range_end)
	isIpv6Between (string $ip, string $range_start, string $range_end)

Detailed Description

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

Member Function Documentation

checkAccessForActiveId()

ilTestAccess::checkAccessForActiveId ( Closure  $access_filter, int  $active_id, int  $test_id  )

protected

Definition at line 163 of file class.ilTestAccess.php.

References ILIAS\Repository\lng().

Referenced by checkResultsAccessForActiveId(), and checkScoreParticipantsAccessForActiveId().

                                                                                                   : bool
    {
        $participantData = new ilTestParticipantData($this->db, $this->lng);
        $participantData->setActiveIdsFilter([$active_id]);
        $participantData->setParticipantAccessFilter($access_filter);
        $participantData->load($test_id);

        return in_array($active_id, $participantData->getActiveIds());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkCorrectionsAccess()

ilTestAccess::checkCorrectionsAccess

(

)

Returns

bool

Definition at line 77 of file class.ilTestAccess.php.

References getAccess(), and getRefId().

                                            : bool
    {
        return $this->getAccess()->checkAccess('write', '', $this->getRefId());
    }

Here is the call graph for this function:

checkManageParticipantsAccess()

ilTestAccess::checkManageParticipantsAccess

(

)

Returns

bool

Definition at line 104 of file class.ilTestAccess.php.

References getAccess(), getRefId(), and ilOrgUnitOperation\OP_MANAGE_PARTICIPANTS.

                                                   : bool
    {
        if ($this->getAccess()->checkAccess('write', '', $this->getRefId())) {
            return true;
        }

        if (!$this->getAccess()->checkAccess('read', '', $this->getRefId())) {
            return false;
        }

        if ($this->getAccess()->checkPositionAccess(ilOrgUnitOperation::OP_MANAGE_PARTICIPANTS, $this->getRefId())) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

checkOtherParticipantsLearningProgressAccess()

ilTestAccess::checkOtherParticipantsLearningProgressAccess

(

)

Definition at line 146 of file class.ilTestAccess.php.

References getAccess(), getRefId(), and ilOrgUnitOperation\OP_READ_LEARNING_PROGRESS.

                                                                  : bool
    {
        if ($this->getAccess()->checkAccess('write', '', $this->getRefId())) {
            return true;
        }

        if ($this->getAccess()->checkRbacOrPositionPermissionAccess(
            'read_learning_progress',
            ilOrgUnitOperation::OP_READ_LEARNING_PROGRESS,
            $this->getRefId()
        )) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

checkParticipantsResultsAccess()

ilTestAccess::checkParticipantsResultsAccess

(

)

Definition at line 121 of file class.ilTestAccess.php.

References getAccess(), getRefId(), ilOrgUnitOperation\OP_ACCESS_RESULTS, and ilOrgUnitOperation\OP_MANAGE_PARTICIPANTS.

                                                    : bool
    {
        if ($this->getAccess()->checkAccess('write', '', $this->getRefId())) {
            return true;
        }

        if ($this->getAccess()->checkAccess('tst_results', '', $this->getRefId())) {
            return true;
        }

        if (!$this->getAccess()->checkAccess('read', '', $this->getRefId())) {
            return false;
        }

        if ($this->getAccess()->checkPositionAccess(ilOrgUnitOperation::OP_MANAGE_PARTICIPANTS, $this->getRefId())) {
            return true;
        }

        if ($this->getAccess()->checkPositionAccess(ilOrgUnitOperation::OP_ACCESS_RESULTS, $this->getRefId())) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

checkResultsAccessForActiveId()

ilTestAccess::checkResultsAccessForActiveId	(	int	$active_id,
		int	$test_id
	)

Definition at line 173 of file class.ilTestAccess.php.

References checkAccessForActiveId(), and getRefId().

                                                                               : bool
    {
        $access_filter = $this->participant_access_filter->getAccessResultsUserFilter($this->getRefId());
        return $this->checkAccessForActiveId($access_filter, $active_id, $test_id);
    }

Here is the call graph for this function:

checkScoreParticipantsAccess()

ilTestAccess::checkScoreParticipantsAccess

(

)

Returns

bool

Definition at line 85 of file class.ilTestAccess.php.

References getAccess(), getRefId(), and ilOrgUnitOperation\OP_SCORE_PARTICIPANTS.

                                                  : bool
    {
        if (!$this->getAccess()->checkAccess('read', '', $this->getRefId())) {
            return false;
        }
        return
            $this->getAccess()->checkAccess('write', '', $this->getRefId())
            || $this->getAccess()->checkPositionAccess(ilOrgUnitOperation::OP_SCORE_PARTICIPANTS, $this->getRefId())
        ;
    }

Here is the call graph for this function:

checkScoreParticipantsAccessAnon()

ilTestAccess::checkScoreParticipantsAccessAnon

(

)

Definition at line 96 of file class.ilTestAccess.php.

References getAccess(), and getRefId().

                                                      : bool
    {
        return $this->getAccess()->checkAccess('score_anon', '', $this->getRefId());
    }

Here is the call graph for this function:

checkScoreParticipantsAccessForActiveId()

ilTestAccess::checkScoreParticipantsAccessForActiveId	(	int	$active_id,
		int	$test_id
	)

Definition at line 179 of file class.ilTestAccess.php.

References checkAccessForActiveId(), and getRefId().

                                                                                         : bool
    {
        $access_filter = $this->participant_access_filter->getScoreParticipantsUserFilter($this->getRefId());
        return $this->checkAccessForActiveId($access_filter, $active_id, $test_id);
    }

Here is the call graph for this function:

getAccess()

ilTestAccess::getAccess

(

)

Definition at line 59 of file class.ilTestAccess.php.

References $access.

Referenced by checkCorrectionsAccess(), checkManageParticipantsAccess(), checkOtherParticipantsLearningProgressAccess(), checkParticipantsResultsAccess(), checkScoreParticipantsAccess(), and checkScoreParticipantsAccessAnon().

                               : ilAccessHandler
    {
        return $this->access;
    }

Here is the caller graph for this function:

getRefId()

ilTestAccess::getRefId

(

)

Definition at line 69 of file class.ilTestAccess.php.

References $ref_id.

Referenced by checkCorrectionsAccess(), checkManageParticipantsAccess(), checkOtherParticipantsLearningProgressAccess(), checkParticipantsResultsAccess(), checkResultsAccessForActiveId(), checkScoreParticipantsAccess(), checkScoreParticipantsAccessAnon(), checkScoreParticipantsAccessForActiveId(), and isParticipantAllowed().

                              : int
    {
        return $this->ref_id;
    }

Here is the caller graph for this function:

isIpAllowedToAccessTest()

ilTestAccess::isIpAllowedToAccessTest ( string  $ip, SettingsAccess  $access_settings  )

private

Definition at line 248 of file class.ilTestAccess.php.

References ILIAS\Test\Settings\MainSettings\SettingsAccess\getIpRangeFrom(), ILIAS\Test\Settings\MainSettings\SettingsAccess\getIpRangeTo(), ILIAS\Test\Settings\MainSettings\SettingsAccess\isIpRangeEnabled(), isIpTypeOf(), isIpv4Between(), and isIpv6Between().

Referenced by isParticipantAllowed().

     : bool {
        if (!$access_settings->isIpRangeEnabled()) {
            return true;
        }

        $range_start = $access_settings->getIpRangeFrom();
        $range_end = $access_settings->getIpRangeTo();

        if ($this->isIpTypeOf(FILTER_FLAG_IPV4, $ip, $range_start, $range_end)) {
            return $this->isIpv4Between($ip, $range_start, $range_end);
        }

        if ($this->isIpTypeOf(FILTER_FLAG_IPV6, $ip, $range_start, $range_end)) {
            return $this->isIpv6Between($ip, $range_start, $range_end);
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isIpTypeOf()

ilTestAccess::isIpTypeOf ( int  $ip_type_flag, string  $ip, string  $range_start, string  $range_end  )

private

Definition at line 270 of file class.ilTestAccess.php.

Referenced by isIpAllowedToAccessTest(), and isParticipantExplicitelyAllowedByIndividualIPRange().

                                                                                                      : bool
    {
        return filter_var($ip, FILTER_VALIDATE_IP, $ip_type_flag) !== false
            && filter_var($range_start, FILTER_VALIDATE_IP, $ip_type_flag) !== false
            && filter_var($range_end, FILTER_VALIDATE_IP, $ip_type_flag) !== false;
    }

Here is the caller graph for this function:

isIpv4Between()

ilTestAccess::isIpv4Between ( string  $ip, string  $range_start, string  $range_end  )

private

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

Referenced by isIpAllowedToAccessTest(), and isParticipantExplicitelyAllowedByIndividualIPRange().

                                                                                      : bool
    {
        return ip2long($range_start) <= ip2long($ip)
            && ip2long($ip) <= ip2long($range_end);
    }

Here is the caller graph for this function:

isIpv6Between()

ilTestAccess::isIpv6Between ( string  $ip, string  $range_start, string  $range_end  )

private

Definition at line 283 of file class.ilTestAccess.php.

Referenced by isIpAllowedToAccessTest(), and isParticipantExplicitelyAllowedByIndividualIPRange().

                                                                                      : bool
    {
        return bin2hex(inet_pton($range_start)) <= bin2hex(inet_pton($ip))
            && bin2hex(inet_pton($ip)) <= bin2hex(inet_pton($range_end));
    }

Here is the caller graph for this function:

isParticipantAllowed()

ilTestAccess::isParticipantAllowed	(	int	$obj_id,
		int	$user_id
	)

Definition at line 185 of file class.ilTestAccess.php.

References $_SERVER, Vendor\Package\$e, ilObjTest\_getTestIDFromObjectID(), ilObject\_lookupObjId(), getRefId(), isIpAllowedToAccessTest(), isParticipantExplicitelyAllowedByIndividualIPRange(), and null.

                                                                   : ParticipantAccess
    {
        try {
            $access_settings = $this->main_settings_repository->getForObjFi($obj_id)
                ->getAccessSettings();
        } catch (\Exception $e) {
            return ParticipantAccess::BROKEN_TEST;
        }

        $participant = $this->participant_repository->getParticipantByUserId(
            ilObjTest::_getTestIDFromObjectID(
                ilObjTest::_lookupObjId($this->getRefId())
            ),
            $user_id
        );

        if ($access_settings->getFixedParticipants()
            && ($participant === null || !$participant->isInvitedParticipant())) {
            return ParticipantAccess::NOT_INVITED;
        }

        $ip = $_SERVER['REMOTE_ADDR'];

        $allowed_individual = $this->isParticipantExplicitelyAllowedByIndividualIPRange($participant, $ip);
        if ($allowed_individual === false) {
            return ParticipantAccess::INDIVIDUAL_CLIENT_IP_MISMATCH;
        }


        if ($allowed_individual === true
            || !$access_settings->isIpRangeEnabled()) {
            return ParticipantAccess::ALLOWED;
        }

        if (!$this->isIpAllowedToAccessTest($ip, $access_settings)) {
            return ParticipantAccess::TEST_LEVEL_CLIENT_IP_MISMATCH;
        }

        return ParticipantAccess::ALLOWED;
    }

Here is the call graph for this function:

isParticipantExplicitelyAllowedByIndividualIPRange()

ilTestAccess::isParticipantExplicitelyAllowedByIndividualIPRange ( ?Participant  $participant, string  $ip  )

private

Definition at line 226 of file class.ilTestAccess.php.

References ILIAS\Test\Participants\Participant\getClientIpFrom(), ILIAS\Test\Participants\Participant\getClientIpTo(), isIpTypeOf(), isIpv4Between(), isIpv6Between(), and null.

Referenced by isParticipantAllowed().

     : ?bool {
        $range_start = $participant?->getClientIpFrom();
        $range_end = $participant?->getClientIpTo();

        if ($range_start === null && $range_end === null) {
            return null;
        }

        if ($this->isIpTypeOf(FILTER_FLAG_IPV4, $ip, $range_start, $range_end)) {
            return $this->isIpv4Between($ip, $range_start, $range_end);
        }

        if ($this->isIpTypeOf(FILTER_FLAG_IPV6, $ip, $range_start, $range_end)) {
            return $this->isIpv6Between($ip, $range_start, $range_end);
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAccess()

ilTestAccess::setAccess

(

ilAccessHandler

$access

)

Definition at line 64 of file class.ilTestAccess.php.

References $access, and ILIAS\Repository\access().

    {
        $this->access = $access;
    }

Here is the call graph for this function:

Field Documentation

$access

ilAccessHandler ilTestAccess::$access

protected

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

Referenced by getAccess(), and setAccess().

$db

ilDBInterface ilTestAccess::$db

protected

Definition at line 39 of file class.ilTestAccess.php.

$lng

ilLanguage ilTestAccess::$lng

protected

Definition at line 40 of file class.ilTestAccess.php.

$main_settings_repository

MainSettingsDatabaseRepository ilTestAccess::$main_settings_repository

protected

Definition at line 41 of file class.ilTestAccess.php.

$participant_access_filter

ilTestParticipantAccessFilterFactory ilTestAccess::$participant_access_filter

protected

Definition at line 43 of file class.ilTestAccess.php.

$participant_repository

ParticipantRepository ilTestAccess::$participant_repository

protected

Definition at line 44 of file class.ilTestAccess.php.

---

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

• components/ILIAS/Test/classes/class.ilTestAccess.php