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 ()
	initSession ()
	buildSessionKey ()
	getWrongEnteredPasswordLogMsg ()

Protected Attributes
	$rbacsystem
	$user
	$testOBJ
	$lng

Detailed Description

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

Constructor & Destructor Documentation

__construct()

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

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

References $lng, $rbacsystem, $testOBJ, $user, initSession(), and user().

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

Here is the call graph for this function:

Member Function Documentation

buildSessionKey()

ilTestPasswordChecker::buildSessionKey ( )

protected

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

Referenced by getUserEnteredPassword(), initSession(), and setUserEnteredPassword().

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

Here is the caller graph for this function:

getUserEnteredPassword()

ilTestPasswordChecker::getUserEnteredPassword ( )

protected

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

References $_SESSION, and buildSessionKey().

Referenced by getWrongEnteredPasswordLogMsg(), isUserEnteredPasswordCorrect(), and wrongUserEnteredPasswordExist().

        {
                return $_SESSION[$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 124 of file class.ilTestPasswordChecker.php.

References ilObjAssessmentFolder\_getLogLanguage(), and getUserEnteredPassword().

Referenced by logWrongEnteredPassword().

        {
                $msg = $this->lng->txtlng(
                        'assessment', 'log_wrong_test_password_entered', ilObjAssessmentFolder::_getLogLanguage()
                );
                
                return sprintf($msg, $this->getUserEnteredPassword());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

initSession()

ilTestPasswordChecker::initSession ( )

protected

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

References $_SESSION, and buildSessionKey().

Referenced by __construct().

        {
                if( !isset($_SESSION[$this->buildSessionKey()]) )
                {
                        $_SESSION[$this->buildSessionKey()] = null;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

isPasswordProtectionPageRedirectRequired()

ilTestPasswordChecker::isPasswordProtectionPageRedirectRequired

(

)

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

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

        {
                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 69 of file class.ilTestPasswordChecker.php.

Referenced by isPasswordProtectionPageRedirectRequired().

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

Here is the caller graph for this function:

isTestPasswordEnabled()

ilTestPasswordChecker::isTestPasswordEnabled ( )

protected

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

Referenced by isPasswordProtectionPageRedirectRequired().

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

Here is the caller graph for this function:

isUserEnteredPasswordCorrect()

ilTestPasswordChecker::isUserEnteredPasswordCorrect

(

)

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

References getUserEnteredPassword().

Referenced by isPasswordProtectionPageRedirectRequired(), and wrongUserEnteredPasswordExist().

        {
                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 112 of file class.ilTestPasswordChecker.php.

References ilObjAssessmentFolder\_addLog(), ilObjAssessmentFolder\_enabledAssessmentLogging(), getWrongEnteredPasswordLogMsg(), and 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 89 of file class.ilTestPasswordChecker.php.

References $_SESSION, and buildSessionKey().

        {
                $_SESSION[$this->buildSessionKey()] = $enteredPassword;
        }

Here is the call graph for this function:

wrongUserEnteredPasswordExist()

ilTestPasswordChecker::wrongUserEnteredPasswordExist

(

)

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

References getUserEnteredPassword(), and isUserEnteredPasswordCorrect().

        {
                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 32 of file class.ilTestPasswordChecker.php.

Referenced by __construct().

$rbacsystem

ilTestPasswordChecker::$rbacsystem

protected

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

Referenced by __construct().

$testOBJ

ilTestPasswordChecker::$testOBJ

protected

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

Referenced by __construct().

$user

ilTestPasswordChecker::$user

protected

Definition at line 22 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