ilAuthFactory Class Reference

Authentication frontend factory. More...

Collaboration diagram for ilAuthFactory:

Static Public Member Functions
static	getContext ()
static	setContext ($a_context)
	set context More...
static	setContextOptions ($a_context, $a_options)
	set context specific options for later use in factory. More...
static	getContextOptions ()
	Get options for a specific context. More...
static	factory (ilAuthContainerBase $deco)
	The factory. More...

Data Fields
const	CONTEXT_WEB = 1
const	CONTEXT_HTTP = 2
const	CONTEXT_SOAP = 3
const	CONTEXT_CAS = 5
const	CONTEXT_CALENDAR = 6
const	CONTEXT_CALENDAR_TOKEN = 7
const	CONTEXT_ECS = 8
const	CONTEXT_APACHE = 10

Static Private Attributes
static	$context = self::CONTEXT_WEB
static	$context_options = array()

Detailed Description

Authentication frontend factory.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 14 of file class.ilAuthFactory.php.

Member Function Documentation

factory()

static ilAuthFactory::factory ( ilAuthContainerBase  $deco )

static

The factory.

Parameters

object	$container	ilAuthContainerBase
array	$options

Returns

object ilAuthContainerBase

Definition at line 130 of file class.ilAuthFactory.php.

    {
        $options = self::getContextOptions(self::getContext());
        
        switch (self::$context) {
            case self::CONTEXT_WEB:
                include_once './Services/Authentication/classes/class.ilAuthWeb.php';
                return new ilAuthWeb($deco, $options);
                
            case self::CONTEXT_HTTP:
                include_once './Services/Authentication/classes/class.ilAuthHTTP.php';
                return new ilAuthHTTP($deco, $options);
 
            case self::CONTEXT_SOAP:
                include_once './Services/WebServices/SOAP/classes/class.ilAuthSOAP.php';
                return new ilAuthSOAP($deco, $options);
                
            case self::CONTEXT_CAS:
                include_once './Services/CAS/classes/class.ilAuthCAS.php';
                return new ilAuthCAS($deco, $options);
                
            case self::CONTEXT_CALENDAR:
                include_once './Services/Calendar/classes/class.ilAuthCalendar.php';
                return new ilAuthCalendar($deco, $options);
                
            case self::CONTEXT_CALENDAR_TOKEN:
                include_once './Services/Calendar/classes/class.ilAuthCalendarToken.php';
                include_once './Services/Calendar/classes/class.ilAuthContainerCalendarToken.php';
                // Force token authentication
                $GLOBALS['ilLog']->write('Calling calendar token');
                return new ilAuthCalendarToken(new ilAuthContainerCalendarToken(), $options);
                
            case self::CONTEXT_ECS:
                include_once './Services/WebServices/ECS/classes/class.ilAuthECS.php';
                return new ilAuthECS($deco, $options);
            
            case self::CONTEXT_APACHE:
                include_once './Services/AuthApache/classes/class.ilAuthApache.php';
                return new ilAuthApache($deco, $options);
        }
    }

References $GLOBALS, $options, CONTEXT_APACHE, CONTEXT_CALENDAR, CONTEXT_CALENDAR_TOKEN, CONTEXT_CAS, CONTEXT_ECS, CONTEXT_HTTP, CONTEXT_SOAP, CONTEXT_WEB, and getContextOptions().

Here is the call graph for this function:

getContext()

static ilAuthFactory::getContext ( )

static

Returns

int current context

Definition at line 85 of file class.ilAuthFactory.php.

    {
        return self::$context;
    }

References $context.

Referenced by ilAuthFrontend\handleAuthenticationSuccess(), ilInitialisation\includePhp5Compliance(), ilAuthBase\loginObserver(), pr(), ilInitialisation\setCookieConstants(), and vd().

Here is the caller graph for this function:

getContextOptions()

static ilAuthFactory::getContextOptions ( )

static

Get options for a specific context.

Returns

Definition at line 116 of file class.ilAuthFactory.php.

    {
        return self::$context_options[$a_context] ?
            self::$context_options[$a_context] :
            array();
    }

Referenced by factory().

Here is the caller graph for this function:

setContext()

static ilAuthFactory::setContext (   $a_context )

static

set context

Parameters

int

$a_context

Returns

Definition at line 95 of file class.ilAuthFactory.php.

    {
        self::$context = $a_context;
    }

Referenced by ilSoapAdministration\__initAuthenticationObject(), ilAuthUtils\_getAuthModeOfUser(), and ilCalendarRemoteAccessHandler\initIlias().

Here is the caller graph for this function:

setContextOptions()

static ilAuthFactory::setContextOptions (   $a_context,   $a_options  )

static

set context specific options for later use in factory.

Returns

Parameters

object	$a_context
object	$a_options

Definition at line 107 of file class.ilAuthFactory.php.

    {
        self::$context_options[$a_context] = $a_options;
    }

Field Documentation

$context

ilAuthFactory::$context = self::CONTEXT_WEB

staticprivate

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

Referenced by getContext().

$context_options

ilAuthFactory::$context_options = array()

staticprivate

Definition at line 79 of file class.ilAuthFactory.php.

CONTEXT_APACHE

const ilAuthFactory::CONTEXT_APACHE = 10

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

Referenced by factory().

CONTEXT_CALENDAR

const ilAuthFactory::CONTEXT_CALENDAR = 6

Definition at line 47 of file class.ilAuthFactory.php.

Referenced by factory().

CONTEXT_CALENDAR_TOKEN

const ilAuthFactory::CONTEXT_CALENDAR_TOKEN = 7

Definition at line 54 of file class.ilAuthFactory.php.

Referenced by factory(), and ilCalendarRemoteAccessHandler\initIlias().

CONTEXT_CAS

const ilAuthFactory::CONTEXT_CAS = 5

Definition at line 41 of file class.ilAuthFactory.php.

Referenced by factory(), and ilInitialisation\includePhp5Compliance().

CONTEXT_ECS

const ilAuthFactory::CONTEXT_ECS = 8

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

Referenced by ilAuthUtils\_getAuthModeOfUser(), factory(), ilAuthFrontend\handleAuthenticationSuccess(), and ilAuthBase\loginObserver().

CONTEXT_HTTP

const ilAuthFactory::CONTEXT_HTTP = 2

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

Referenced by factory(), and ilInitialisation\setCookieConstants().

CONTEXT_SOAP

const ilAuthFactory::CONTEXT_SOAP = 3

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

Referenced by ilSoapAdministration\__initAuthenticationObject(), and factory().

CONTEXT_WEB

const ilAuthFactory::CONTEXT_WEB = 1

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

Referenced by factory().

---

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

• Services/Authentication/classes/class.ilAuthFactory.php