class.ilAuthFrontendFactory.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilAuthFrontendFactory
{
    private const CONTEXT_UNDEFINED = 0;

    // authentication with id and password. Used for standard form based authentication
    // soap auth (login) but not for (CLI (cron)?) and HTTP basic authentication
    public const CONTEXT_STANDARD_FORM = 2;

    // CLI context for cron
    public const CONTEXT_CLI = 3;

    // Rest soap context
    public const CONTEXT_WS = 4;

    // http auth
    public const CONTEXT_HTTP = 5;


    private int $context = self::CONTEXT_UNDEFINED;
    private ilLogger $logger;


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

    public function setContext(int $a_context): void
    {
        $this->context = $a_context;
    }

    public function getContext(): int
    {
        return $this->context;
    }

    public function getFrontend(ilAuthSession $session, ilAuthStatus $status, ilAuthCredentials $credentials, array $providers): ?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;
    }
}