ilAuthStatus Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilAuthStatus:

Public Member Functions
	setStatus (int $a_status)
	Set auth status. More...
	getStatus ()
	Get status. More...
	setReason (string $a_reason)
	Set reason. More...
	setTranslatedReason (string $a_reason)
	Set translated reason. More...
	getReason ()
	Get reason for authentication success, fail, migration... More...
	getTranslatedReason ()
	Get translated reason. More...
	setAuthenticatedUserId (int $a_id)
	getAuthenticatedUserId ()
	Get authenticated user id. More...

Static Public Member Functions
static	getInstance ()
	Get status instance. More...

Data Fields
const	STATUS_UNDEFINED = 1
const	STATUS_AUTHENTICATED = 2
const	STATUS_AUTHENTICATION_FAILED = 3
const	STATUS_ACCOUNT_MIGRATION_REQUIRED = 4
const	STATUS_CODE_ACTIVATION_REQUIRED = 5

Private Member Functions
	__construct ()
	Constructor. More...

Private Attributes
ilLanguage	$lng
int	$status = self::STATUS_UNDEFINED
string	$reason = ''
string	$translated_reason = ''
int	$auth_user_id = 0

Static Private Attributes
static ilAuthStatus	$instance = null

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Auth status implementation

Author

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

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

Constructor & Destructor Documentation

__construct()

ilAuthStatus::__construct ( )

private

Constructor.

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

References $DIC, and ILIAS\Repository\lng().

    {
        global $DIC;
        $this->lng = $DIC->language();
    }

Here is the call graph for this function:

Member Function Documentation

getAuthenticatedUserId()

ilAuthStatus::getAuthenticatedUserId

(

)

Get authenticated user id.

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

References $auth_user_id.

Referenced by ilAuthProviderSoap\doAuthentication().

                                            : int
    {
        return $this->auth_user_id;
    }

Here is the caller graph for this function:

getInstance()

static ilAuthStatus::getInstance ( )

static

Get status instance.

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

Referenced by ilCronStartUp\authenticate(), ilWebDAVAuthentication\authenticate(), ilStartUpGUI\doApacheAuthentication(), ilStartUpGUI\doCasAuthentication(), ilStartUpGUI\doLTIAuthentication(), ilStartUpGUI\doMigration(), ilStartUpGUI\doMigrationNewAccount(), ilStartUpGUI\doOpenIdConnectAuthentication(), ilStartUpGUI\doSamlAuthentication(), ilStartUpGUI\doShibbolethAuthentication(), ilStartUpGUI\doStandardAuthentication(), ilAuthUtils\handleForcedAuthentication(), ilSoapUserAdministration\login(), and ilAuthFrontendCredentialsSoap\tryAuthenticationOnLoginPage().

                                        : ilAuthStatus
    {
        if (self::$instance) {
            return self::$instance;
        }
        return self::$instance = new ilAuthStatus();
    }

Here is the caller graph for this function:

getReason()

ilAuthStatus::getReason

(

)

Get reason for authentication success, fail, migration...

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

References $reason.

Referenced by getTranslatedReason().

                               : string
    {
        return $this->reason;
    }

Here is the caller graph for this function:

getStatus()

ilAuthStatus::getStatus

(

)

Get status.

Returns

int $status

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

References $status.

                               : int
    {
        return $this->status;
    }

getTranslatedReason()

ilAuthStatus::getTranslatedReason

(

)

Get translated reason.

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

References $translated_reason, getReason(), and ILIAS\Repository\lng().

                                         : string
    {
        if ($this->translated_reason !== '') {
            return $this->translated_reason;
        }
        return $this->lng->txt($this->getReason());
    }

Here is the call graph for this function:

setAuthenticatedUserId()

ilAuthStatus::setAuthenticatedUserId

(

int

$a_id

)

Definition at line 120 of file class.ilAuthStatus.php.

