ilAuthFrontendFactory Class Reference

Factory for auth frontend classes. More...

Collaboration diagram for ilAuthFrontendFactory:

Public Member Functions
	__construct ()
	Constructor. More...
	setContext (int $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_STANDARD_FORM = 2
const	CONTEXT_CLI = 3
const	CONTEXT_WS = 4
const	CONTEXT_HTTP = 5

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

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 27 of file class.ilAuthFrontendFactory.php.

Constructor & Destructor Documentation

__construct()

ilAuthFrontendFactory::__construct

(

)

Constructor.

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

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

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

Here is the call graph for this function:

Member Function Documentation

getContext()

ilAuthFrontendFactory::getContext

(

)

Get context.

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

References $context.

Referenced by getFrontend().

                                : int
    {
        return $this->context;
    }

Here is the caller graph for this function:

getFrontend()

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

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

References getContext(), ILIAS\Repository\logger(), and null.

                                                                                                                               : ?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;
    }

Here is the call graph for this function:

setContext()

ilAuthFrontendFactory::setContext

(

int

$a_context

)

Set context for following authentication requests.

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

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

Field Documentation

$context

int ilAuthFrontendFactory::$context = self::CONTEXT_UNDEFINED

private

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

Referenced by getContext().

$logger

ilLogger ilAuthFrontendFactory::$logger

private

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

CONTEXT_CLI

const ilAuthFrontendFactory::CONTEXT_CLI = 3

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

Referenced by ILIAS\Cron\CLI\StartUp\authenticate().

CONTEXT_HTTP

const ilAuthFrontendFactory::CONTEXT_HTTP = 5

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

Referenced by ilWebDAVAuthentication\authenticate().

CONTEXT_STANDARD_FORM

const ilAuthFrontendFactory::CONTEXT_STANDARD_FORM = 2

Definition at line 33 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(), ilAuthUtils\handleForcedAuthentication(), and ilAuthFrontendCredentialsSoap\tryAuthenticationOnLoginPage().

CONTEXT_UNDEFINED

const ilAuthFrontendFactory::CONTEXT_UNDEFINED = 0

private

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

CONTEXT_WS

const ilAuthFrontendFactory::CONTEXT_WS = 4

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

Referenced by ilSoapUserAdministration\login().

---

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

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