ilAuthFrontendCredentials Class Reference

Description of class class. More...

Inheritance diagram for ilAuthFrontendCredentials:

Collaboration diagram for ilAuthFrontendCredentials:

Public Member Functions
	__construct ()
	getLogger ()
	Get logger. More...
	setLogger (ilLogger $logger)
	Set Logger. More...
	setUsername ($a_name)
	Set username. More...
	getUsername ()
	Get username. More...
	setPassword ($a_password)
	Set password. More...
	getPassword ()
	Get password. More...
	setCaptchaCode ($a_code)
	Set captcha code. More...
	getCaptchaCode ()
	Get captcha code. More...
	setAuthMode ($a_auth_mode)
	Set auth mode. More...
	getAuthMode ()
	Get auth mode. More...

Private Attributes
	$logger = null
	$username = ''
	$password = ''
	$captcha = ''
	$auth_mode = ''

Detailed Description

Description of class class.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 13 of file class.ilAuthFrontendCredentials.php.

Constructor & Destructor Documentation

__construct()

ilAuthFrontendCredentials::__construct

(

)

Definition at line 22 of file class.ilAuthFrontendCredentials.php.

References ilLoggerFactory\getLogger().

    {
        $this->logger = ilLoggerFactory::getLogger('auth');
    }

Here is the call graph for this function:

Member Function Documentation

getAuthMode()

ilAuthFrontendCredentials::getAuthMode

(

)

Get auth mode.

Implements ilAuthCredentials.

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

References $auth_mode.

    {
        return $this->auth_mode;
    }

getCaptchaCode()

ilAuthFrontendCredentials::getCaptchaCode

(

)

Get captcha code.

Implements ilAuthCredentials.

Definition at line 93 of file class.ilAuthFrontendCredentials.php.

References $captcha.

    {
        return $this->captcha;
    }

getLogger()

ilAuthFrontendCredentials::getLogger

(

)

Get logger.

Returns

Definition at line 31 of file class.ilAuthFrontendCredentials.php.

References $logger.

Referenced by ilAuthFrontendCredentialsLTI\initFromRequest(), ilAuthFrontendCredentialsApache\initFromRequest(), and setUsername().

    {
        return $this->logger;
    }

Here is the caller graph for this function:

getPassword()

ilAuthFrontendCredentials::getPassword

(

)

Get password.

Implements ilAuthCredentials.

Definition at line 75 of file class.ilAuthFrontendCredentials.php.

References $password.

    {
        return $this->password;
    }

getUsername()

ilAuthFrontendCredentials::getUsername

(

)

Get username.

Implements ilAuthCredentials.

Definition at line 58 of file class.ilAuthFrontendCredentials.php.

References $username.

    {
        return $this->username;
    }

setAuthMode()

ilAuthFrontendCredentials::setAuthMode

(

$a_auth_mode

)

Set auth mode.

Parameters

type

$a_auth_mode

Implements ilAuthCredentials.

Definition at line 103 of file class.ilAuthFrontendCredentials.php.

    {
        $this->auth_mode = $a_auth_mode;
    }

setCaptchaCode()

ilAuthFrontendCredentials::setCaptchaCode

(

$a_code

)

Set captcha code.

Parameters

string

Implements ilAuthCredentials.

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

    {
        $this->captcha = $a_code;
    }

setLogger()

ilAuthFrontendCredentials::setLogger

(

ilLogger

$logger

)

Set Logger.

Parameters

ilLogger

$logger

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

References $logger.

Referenced by ilAuthFrontendCredentialsLTI\__construct().

    {
        $this->logger = $logger;
    }

Here is the caller graph for this function:

setPassword()

ilAuthFrontendCredentials::setPassword

(

$a_password

)

Set password.

Parameters

string

$a_password

Implements ilAuthCredentials.

Definition at line 67 of file class.ilAuthFrontendCredentials.php.

Referenced by ilAuthFrontendCredentialsHTTP\initFromRequest(), and ilAuthFrontendCredentialsShibboleth\initFromRequest().

    {
        $this->password = $a_password;
    }

Here is the caller graph for this function:

setUsername()

ilAuthFrontendCredentials::setUsername

(

$a_name

)

Set username.

Parameters

string

username

Implements ilAuthCredentials.

Definition at line 49 of file class.ilAuthFrontendCredentials.php.

References getLogger().

Referenced by ilAuthFrontendCredentialsLTI\initFromRequest(), ilAuthFrontendCredentialsHTTP\initFromRequest(), ilAuthFrontendCredentialsShibboleth\initFromRequest(), and ilAuthFrontendCredentialsApache\initFromRequest().

    {
        $this->getLogger()->debug('Username: "' . $a_name . '"');
        $this->username = trim($a_name);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$auth_mode

ilAuthFrontendCredentials::$auth_mode = ''

private

Definition at line 20 of file class.ilAuthFrontendCredentials.php.

Referenced by getAuthMode().

$captcha

ilAuthFrontendCredentials::$captcha = ''

private

Definition at line 19 of file class.ilAuthFrontendCredentials.php.

Referenced by getCaptchaCode().

$logger

ilAuthFrontendCredentials::$logger = null

private

Definition at line 15 of file class.ilAuthFrontendCredentials.php.

Referenced by getLogger(), and setLogger().

$password

ilAuthFrontendCredentials::$password = ''

private

Definition at line 18 of file class.ilAuthFrontendCredentials.php.

Referenced by getPassword().

$username

ilAuthFrontendCredentials::$username = ''

private

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

Referenced by getUsername().

---

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

• Services/Authentication/classes/Frontend/class.ilAuthFrontendCredentials.php