class.ilContext.php

Go to the documentation of this file.

<?php

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

class ilContext
{
    protected static $class_name; // [string]
    protected static $type; // [string]
    
    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';
    
    
    public static function init($a_type)
    {
        include_once "Services/Context/classes/class." . $a_type . ".php";
        self::$class_name = $a_type;
        self::$type = $a_type;
        
        return true;
    }
    
    public static function directCall($a_type, $a_method)
    {
        $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));
            }
        }
    }

    protected static function callContext($a_method, array $args = [])
    {
        if (!self::$class_name) {
            self::init(self::CONTEXT_WEB);
        }

        return call_user_func_array([self::$class_name, $a_method], $args);
    }
    
    public static function supportsRedirects()
    {
        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");
    }
    
    public static function hasUser()
    {
        return (bool) self::callContext("hasUser");
    }
    
    public static function usesHTTP()
    {
        return (bool) self::callContext("usesHTTP");
    }
    
    public static function hasHTML()
    {
        return (bool) self::callContext("hasHTML");
    }
    
    public static function usesTemplate()
    {
        return (bool) self::callContext("usesTemplate");
    }
    
    public static function initClient()
    {
        return (bool) self::callContext("initClient");
    }
    
    public static function doAuthentication()
    {
        return (bool) self::callContext("doAuthentication");
    }
    
    public static function supportsPushMessages()
    {
        return (bool) self::callContext("supportsPushMessages");
    }
    
    public static function getType()
    {
        return self::$type;
    }
    
    public static function supportsPersistentSessions()
    {
        return (bool) self::callContext('supportsPersistentSessions');
    }

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

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