ilTestPasswordChecker Class Reference

Collaboration diagram for ilTestPasswordChecker:

Public Member Functions
	__construct (ilRbacSystem $rbacsystem, ilObjUser $user, ilObjTest $testOBJ, ilLanguage $lng)
	isPasswordProtectionPageRedirectRequired ()
	wrongUserEnteredPasswordExist ()
	isUserEnteredPasswordCorrect ()
	setUserEnteredPassword ($enteredPassword)
	logWrongEnteredPassword ()

Protected Member Functions
	isTestPasswordEnabled ()
	isPrivilegedParticipant ()
	getUserEnteredPassword ()
	buildSessionKey ()
	getWrongEnteredPasswordLogMsg ()

Protected Attributes
	$rbacsystem
	$user
	$testOBJ
	$lng

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilTestPasswordChecker::__construct	(	ilRbacSystem	$rbacsystem,
		ilObjUser	$user,
		ilObjTest	$testOBJ,
		ilLanguage	$lng
	)

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

References $lng, $rbacsystem, $testOBJ, $user, ILIAS\Repository\lng(), and ILIAS\Repository\user().

    {
        $this->rbacsystem = $rbacsystem;
        $this->user = $user;
        $this->testOBJ = $testOBJ;
        $this->lng = $lng;
    }

Here is the call graph for this function:

Member Function Documentation

buildSessionKey()

ilTestPasswordChecker::buildSessionKey ( )

protected

Definition at line 106 of file class.ilTestPasswordChecker.php.

Referenced by getUserEnteredPassword(), and setUserEnteredPassword().

                                        : string
    {
        return 'tst_password_' . $this->testOBJ->getTestId();
    }

Here is the caller graph for this function:

getUserEnteredPassword()

ilTestPasswordChecker::getUserEnteredPassword ( )

protected

Definition at line 101 of file class.ilTestPasswordChecker.php.

References buildSessionKey(), and ilSession\get().

Referenced by isUserEnteredPasswordCorrect(), and wrongUserEnteredPasswordExist().

    {
        return ilSession::get($this->buildSessionKey());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getWrongEnteredPasswordLogMsg()

ilTestPasswordChecker::getWrongEnteredPasswordLogMsg ( )

protected

Definition at line 128 of file class.ilTestPasswordChecker.php.

References ilObjAssessmentFolder\_getLogLanguage(), and ILIAS\Repository\lng().

Referenced by logWrongEnteredPassword().

                                                      : string
    {
        return $this->lng->txtlng(
            'assessment',
            'log_wrong_test_password_entered',
            ilObjAssessmentFolder::_getLogLanguage()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isPasswordProtectionPageRedirectRequired()

ilTestPasswordChecker::isPasswordProtectionPageRedirectRequired

(

)

Definition at line 55 of file class.ilTestPasswordChecker.php.

References isPrivilegedParticipant(), isTestPasswordEnabled(), and isUserEnteredPasswordCorrect().

                                                              : bool
    {
        if (!$this->isTestPasswordEnabled()) {
            return false;
        }

        if ($this->isPrivilegedParticipant()) {
            return false;
        }

        if ($this->isUserEnteredPasswordCorrect()) {
            return false;
        }

        return true;
    }

Here is the call graph for this function:

isPrivilegedParticipant()

ilTestPasswordChecker::isPrivilegedParticipant ( )

protected

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

Referenced by isPasswordProtectionPageRedirectRequired().

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

Here is the caller graph for this function:

isTestPasswordEnabled()

ilTestPasswordChecker::isTestPasswordEnabled ( )

protected

Definition at line 72 of file class.ilTestPasswordChecker.php.

Referenced by isPasswordProtectionPageRedirectRequired().

                                              : int
    {
        return strlen($this->testOBJ->getPassword());
    }

Here is the caller graph for this function:

isUserEnteredPasswordCorrect()

ilTestPasswordChecker::isUserEnteredPasswordCorrect

(

)

Definition at line 91 of file class.ilTestPasswordChecker.php.

References getUserEnteredPassword().

Referenced by isPasswordProtectionPageRedirectRequired(), and wrongUserEnteredPasswordExist().

                                                  : bool
    {
        return $this->getUserEnteredPassword() == $this->testOBJ->getPassword();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

logWrongEnteredPassword()

ilTestPasswordChecker::logWrongEnteredPassword

(

)

Definition at line 111 of file class.ilTestPasswordChecker.php.

References ilObjAssessmentFolder\_addLog(), ilObjAssessmentFolder\_enabledAssessmentLogging(), getWrongEnteredPasswordLogMsg(), and ILIAS\Repository\user().

    {
        if (!ilObjAssessmentFolder::_enabledAssessmentLogging()) {
            return;
        }

        ilObjAssessmentFolder::_addLog(
            $this->user->getId(),
            $this->testOBJ->getId(),
            $this->getWrongEnteredPasswordLogMsg(),
            null,
            null,
            true,
            $this->testOBJ->getRefId()
        );
    }

Here is the call graph for this function:

setUserEnteredPassword()

ilTestPasswordChecker::setUserEnteredPassword

(

$enteredPassword

)

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

References buildSessionKey(), and ilSession\set().

    {
        ilSession::set($this->buildSessionKey(), $enteredPassword);
    }

Here is the call graph for this function:

wrongUserEnteredPasswordExist()

ilTestPasswordChecker::wrongUserEnteredPasswordExist

(

)

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

References getUserEnteredPassword(), and isUserEnteredPasswordCorrect().

                                                   : bool
    {
        if (!strlen($this->getUserEnteredPassword())) {
            return false;
        }

        return !$this->isUserEnteredPasswordCorrect();
    }

Here is the call graph for this function:

Field Documentation

$lng

ilTestPasswordChecker::$lng

protected

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

Referenced by __construct().

$rbacsystem

ilTestPasswordChecker::$rbacsystem

protected

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

Referenced by __construct().

$testOBJ

ilTestPasswordChecker::$testOBJ

protected

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

Referenced by __construct().

$user

ilTestPasswordChecker::$user

protected

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

Referenced by __construct().

---

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

• Modules/Test/classes/class.ilTestPasswordChecker.php