This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilContext:

Collaboration diagram for ilContext:

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

static	directCall (string $a_type, string $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::class

const	CONTEXT_CRON = ilContextCron::class

const	CONTEXT_RSS = ilContextRss::class

const	CONTEXT_ICAL = ilContextIcal::class

const	CONTEXT_SOAP = ilContextSoap::class

const	CONTEXT_SOAP_NO_AUTH = ilContextSoapNoAuth::class

const	CONTEXT_WEBDAV = ilContextWebdav::class

const	CONTEXT_RSS_AUTH = ilContextRssAuth::class

const	CONTEXT_SESSION_REMINDER = ilContextSessionReminder::class

const	CONTEXT_SOAP_WITHOUT_CLIENT = ilContextSoapWithoutClient::class

const	CONTEXT_UNITTEST = ilContextUnitTest::class

const	CONTEXT_REST = ilContextRest::class

const	CONTEXT_SCORM = ilContextScorm::class

const	CONTEXT_WAC = ilContextWAC::class

const	CONTEXT_APACHE_SSO = ilContextApacheSSO::class

const	CONTEXT_SHIBBOLETH = ilContextShibboleth::class

const	CONTEXT_LTI_PROVIDER = ilContextLTIProvider::class

const	CONTEXT_SAML = ilContextSaml::class

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

Static Protected Attributes
static string	$class_name = ""

static string	$type = ""

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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

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

Member Function Documentation

◆ callContext()

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

staticprotected

Call current content.

Returns: mixed

Definition at line 78 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);
    }

References init().

Referenced by doAuthentication(), hasHTML(), hasUser(), initClient(), isSessionMainContext(), modifyHttpPath(), supportsPersistentSessions(), supportsPushMessages(), supportsRedirects(), usesHTTP(), and usesTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ directCall()

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

static

Call context method directly without internal handling.

Returns: mixed

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

    {
        $class_name = $a_type;
        if ($class_name && method_exists($class_name, $a_method)) {
            return call_user_func(array($class_name, $a_method));
        }
 
        return null;
    }

References $class_name.

Referenced by ILIAS\Awareness\User\Collector\getOnlineUsers().

Here is the caller graph for this function:

◆ doAuthentication()

static ilContext::doAuthentication ( )

static

Try authentication.

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

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

References callContext().

Here is the call graph for this function:

◆ getType()

static ilContext::getType ( )

static

Get context type.

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

                                    : string
    {
        return self::$type;
    }

References $type.

Referenced by ILIAS\FileDelivery\Delivery\__construct(), ilMaterializedPathTree\__construct(), ilInitialisation\blockedAuthentication(), ilErrorHandling\getHandler(), ilInitialisation\handleAuthenticationFail(), ilAuthFrontend\handleAuthenticationSuccess(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilLoggerFactory\isConsoleAvailable(), ilSoapAdministration\reInitUser(), and ilContextTest\testInit().

Here is the caller graph for this function:

◆ hasHTML()

static ilContext::hasHTML ( )

static

Has HTML output.

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

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

References callContext().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasUser()

static ilContext::hasUser ( )

static

Based on user authentication?

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

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

References callContext().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init()

static ilContext::init ( string $a_type )

static

Init context by type.

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

                                               : bool
    {
        self::$class_name = $a_type;
        self::$type = $a_type;
 
        return true;
    }

Referenced by ilSoapFunctions\__call(), ILIAS\Cron\CLI\StartUp\__construct(), callContext(), ilSoapAdministration\getClientInfoXML(), ilSoapAdministration\getInstallationInfoXML(), ilNusoapUserAdministrationAdapter\handleSoapPlugins(), ilCalendarRemoteAccessHandler\initIlias(), ilWebAccessChecker\initILIAS(), XapiProxy\DataService\initIlias(), and ilContextTest\testInit().

Here is the caller graph for this function:

◆ initClient()

static ilContext::initClient ( )

static

Init client.

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

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

References callContext().

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

Here is the call graph for this function:

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)

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

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

References callContext().

Here is the call graph for this function:

◆ modifyHttpPath()

static ilContext::modifyHttpPath ( string $httpPath )

static

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

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

References callContext().

