Service context (factory) class. More...

Inheritance diagram for ilContext:

Collaboration diagram for ilContext:

Static Public Member Functions
static	init ($a_type)
	Init context by type. More...

static	directCall ($a_type, $a_method)
	Call context method directly without internal handling. More...

static	supportsRedirects ()
	Are redirects supported? More...

static	hasUser ()
	Based on user authentication? More...

static	usesHTTP ()
	Uses HTTP aka browser. More...

static	hasHTML ()
	Has HTML output. More...

static	usesTemplate ()
	Uses template engine. More...

static	initClient ()
	Init client. More...

static	doAuthentication ()
	Try authentication. More...

static	supportsPushMessages ()
	Supports push messages. More...

static	getType ()
	Get context type. More...

static	supportsPersistentSessions ()
	Check if context supports persistent session handling. More...

static	isSessionMainContext ()
	Context that are not only temporary in a session (e.g. More...

static	modifyHttpPath (string $httpPath)

Data Fields
const	CONTEXT_WEB = "ilContextWeb"

const	CONTEXT_CRON = "ilContextCron"

const	CONTEXT_RSS = "ilContextRss"

const	CONTEXT_ICAL = "ilContextIcal"

const	CONTEXT_SOAP = "ilContextSoap"

const	CONTEXT_SOAP_NO_AUTH = 'ilContextSoapNoAuth'

const	CONTEXT_WEBDAV = "ilContextWebdav"

const	CONTEXT_RSS_AUTH = "ilContextRssAuth"

const	CONTEXT_SESSION_REMINDER = "ilContextSessionReminder"

const	CONTEXT_SOAP_WITHOUT_CLIENT = "ilContextSoapWithoutClient"

const	CONTEXT_UNITTEST = "ilContextUnitTest"

const	CONTEXT_REST = "ilContextRest"

const	CONTEXT_SCORM = "ilContextScorm"

const	CONTEXT_WAC = "ilContextWAC"

const	CONTEXT_APACHE_SSO = 'ilContextApacheSSO'

const	CONTEXT_SHIBBOLETH = 'ilContextShibboleth'

const	CONTEXT_LTI_PROVIDER = 'ilContextLTIProvider'

const	CONTEXT_SAML = 'ilContextSaml'

Static Protected Member Functions
static	callContext ($a_method, array $args=[])
	Call current content. More...

Static Protected Attributes
static	$class_name

static	$type

Detailed Description

Service context (factory) class.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om; Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Version: $Id$

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

Member Function Documentation

◆ callContext()

static ilContext::callContext	(		$a_method,
		array	$args = `[]`
	)

staticprotected

Call current content.

Parameters

string	$a_method
array	$args

Returns: mixed

Definition at line 77 of file class.ilContext.php.

     {
         if (!self::$class_name) {
             self::init(self::CONTEXT_WEB);
         }
 
         return call_user_func_array([self::$class_name, $a_method], $args);
     }

◆ directCall()

static ilContext::directCall	(	$a_type,
		$a_method
	)

static

Call context method directly without internal handling.

Parameters

int $a_type

Returns: mixed

Definition at line 60 of file class.ilContext.php.

References $class_name.

Referenced by ilAwarenessUserCollector\getOnlineUsers().

     {
         $class_name = $a_type;
         if ($class_name) {
             include_once "Services/Context/classes/class." . $class_name . ".php";
             if (method_exists($class_name, $a_method)) {
                 return call_user_func(array($class_name, $a_method));
             }
         }
     }

Here is the caller graph for this function:

◆ doAuthentication()

static ilContext::doAuthentication ( )

static

Try authentication.

Returns: bool

Definition at line 163 of file class.ilContext.php.

     {
         return (bool) self::callContext("doAuthentication");
     }

◆ getType()

static ilContext::getType ( )

static

Get context type.

Returns: string

Definition at line 183 of file class.ilContext.php.

References $type.

Referenced by ILIAS\FileDelivery\Delivery\__construct(), ilSession\_writeData(), ilInitialisation\blockedAuthentication(), ilMail\enqueue(), ilAuthFrontend\handleAuthenticationSuccess(), ilSoapAdministration\initIlias(), ilLoggerFactory\isConsoleAvailable(), ilInitialisation\resumeUserSession(), ilECSTaskScheduler\start(), and ilContextTest\testInit().

     {
         return self::$type;
     }

Here is the caller graph for this function:

◆ hasHTML()

static ilContext::hasHTML ( )

static

Has HTML output.

Returns: bool

Definition at line 133 of file class.ilContext.php.

Referenced by ilForumAuthorInformation\getUserImagePath(), ilInitialisation\handleMaintenanceMode(), ilInitialisation\initILIAS(), ilInitialisation\redirect(), and ilBadgeHandler\sendNotification().

     {
         return (bool) self::callContext("hasHTML");
     }

Here is the caller graph for this function:

◆ hasUser()

static ilContext::hasUser ( )

static

Based on user authentication?

Returns: bool

Definition at line 113 of file class.ilContext.php.

Referenced by ilInitialisation\initHTML(), and ilInitialisation\initILIAS().

     {
         return (bool) self::callContext("hasUser");
     }

Here is the caller graph for this function:

◆ init()

static ilContext::init ( $a_type )

static

Init context by type.

Parameters

string $a_type

Returns: bool

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

References $type.

Referenced by ilSoapFunctions\__call(), ilCronStartUp\__construct(), ilWebAccessChecker\addAppliedCheckingMethod(), ilSoapAdministration\getClientInfoXML(), ilSoapAdministration\getInstallationInfoXML(), ilNusoapUserAdministrationAdapter\handleSoapPlugins(), XapiProxy\DataService\initIlias(), LTI\ilLTIConsumerDataService\initIlias(), ilCalendarRemoteAccessHandler\initIlias(), ilWebAccessChecker\initILIAS(), ILIAS\GlobalScreen\Client\ContentRenderer\run(), and ilContextTest\testInit().

     {
         include_once "Services/Context/classes/class." . $a_type . ".php";
         self::$class_name = $a_type;
         self::$type = $a_type;
         
         return true;
     }

Here is the caller graph for this function:

◆ initClient()

static ilContext::initClient ( )

static

Init client.

Returns: bool

Definition at line 153 of file class.ilContext.php.

Referenced by ilInitialisation\initILIAS().

     {
         return (bool) self::callContext("initClient");
     }

Here is the caller graph for this function:

◆ isSessionMainContext()

static ilContext::isSessionMainContext ( )

static

Context that are not only temporary in a session (e.g.

WAC is, Cron is not)

Returns: bool

Definition at line 205 of file class.ilContext.php.

Referenced by ilSession\_writeData().

     {
         return (bool) self::callContext('isSessionMainContext');
     }

Here is the caller graph for this function:

◆ modifyHttpPath()

static ilContext::modifyHttpPath ( string $httpPath )

static

Parameters

string $httpPath

Returns: string

Definition at line 214 of file class.ilContext.php.

Referenced by ilInitialisation\buildHTTPPath().

                                                             : string
     {
         return self::callContext('modifyHttpPath', [$httpPath]);
     }

Here is the caller graph for this function:

◆ supportsPersistentSessions()

static ilContext::supportsPersistentSessions ( )

static

Check if context supports persistent session handling.

false for cli context

Returns: bool

Definition at line 195 of file class.ilContext.php.

Referenced by ilInitialisation\initILIAS(), and ilInitialisation\setClientIdCookie().

     {
         return (bool) self::callContext('supportsPersistentSessions');
     }

Here is the caller graph for this function:

◆ supportsPushMessages()

static ilContext::supportsPushMessages ( )

static

Supports push messages.

Returns: bool

Definition at line 173 of file class.ilContext.php.

     {
         return (bool) self::callContext("supportsPushMessages");
     }

◆ supportsRedirects()

static ilContext::supportsRedirects ( )

static

Are redirects supported?

Returns: bool

Definition at line 91 of file class.ilContext.php.

References $DIC.

Referenced by ILIAS\Init\StartupSequence\StartUpSequenceDispatcher\dispatch(), ilInitialisation\redirect(), and ilAuthFrontendCredentialsApache\tryAuthenticationOnLoginPage().

     {
         global $DIC;
 
         $ilCtrl = null;
         if (isset($DIC["ilCtrl"])) {
             $ilCtrl = $DIC->ctrl();
         }
         
         // asynchronous calls must never be redirected
         if ($ilCtrl && $ilCtrl->isAsynch()) {
             return false;
         }
         
         return (bool) self::callContext("supportsRedirects");
     }

Here is the caller graph for this function:

◆ usesHTTP()

static ilContext::usesHTTP ( )

static

Uses HTTP aka browser.

Returns: bool

Definition at line 123 of file class.ilContext.php.

Referenced by ilUtil\_getHttpPath(), ilLanguageDetectorFactory\getValidInstances(), ilInitialisation\initClient(), ilInitialisation\initSettings(), and ilInitialisation\redirect().

     {
         return (bool) self::callContext("usesHTTP");
     }

Here is the caller graph for this function:

◆ usesTemplate()

static ilContext::usesTemplate ( )

static

Uses template engine.

Returns: bool

Definition at line 143 of file class.ilContext.php.

Referenced by ilInitialisation\requireCommonIncludes().

     {
         return (bool) self::callContext("usesTemplate");
     }

Here is the caller graph for this function:

Field Documentation

◆ $class_name

ilContext::$class_name

staticprotected

Definition at line 16 of file class.ilContext.php.

Referenced by directCall().

◆ $type

ilContext::$type

staticprotected

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

◆ CONTEXT_APACHE_SSO

const ilContext::CONTEXT_APACHE_SSO = 'ilContextApacheSSO'

Definition at line 33 of file class.ilContext.php.

Referenced by ilInitialisation\blockedAuthentication().

◆ CONTEXT_CRON

const ilContext::CONTEXT_CRON = "ilContextCron"

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

Referenced by ilCronStartUp\__construct(), ilContextTest\contextProvider(), and ilMail\enqueue().

◆ CONTEXT_ICAL

const ilContext::CONTEXT_ICAL = "ilContextIcal"

Definition at line 22 of file class.ilContext.php.

Referenced by ilContextTest\contextProvider(), and ilCalendarRemoteAccessHandler\initIlias().

◆ CONTEXT_LTI_PROVIDER

const ilContext::CONTEXT_LTI_PROVIDER = 'ilContextLTIProvider'

Definition at line 35 of file class.ilContext.php.

Referenced by ilInitialisation\blockedAuthentication(), and ilAuthFrontend\handleAuthenticationSuccess().

◆ CONTEXT_REST

const ilContext::CONTEXT_REST = "ilContextRest"

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

Referenced by ilContextTest\contextProvider().

◆ CONTEXT_RSS

const ilContext::CONTEXT_RSS = "ilContextRss"

Definition at line 21 of file class.ilContext.php.

Referenced by ilContextTest\contextProvider().

◆ CONTEXT_RSS_AUTH

const ilContext::CONTEXT_RSS_AUTH = "ilContextRssAuth"

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

Referenced by ilContextTest\contextProvider().

◆ CONTEXT_SAML

const ilContext::CONTEXT_SAML = 'ilContextSaml'

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

Referenced by ilInitialisation\blockedAuthentication().

◆ CONTEXT_SCORM

const ilContext::CONTEXT_SCORM = "ilContextScorm"

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

Referenced by ilContextTest\contextProvider(), XapiProxy\DataService\initIlias(), and LTI\ilLTIConsumerDataService\initIlias().

◆ CONTEXT_SESSION_REMINDER

const ilContext::CONTEXT_SESSION_REMINDER = "ilContextSessionReminder"

Definition at line 27 of file class.ilContext.php.

Referenced by ilContextTest\contextProvider().

◆ CONTEXT_SHIBBOLETH

const ilContext::CONTEXT_SHIBBOLETH = 'ilContextShibboleth'

Definition at line 34 of file class.ilContext.php.

Referenced by ilInitialisation\blockedAuthentication().

◆ CONTEXT_SOAP

const ilContext::CONTEXT_SOAP = "ilContextSoap"

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

Referenced by ilSoapFunctions\__call(), ilContextTest\contextProvider(), ilNusoapUserAdministrationAdapter\handleSoapPlugins(), ilSoapAdministration\initIlias(), and ilInitialisation\resumeUserSession().

◆ CONTEXT_SOAP_NO_AUTH

const ilContext::CONTEXT_SOAP_NO_AUTH = 'ilContextSoapNoAuth'

Definition at line 24 of file class.ilContext.php.

Referenced by ilSoapFunctions\__call(), and ilNusoapUserAdministrationAdapter\handleSoapPlugins().

◆ CONTEXT_SOAP_WITHOUT_CLIENT

const ilContext::CONTEXT_SOAP_WITHOUT_CLIENT = "ilContextSoapWithoutClient"

Definition at line 28 of file class.ilContext.php.

Referenced by ilContextTest\contextProvider(), ilSoapAdministration\getClientInfoXML(), and ilSoapAdministration\getInstallationInfoXML().

◆ CONTEXT_UNITTEST

const ilContext::CONTEXT_UNITTEST = "ilContextUnitTest"

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

Referenced by ilContextTest\contextProvider().

◆ CONTEXT_WAC

const ilContext::CONTEXT_WAC = "ilContextWAC"

Definition at line 32 of file class.ilContext.php.

Referenced by ilWebAccessChecker\addAppliedCheckingMethod(), ilInitialisation\blockedAuthentication(), ilContextTest\contextProvider(), ilWebAccessChecker\initILIAS(), ilInitialisation\resumeUserSession(), and ILIAS\GlobalScreen\Client\ContentRenderer\run().

◆ CONTEXT_WEB

const ilContext::CONTEXT_WEB = "ilContextWeb"

Definition at line 19 of file class.ilContext.php.

Referenced by ilContextTest\contextProvider(), ilLoggerFactory\isConsoleAvailable(), and ilECSTaskScheduler\start().

◆ CONTEXT_WEBDAV

const ilContext::CONTEXT_WEBDAV = "ilContextWebdav"

Definition at line 25 of file class.ilContext.php.

Referenced by ilInitialisation\blockedAuthentication(), and ilContextTest\contextProvider().

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

Services/Context/classes/class.ilContext.php

Static Public Member Functions

Data Fields

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ callContext()

◆ directCall()

◆ doAuthentication()

◆ getType()

◆ hasHTML()

◆ hasUser()

◆ init()

◆ initClient()

◆ isSessionMainContext()

◆ modifyHttpPath()

◆ supportsPersistentSessions()

◆ supportsPushMessages()

◆ supportsRedirects()

◆ usesHTTP()

◆ usesTemplate()

Field Documentation

◆ $class_name

◆ $type

◆ CONTEXT_APACHE_SSO

◆ CONTEXT_CRON

◆ CONTEXT_ICAL

◆ CONTEXT_LTI_PROVIDER

◆ CONTEXT_REST

◆ CONTEXT_RSS

◆ CONTEXT_RSS_AUTH

◆ CONTEXT_SAML

◆ CONTEXT_SCORM

◆ CONTEXT_SESSION_REMINDER

◆ CONTEXT_SHIBBOLETH

◆ CONTEXT_SOAP

◆ CONTEXT_SOAP_NO_AUTH

◆ CONTEXT_SOAP_WITHOUT_CLIENT

◆ CONTEXT_UNITTEST

◆ CONTEXT_WAC

◆ CONTEXT_WEB

◆ CONTEXT_WEBDAV