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 ()

Protected Attributes
	$rbacsystem
	$user
	$testOBJ
	$lng

Detailed Description

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

Constructor & Destructor Documentation

__construct()

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

Definition at line 49 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 100 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 95 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:

isPasswordProtectionPageRedirectRequired()

ilTestPasswordChecker::isPasswordProtectionPageRedirectRequired

(

)

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

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

                                                              : bool
    {
        return  (
            $this->isTestPasswordEnabled()
            && !$this->isPrivilegedParticipant()
            && !$this->isUserEnteredPasswordCorrect()
        );
    }

Here is the call graph for this function:

isPrivilegedParticipant()

ilTestPasswordChecker::isPrivilegedParticipant ( )

protected

Definition at line 71 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 66 of file class.ilTestPasswordChecker.php.

References null.

Referenced by isPasswordProtectionPageRedirectRequired().

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

Here is the caller graph for this function:

isUserEnteredPasswordCorrect()

ilTestPasswordChecker::isUserEnteredPasswordCorrect

(

)

Definition at line 85 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 105 of file class.ilTestPasswordChecker.php.

    {
    }

setUserEnteredPassword()

ilTestPasswordChecker::setUserEnteredPassword

(

$enteredPassword

)

Definition at line 90 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 76 of file class.ilTestPasswordChecker.php.

References getUserEnteredPassword(), and isUserEnteredPasswordCorrect().

                                                   : bool
    {
        if ($this->getUserEnteredPassword() && $this->getUserEnteredPassword() === '') {
            return false;
        }

        return !$this->isUserEnteredPasswordCorrect();
    }

Here is the call graph for this function:

Field Documentation

$lng

ilTestPasswordChecker::$lng

protected

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

Referenced by __construct().

$rbacsystem

ilTestPasswordChecker::$rbacsystem

protected

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

Referenced by __construct().

$testOBJ

ilTestPasswordChecker::$testOBJ

protected

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

Referenced by __construct().

$user

ilTestPasswordChecker::$user

protected

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

Referenced by __construct().

---

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

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