ilAuthFrontendFactory Class Reference

Collaboration diagram for ilAuthFrontendFactory:

Public Member Functions
	__construct ()
	setContext (int $a_context)
	getContext ()
	getFrontend (ilAuthSession $session, ilAuthStatus $status, ilAuthCredentials $credentials, array $providers)

Data Fields
const int	CONTEXT_STANDARD_FORM = 2
	Authentication with id and password. More...
const int	CONTEXT_CLI = 3
const int	CONTEXT_WS = 4
const int	CONTEXT_HTTP = 5

Private Attributes
const int	CONTEXT_UNDEFINED = 0
int	$context = self::CONTEXT_UNDEFINED
ilLogger	$logger

Detailed Description

Definition at line 21 of file class.ilAuthFrontendFactory.php.

Constructor & Destructor Documentation

__construct()

ilAuthFrontendFactory::__construct

(

)

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

    {
        global $DIC;
        $this->logger = $DIC->logger()->auth();
    }

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

Here is the call graph for this function:

Member Function Documentation

getContext()

ilAuthFrontendFactory::getContext

(

)

Definition at line 48 of file class.ilAuthFrontendFactory.php.

                                : int
    {
        return $this->context;
    }

References $context.

getFrontend()

ilAuthFrontendFactory::getFrontend	(	ilAuthSession	$session,
		ilAuthStatus	$status,
		ilAuthCredentials	$credentials,
		array	$providers
	)

Parameters

list<ilAuthProviderInterface>

$providers

Definition at line 56 of file class.ilAuthFrontendFactory.php.

     : ?ilAuthFrontendInterface {
        switch ($this->getContext()) {
            case self::CONTEXT_CLI:
                $this->logger->debug('Init auth frontend with standard auth context');
                $frontend = new ilAuthFrontendCLI(
                    $session,
                    $status,
                    $credentials,
                    $providers
                );
                return $frontend;
 
            case self::CONTEXT_WS:
                $this->logger->debug('Init auth frontend with webservice auth context');
                $frontend = new ilAuthFrontendWS(
                    $session,
                    $status,
                    $credentials,
                    $providers
                );
                return $frontend;
 
            case self::CONTEXT_STANDARD_FORM:
                $this->logger->debug('Init auth frontend with standard auth context');
                $frontend = new ilAuthStandardFormFrontend(
                    $session,
                    $status,
                    $credentials,
                    $providers
                );
                return $frontend;
 
            case self::CONTEXT_HTTP:
                $this->logger->debug('Init auth frontend with http basic auth context');
                $frontend = new ilAuthFrontendHTTP(
                    $session,
                    $status,
                    $credentials,
                    $providers
                );
                return $frontend;
 
            case self::CONTEXT_UNDEFINED:
                $this->logger->error('Trying to init auth with empty context');
                break;
        }
 
        return null;
    }

References CONTEXT_CLI, CONTEXT_HTTP, CONTEXT_STANDARD_FORM, CONTEXT_UNDEFINED, CONTEXT_WS, and ILIAS\Repository\logger().

Here is the call graph for this function:

setContext()

ilAuthFrontendFactory::setContext

(

int

$a_context

)

Definition at line 43 of file class.ilAuthFrontendFactory.php.

                                              : void
    {
        $this->context = $a_context;
    }

Field Documentation

$context

int ilAuthFrontendFactory::$context = self::CONTEXT_UNDEFINED

private

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

Referenced by getContext().

$logger

ilLogger ilAuthFrontendFactory::$logger

private

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

CONTEXT_CLI

const int ilAuthFrontendFactory::CONTEXT_CLI = 3

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

Referenced by ILIAS\Cron\CLI\StartUp\authenticate(), and getFrontend().

CONTEXT_HTTP

const int ilAuthFrontendFactory::CONTEXT_HTTP = 5

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

Referenced by ilWebDAVAuthentication\authenticate(), and getFrontend().

CONTEXT_STANDARD_FORM

const int ilAuthFrontendFactory::CONTEXT_STANDARD_FORM = 2

Authentication with id and password.

Used for standard form based authentication, SOAP auth (login), but not for (CLI (cron)) and HTTP basic authentication

Definition at line 28 of file class.ilAuthFrontendFactory.php.

Referenced by ilStartUpGUI\doApacheAuthentication(), ilStartUpGUI\doLTIAuthentication(), ilStartUpGUI\doMigration(), ilStartUpGUI\doMigrationNewAccount(), ilStartUpGUI\doOpenIdConnectAuthentication(), ilStartUpGUI\doSamlAuthentication(), ILIAS\AuthShibboleth\LoginPerformer\doShibbolethAuthentication(), ilStartUpGUI\doStandardAuthentication(), getFrontend(), ilAuthUtils\handleForcedAuthentication(), and ilAuthFrontendCredentialsSoap\tryAuthenticationOnLoginPage().

CONTEXT_UNDEFINED

const int ilAuthFrontendFactory::CONTEXT_UNDEFINED = 0

private

Definition at line 23 of file class.ilAuthFrontendFactory.php.

Referenced by getFrontend().

CONTEXT_WS

const int ilAuthFrontendFactory::CONTEXT_WS = 4

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

Referenced by getFrontend(), and ilSoapUserAdministration\login().

---

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

• components/ILIAS/Authentication/classes/Frontend/class.ilAuthFrontendFactory.php