class.ilAuthFrontendFactory.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilAuthFrontendFactory
{
    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
    const CONTEXT_STANDARD_FORM = 2;
    
    // CLI context for cron
    const CONTEXT_CLI = 3;
    
    // Rest soap context
    const CONTEXT_WS = 4;
    
    // http auth
    const CONTEXT_HTTP = 5;
    
    
    private $context = self::CONTEXT_UNDEFINED;
    private $credentials = null;
    private $logger = null;
    
    
    public function __construct()
    {
        $this->logger = ilLoggerFactory::getLogger('auth');
    }
    
    public function getLogger()
    {
        return $this->logger;
    }
    
    public function setContext($a_context)
    {
        $this->context = $a_context;
    }
    
    public function getContext()
    {
        return $this->context;
    }
    
    public function getFrontend(ilAuthSession $session, ilAuthStatus $status, ilAuthCredentials $credentials, array $providers)
    {
        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;
        }
    }
}