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 37 of file class.ilTestAccess.php.

Member Function Documentation

◆ checkAccessForActiveId()

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

protected

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

                                                                                                   : 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());
    }

References ILIAS\Repository\lng().

Referenced by checkResultsAccessForActiveId(), and checkScoreParticipantsAccessForActiveId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkCorrectionsAccess()

ilTestAccess::checkCorrectionsAccess ( )

Returns: bool

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

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

References getAccess(), and getRefId().

Here is the call graph for this function:

◆ checkManageParticipantsAccess()

ilTestAccess::checkManageParticipantsAccess ( )

Returns: bool

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

                                                   : 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;
    }

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

Here is the call graph for this function:

◆ checkOtherParticipantsLearningProgressAccess()

ilTestAccess::checkOtherParticipantsLearningProgressAccess ( )

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

                                                                  : 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;
    }

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

Here is the call graph for this function:

◆ checkParticipantsResultsAccess()

ilTestAccess::checkParticipantsResultsAccess ( )

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

                                                    : 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;
    }

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

Here is the call graph for this function:

◆ checkResultsAccessForActiveId()

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

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

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

References checkAccessForActiveId(), and getRefId().

Here is the call graph for this function:

◆ checkScoreParticipantsAccess()

ilTestAccess::checkScoreParticipantsAccess ( )

Returns: bool

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

                                                  : 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())
        ;
    }

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

Here is the call graph for this function:

◆ checkScoreParticipantsAccessAnon()

ilTestAccess::checkScoreParticipantsAccessAnon ( )

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

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

References getAccess(), and getRefId().

Here is the call graph for this function:

◆ checkScoreParticipantsAccessForActiveId()

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

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

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

References checkAccessForActiveId(), and getRefId().

Here is the call graph for this function:

◆ getAccess()

ilTestAccess::getAccess ( )

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

                               : ilAccessHandler
    {
        return $this->access;
    }

References $access.

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

Here is the caller graph for this function:

◆ getRefId()

ilTestAccess::getRefId ( )

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

                              : int
    {
        return $this->ref_id;
    }

References $ref_id.

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

Here is the caller graph for this function:

◆ isIpAllowedToAccessTest()

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

private

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

     : 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;
    }

Referenced by isParticipantAllowed().

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 273 of file class.ilTestAccess.php.

                                                                                                      : 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;
    }

◆ isIpv4Between()

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

private

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

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

◆ isIpv6Between()

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

private

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

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

◆ isParticipantAllowed()

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

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

                                                                   : ParticipantAccess
    {
        try {
            $access_settings = $this->main_settings_repository->getForObjFi($obj_id)
                ->getAccessSettings();
        } catch (SettingsNotFoundException $e) {
            return ParticipantAccess::MISSING_SETTINGS;
        } 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;
    }

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

Here is the call graph for this function:

◆ isParticipantExplicitelyAllowedByIndividualIPRange()

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

private

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

     : ?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;
    }

Referenced by isParticipantAllowed().

Here is the caller graph for this function:

◆ setAccess()

ilTestAccess::setAccess ( ilAccessHandler $access )

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

    {
        $this->access = $access;
    }

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

Here is the call graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilTestAccess::$access

protected

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

Referenced by getAccess(), and setAccess().

◆ $db

ilDBInterface ilTestAccess::$db

protected

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

◆ $lng

ilLanguage ilTestAccess::$lng

protected

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

◆ $main_settings_repository

MainSettingsDatabaseRepository ilTestAccess::$main_settings_repository

protected

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

◆ $participant_access_filter

ilTestParticipantAccessFilterFactory ilTestAccess::$participant_access_filter

protected

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

◆ $participant_repository

ParticipantRepository ilTestAccess::$participant_repository

protected

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

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ checkAccessForActiveId()

◆ checkCorrectionsAccess()

◆ checkManageParticipantsAccess()

◆ checkOtherParticipantsLearningProgressAccess()

◆ checkParticipantsResultsAccess()

◆ checkResultsAccessForActiveId()

◆ checkScoreParticipantsAccess()

◆ checkScoreParticipantsAccessAnon()

◆ checkScoreParticipantsAccessForActiveId()

◆ getAccess()

◆ getRefId()

◆ isIpAllowedToAccessTest()

◆ isIpTypeOf()

◆ isIpv4Between()

◆ isIpv6Between()

◆ isParticipantAllowed()

◆ isParticipantExplicitelyAllowedByIndividualIPRange()

◆ setAccess()

Field Documentation

◆ $access

◆ $db

◆ $lng

◆ $main_settings_repository

◆ $participant_access_filter

◆ $participant_repository