Referenced by ilAuthProviderShibboleth\doAuthentication(), ilAuthProviderCAS\doAuthentication(), ilAuthProviderApache\doAuthentication(), ilAuthProviderLTI\findGlobalRole(), ilAuthProviderCAS\handleLDAPDataSource(), ilAuthProviderApache\handleLDAPDataSource(), ilAuthProviderECS\handleLoginByAuthMode(), ilAuthProviderSaml\handleSamlAuth(), ilAuthProviderSoap\handleSoapAuth(), ilAuthProviderLDAP\updateAccount(), and ilAuthProviderDatabase\withoutPasswordVerification().

                                                     : void
    {
        $this->auth_user_id = $a_id;
    }

Here is the caller graph for this function:

setReason()

ilAuthStatus::setReason

(

string

$a_reason

)

Set reason.

Parameters

string

$a_reason

A laguage key, which can be translated to an end user message

Definition at line 87 of file class.ilAuthStatus.php.

Referenced by ilAuthProviderShibboleth\doAuthentication(), ilAuthProviderLTI\findGlobalRole(), ilAuthProvider\handleAuthenticationFail(), ilAuthProviderSoap\handleSoapAuth(), and ilAuthProviderOpenIdConnect\handleUpdate().

                                               : void
    {
        $this->reason = $a_reason;
    }

Here is the caller graph for this function:

setStatus()

ilAuthStatus::setStatus

(

int

$a_status

)

Set auth status.

Definition at line 69 of file class.ilAuthStatus.php.

Referenced by ilAuthProviderShibboleth\doAuthentication(), ilAuthProviderCAS\doAuthentication(), ilAuthProviderApache\doAuthentication(), ilAuthProviderOpenIdConnect\doAuthentication(), ilAuthProviderSoap\doAuthentication(), ilAuthProviderLTI\findGlobalRole(), ilAuthProvider\handleAuthenticationFail(), ilAuthProviderCAS\handleLDAPDataSource(), ilAuthProviderApache\handleLDAPDataSource(), ilAuthProviderECS\handleLoginByAuthMode(), ilAuthProviderSaml\handleSamlAuth(), ilAuthProviderOpenIdConnect\handleUpdate(), ilAuthProviderLDAP\updateAccount(), and ilAuthProviderDatabase\withoutPasswordVerification().

                                            : void
    {
        $this->status = $a_status;
    }

Here is the caller graph for this function:

setTranslatedReason()

ilAuthStatus::setTranslatedReason

(

string

$a_reason

)

Set translated reason.

Definition at line 95 of file class.ilAuthStatus.php.

Referenced by ilAuthProviderOpenIdConnect\doAuthentication(), ilAuthProviderSoap\doAuthentication(), and ilAuthProviderSoap\handleSoapAuth().

                                                         : void
    {
        $this->translated_reason = $a_reason;
    }

Here is the caller graph for this function:

Field Documentation

$auth_user_id

int ilAuthStatus::$auth_user_id = 0

private

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

Referenced by getAuthenticatedUserId().

$instance

ilAuthStatus ilAuthStatus::$instance = null

staticprivate

Definition at line 29 of file class.ilAuthStatus.php.

$lng

ilLanguage ilAuthStatus::$lng

private

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

$reason

string ilAuthStatus::$reason = ''

private

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

Referenced by getReason().

$status

int ilAuthStatus::$status = self::STATUS_UNDEFINED

private

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

Referenced by getStatus().

$translated_reason

string ilAuthStatus::$translated_reason = ''

private

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

Referenced by getTranslatedReason().

STATUS_ACCOUNT_MIGRATION_REQUIRED

const ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED = 4

Definition at line 36 of file class.ilAuthStatus.php.