Referenced by ILIAS\Init\Environment\HttpPathBuilder\build(), and ilObjLTIConsumer\getIliasHttpPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ supportsPersistentSessions()

static ilContext::supportsPersistentSessions ( )

static

Check if context supports persistent session handling.

false for cli context

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

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

References callContext().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ supportsPushMessages()

static ilContext::supportsPushMessages ( )

static

Supports push messages.

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

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

References callContext().

Here is the call graph for this function:

◆ supportsRedirects()

static ilContext::supportsRedirects ( )

static

Are redirects supported?

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

                                              : bool
    {
        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");
    }

References $DIC, and callContext().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ usesHTTP()

static ilContext::usesHTTP ( )

static

Uses HTTP aka browser.

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

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

References callContext().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ usesTemplate()

static ilContext::usesTemplate ( )

static

Uses template engine.

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

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

References callContext().

Here is the call graph for this function:

Field Documentation

◆ $class_name

string ilContext::$class_name = ""

staticprotected

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

Referenced by directCall(), and ilContextExtended\getClassName().

◆ $type

string ilContext::$type = ""

staticprotected

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

Referenced by getType().

◆ CONTEXT_APACHE_SSO

const ilContext::CONTEXT_APACHE_SSO = ilContextApacheSSO::class

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

Referenced by ilInitialisation\blockedAuthentication().

◆ CONTEXT_CRON

const ilContext::CONTEXT_CRON = ilContextCron::class

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

Referenced by ILIAS\Cron\CLI\StartUp\__construct(), and ilContextTest\contextProvider().

◆ CONTEXT_ICAL

const ilContext::CONTEXT_ICAL = ilContextIcal::class

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

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

◆ CONTEXT_LTI_PROVIDER

const ilContext::CONTEXT_LTI_PROVIDER = ilContextLTIProvider::class

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

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

◆ CONTEXT_REST

const ilContext::CONTEXT_REST = ilContextRest::class

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

Referenced by ilContextTest\contextProvider().

◆ CONTEXT_RSS

const ilContext::CONTEXT_RSS = ilContextRss::class

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

Referenced by ilContextTest\contextProvider().

◆ CONTEXT_RSS_AUTH

const ilContext::CONTEXT_RSS_AUTH = ilContextRssAuth::class

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

Referenced by ilContextTest\contextProvider().

◆ CONTEXT_SAML

const ilContext::CONTEXT_SAML = ilContextSaml::class

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

Referenced by ilInitialisation\blockedAuthentication().

◆ CONTEXT_SCORM

const ilContext::CONTEXT_SCORM = ilContextScorm::class

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

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

◆ CONTEXT_SESSION_REMINDER

const ilContext::CONTEXT_SESSION_REMINDER = ilContextSessionReminder::class

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

Referenced by ilContextTest\contextProvider().

◆ CONTEXT_SHIBBOLETH

const ilContext::CONTEXT_SHIBBOLETH = ilContextShibboleth::class

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

Referenced by ilInitialisation\blockedAuthentication().

◆ CONTEXT_SOAP

const ilContext::CONTEXT_SOAP = ilContextSoap::class

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

Referenced by ilSoapFunctions\__call(), ilContextTest\contextProvider(), ilErrorHandling\getHandler(), ilInitialisation\handleAuthenticationFail(), ilNusoapUserAdministrationAdapter\handleSoapPlugins(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\reInitUser().

◆ CONTEXT_SOAP_NO_AUTH

const ilContext::CONTEXT_SOAP_NO_AUTH = ilContextSoapNoAuth::class

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

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

◆ CONTEXT_SOAP_WITHOUT_CLIENT

const ilContext::CONTEXT_SOAP_WITHOUT_CLIENT = ilContextSoapWithoutClient::class

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

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

◆ CONTEXT_UNITTEST

const ilContext::CONTEXT_UNITTEST = ilContextUnitTest::class

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

Referenced by ilContextTest\contextProvider().

◆ CONTEXT_WAC

const ilContext::CONTEXT_WAC = ilContextWAC::class

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

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

◆ CONTEXT_WEB

const ilContext::CONTEXT_WEB = ilContextWeb::class

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

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

◆ CONTEXT_WEBDAV

const ilContext::CONTEXT_WEBDAV = ilContextWebdav::class

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

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

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

components/ILIAS/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