ilAuthFrontendFactory Class Reference

Factory for auth frontend classes. More...

Collaboration diagram for ilAuthFrontendFactory:

Public Member Functions
	__construct ()
	Constructor. More...
	getLogger ()
	setContext ($a_context)
	Set context for following authentication requests. More...
	getContext ()
	Get context. More...
	getFrontend (ilAuthSession $session, ilAuthStatus $status, ilAuthCredentials $credentials, array $providers)

Data Fields
const	CONTEXT_UNDEFINED = 0
const	CONTEXT_STANDARD_FORM = 2
const	CONTEXT_CLI = 3
const	CONTEXT_WS = 4
const	CONTEXT_HTTP = 5

Private Attributes
	$context = self::CONTEXT_UNDEFINED
	$credentials = null
	$logger = null

Detailed Description

Factory for auth frontend classes.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilAuthFrontendFactory::__construct

(

)

Constructor.

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

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

References ilLoggerFactory\getLogger().

Here is the call graph for this function:

Member Function Documentation

getContext()

ilAuthFrontendFactory::getContext

(

)

Get context.

Returns

int

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

    {
        return $this->context;
    }

References $context.

Referenced by getFrontend().

Here is the caller graph for this function:

getFrontend()

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

Returns

\ilAuthFrontendInterface

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

    {
        switch ($this->getContext()) {
            case self::CONTEXT_CLI:
                $this->getLogger()->debug('Init auth frontend with standard auth context');
                include_once './Services/Authentication/classes/Frontend/class.ilAuthFrontendCLI.php';
                $frontend = new ilAuthFrontendCLI(
                    $session,
                    $status,
                    $credentials,
                    $providers
                );
                return $frontend;
                
            case self::CONTEXT_WS:
                $this->getLogger()->debug('Init auth frontend with webservice auth context');
                include_once './Services/Authentication/classes/Frontend/class.ilAuthFrontendWS.php';
                $frontend = new ilAuthFrontendWS(
                    $session,
                    $status,
                    $credentials,
                    $providers
                );
                return $frontend;
                
            case self::CONTEXT_STANDARD_FORM:
                $this->getLogger()->debug('Init auth frontend with standard auth context');
                include_once './Services/Authentication/classes/Frontend/class.ilAuthStandardFormFrontend.php';
                $frontend = new ilAuthStandardFormFrontend(
                    $session,
                    $status,
                    $credentials,
                    $providers
                );
                return $frontend;
                
            case self::CONTEXT_HTTP:
                $this->getLogger()->debug('Init auth frontend with http basic auth context');
                include_once './Services/Authentication/classes/Frontend/class.ilAuthFrontendHTTP.php';
                $frontend = new ilAuthFrontendHTTP(
                    $session,
                    $status,
                    $credentials,
                    $providers
                );
                return $frontend;
            
            case self::CONTEXT_UNDEFINED:
                $this->getLogger()->error('Trying to init auth with empty context');
                break;
        }
    }

References $credentials, $session, CONTEXT_CLI, CONTEXT_HTTP, CONTEXT_STANDARD_FORM, CONTEXT_UNDEFINED, CONTEXT_WS, getContext(), and getLogger().

Here is the call graph for this function:

getLogger()

ilAuthFrontendFactory::getLogger

(

)

Returns

\ilLogger

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

    {
        return $this->logger;
    }

References $logger.

Referenced by getFrontend().

Here is the caller graph for this function:

setContext()

ilAuthFrontendFactory::setContext

(

$a_context

)

Set context for following authentication requests.

Parameters

int

$a_context

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

    {
        $this->context = $a_context;
    }

Field Documentation

$context

ilAuthFrontendFactory::$context = self::CONTEXT_UNDEFINED

private

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

Referenced by getContext().

$credentials

ilAuthFrontendFactory::$credentials = null

private

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

Referenced by getFrontend().

$logger

ilAuthFrontendFactory::$logger = null

private

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

Referenced by getLogger().

CONTEXT_CLI

const ilAuthFrontendFactory::CONTEXT_CLI = 3

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

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

CONTEXT_HTTP

const ilAuthFrontendFactory::CONTEXT_HTTP = 5

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

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

CONTEXT_STANDARD_FORM

const ilAuthFrontendFactory::CONTEXT_STANDARD_FORM = 2

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

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

CONTEXT_UNDEFINED

const ilAuthFrontendFactory::CONTEXT_UNDEFINED = 0

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

Referenced by getFrontend().

CONTEXT_WS

const ilAuthFrontendFactory::CONTEXT_WS = 4

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

Referenced by getFrontend().

---

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

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