Referenced by ilAuthFrontendHTTP\authenticate(), ilWebDAVAuthentication\authenticate(), ilAuthFrontend\authenticate(), ilStartUpGUI\doApacheAuthentication(), ilStartUpGUI\doLTIAuthentication(), ilStartUpGUI\doSamlAuthentication(), ilStartUpGUI\doShibbolethAuthentication(), ilStartUpGUI\doStandardAuthentication(), ilAuthProviderApache\handleLDAPDataSource(), ilAuthProviderSaml\handleSamlAuth(), and ilAuthProviderLDAP\updateAccount().

STATUS_AUTHENTICATED

const ilAuthStatus::STATUS_AUTHENTICATED = 2

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

Referenced by ilAuthFrontendHTTP\authenticate(), ilCronStartUp\authenticate(), ilWebDAVAuthentication\authenticate(), ilAuthFrontend\authenticate(), ilStartUpGUI\doApacheAuthentication(), ilAuthProviderShibboleth\doAuthentication(), ilAuthProviderCAS\doAuthentication(), ilAuthProviderApache\doAuthentication(), ilAuthProviderSoap\doAuthentication(), ilStartUpGUI\doCasAuthentication(), ilStartUpGUI\doLTIAuthentication(), ilStartUpGUI\doMigration(), ilStartUpGUI\doOpenIdConnectAuthentication(), ilStartUpGUI\doSamlAuthentication(), ilStartUpGUI\doShibbolethAuthentication(), ilStartUpGUI\doStandardAuthentication(), ilAuthProviderLTI\findGlobalRole(), ilAuthUtils\handleForcedAuthentication(), ilAuthProviderCAS\handleLDAPDataSource(), ilAuthProviderApache\handleLDAPDataSource(), ilAuthProviderECS\handleLoginByAuthMode(), ilAuthProviderSaml\handleSamlAuth(), ilAuthProviderOpenIdConnect\handleUpdate(), ilSoapUserAdministration\login(), ilAuthFrontend\migrateAccount(), ilAuthFrontend\migrateAccountNew(), ilAuthFrontendCredentialsSoap\tryAuthenticationOnLoginPage(), ilAuthProviderLDAP\updateAccount(), and ilAuthProviderDatabase\withoutPasswordVerification().

STATUS_AUTHENTICATION_FAILED

const ilAuthStatus::STATUS_AUTHENTICATION_FAILED = 3

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

Referenced by ilAuthFrontendHTTP\authenticate(), ilCronStartUp\authenticate(), ilWebDAVAuthentication\authenticate(), ilAuthFrontend\authenticate(), ilStartUpGUI\doApacheAuthentication(), ilAuthProviderShibboleth\doAuthentication(), ilAuthProviderOpenIdConnect\doAuthentication(), ilAuthProviderSoap\doAuthentication(), ilStartUpGUI\doCasAuthentication(), ilStartUpGUI\doLTIAuthentication(), ilStartUpGUI\doOpenIdConnectAuthentication(), ilStartUpGUI\doSamlAuthentication(), ilStartUpGUI\doShibbolethAuthentication(), ilStartUpGUI\doStandardAuthentication(), ilAuthProviderLTI\findGlobalRole(), ilAuthProvider\handleAuthenticationFail(), ilAuthFrontend\handleAuthenticationSuccess(), ilAuthUtils\handleForcedAuthentication(), ilAuthProviderOpenIdConnect\handleUpdate(), ilSoapUserAdministration\login(), and ilAuthFrontendCredentialsSoap\tryAuthenticationOnLoginPage().

STATUS_CODE_ACTIVATION_REQUIRED

const ilAuthStatus::STATUS_CODE_ACTIVATION_REQUIRED = 5

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

Referenced by ilStartUpGUI\doStandardAuthentication(), and ilAuthFrontend\handleAuthenticationSuccess().

STATUS_UNDEFINED

const ilAuthStatus::STATUS_UNDEFINED = 1

Definition at line 33 of file class.ilAuthStatus.php.

Referenced by ilAuthFrontend\resetStatus().

---

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

• Services/Authentication/classes/class.ilAuthStatus.php