ilGlobalCache Class Reference

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

Collaboration diagram for ilGlobalCache:

Public Member Functions
	isActive ()
	isValid (string $key)
	isInstallable ()
	isCacheServiceInstallable ()
	getInstallationFailureReason ()
	exists (string $key)
	set (string $key, $value, int $ttl=null)
	get (string $key)
	delete (string $key)
	flush (bool $complete=false)
	getInfo ()
	setComponent (string $component)
	getComponent ()
	setActive (bool $active)
	getActive ()
	setServiceType (int $service_type)
	getServiceType ()

Static Public Member Functions
static	setup (ilGlobalCacheSettings $ilGlobalCacheSettings)
static	getInstance (?string $component)
static	log (string $message, int $log_level)
static	getAllInstallableTypes ()
static	getAllTypes (bool $only_available=true)
static	lookupServiceClassName (int $service_type)
static	lookupServiceConfigName (int $service_type)
static	getSettings ()
static	setSettings (ilGlobalCacheSettings $settings)
static	getActiveComponents ()
static	setActiveComponents (array $active_components)
static	getAvailableComponents ()
static	setAvailableComponents (array $available_components)

Data Fields
const	MSG = 'Global Cache not active, can not access cache'
const	ACTIVE = true
const	TYPE_STATIC = 0
const	TYPE_MEMCACHED = 2
const	TYPE_APC = 3
const	TYPE_FALLBACK = self::TYPE_STATIC
const	COMP_CLNG = 'clng'
const	COMP_OBJ_DEF = 'obj_def'
const	COMP_TEMPLATE = 'tpl'
const	COMP_ILCTRL = 'ilctrl'
const	COMP_PLUGINS = 'plugins'
const	COMP_RBAC_UA = 'rbac_ua'
const	COMP_EVENTS = 'events'
const	COMP_TPL_BLOCKS = 'tpl_blocks'
const	COMP_TPL_VARIABLES = 'tpl_variables'
const	COMP_GLOBAL_SCREEN = 'global_screen'

Protected Member Functions
	__construct (int $service_type)
	checkSettings ()

Static Protected Member Functions
static	generateServiceId ()

Protected Attributes
ilGlobalCacheService	$global_cache
string	$component = null
bool	$active = true
int	$service_type = ilGlobalCache::TYPE_STATIC

Static Protected Attributes
static array	$types
static array	$available_types
static array	$active_components = array()
static array	$available_components
static array	$type_per_component = array()
static string	$unique_service_id = null
static array	$instances = null
static ilGlobalCacheSettings	$settings = null
static array	$active_cache = array()

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 Class ilGlobalCache

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

1.0.0

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

Constructor & Destructor Documentation

__construct()

ilGlobalCache::__construct ( int  $service_type )

protected

Definition at line 140 of file class.ilGlobalCache.php.

References $serviceName, getComponent(), getServiceType(), setActive(), setComponent(), and setServiceType().

    {
        self::generateServiceId();
        $this->setServiceType($service_type);
    }

Here is the call graph for this function:

Member Function Documentation

checkSettings()

ilGlobalCache::checkSettings ( )

protected

Definition at line 162 of file class.ilGlobalCache.php.

                                      : void
    {
    }

delete()

ilGlobalCache::delete

(

string

$key

)

Definition at line 368 of file class.ilGlobalCache.php.

References isActive().

                                       : bool
    {
        if (!$this->isActive()) {
            return false;
        }

        return $this->global_cache->delete($key);
    }

Here is the call graph for this function:

exists()

ilGlobalCache::exists

(

string

$key

)

Exceptions

RuntimeException

Definition at line 314 of file class.ilGlobalCache.php.

                                       : bool
    {
        if (!$this->global_cache->isActive()) {
            return false;
        }

        return $this->global_cache->exists($key);
    }

flush()

ilGlobalCache::flush

(

bool

$complete = false

)

Exceptions

RuntimeException

Definition at line 380 of file class.ilGlobalCache.php.

                                                 : bool
    {
        if ($this->global_cache->isActive()) {
            return $this->global_cache->flush($complete);
        }

        return false;
    }

generateServiceId()

static ilGlobalCache::generateServiceId ( )

staticprotected

Definition at line 180 of file class.ilGlobalCache.php.

References $service, $serviceName, $type, CLIENT_ID, and ilGlobalCacheSettings\LOG_LEVEL_NORMAL.

                                                 : string
    {
        if (!isset(self::$unique_service_id)) {
            $raw_service_id = '_';
            if (defined('CLIENT_ID')) {
                $raw_service_id .= 'il_' . CLIENT_ID;
            }
            self::$unique_service_id = substr(md5($raw_service_id), 0, 6);
        }
        return self::$unique_service_id;
    }

get()

ilGlobalCache::get

(

string

$key

)

Returns

mixed

Exceptions

RuntimeException

Definition at line 342 of file class.ilGlobalCache.php.

References getComponent(), getServiceType(), isActive(), and ilGlobalCacheSettings\LOG_LEVEL_CHATTY.

Referenced by ilCachedObjectDefinition\getInstance().

    {
        if (!$this->isActive()) {
            return false;
        }
        $unserialized_return = $this->global_cache->unserialize($this->global_cache->get($key));
        if ($unserialized_return) {
            $service_name = ' [' . self::lookupServiceClassName($this->getServiceType()) . ']';
            if ($this->global_cache->isValid($key)) {
                self::log(
                    $key . ' from component ' . $this->getComponent() . $service_name,
                    ilGlobalCacheSettings::LOG_LEVEL_CHATTY
                );

                return $unserialized_return;
            } else {
                self::log(
                    $key . ' from component ' . $this->getComponent() . ' is invalid' . $service_name,
                    ilGlobalCacheSettings::LOG_LEVEL_CHATTY
                );
            }
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getActive()

ilGlobalCache::getActive

(

)

Definition at line 409 of file class.ilGlobalCache.php.

References $active.

Referenced by isActive().

                               : bool
    {
        return $this->active;
    }

Here is the caller graph for this function:

getActiveComponents()

static ilGlobalCache::getActiveComponents ( )

static

Definition at line 434 of file class.ilGlobalCache.php.

                                                : array
    {
        return self::$active_components;
    }

getAllInstallableTypes()

static ilGlobalCache::getAllInstallableTypes ( )

static

Definition at line 212 of file class.ilGlobalCache.php.

References $type, and $types.

                                                   : array
    {
        $types = array();
        foreach (self::getAllTypes() as $type) {
            if ($type->isCacheServiceInstallable()) {
                $types[] = $type;
            }
        }

        return $types;
    }

getAllTypes()

static ilGlobalCache::getAllTypes ( bool  $only_available = true )

static

Definition at line 224 of file class.ilGlobalCache.php.

References $type, and $types.

                                                                   : array
    {
        $types = array();
        foreach (self::$types as $type) {
            if ($only_available && !in_array($type, self::$available_types)) {
                continue;
            }
            $obj = new self($type);
            $obj->initCachingService();
            $types[$type] = $obj;
        }

        return $types;
    }

getAvailableComponents()

static ilGlobalCache::getAvailableComponents ( )

static

Definition at line 444 of file class.ilGlobalCache.php.

Referenced by ilGlobalCacheSettings\activateAll(), ilGlobalCacheSettings\areAllComponentActivated(), ilGlobalCacheMetricsCollectedObjective\collectFrom(), and ilGlobalCacheSettings\writeToIniFile().

                                                   : array
    {
        return self::$available_components;
    }

Here is the caller graph for this function:

getComponent()

ilGlobalCache::getComponent

(

)

Definition at line 399 of file class.ilGlobalCache.php.

References $component.

Referenced by __construct(), get(), isActive(), and set().

                                  : ?string
    {
        return $this->component;
    }

Here is the caller graph for this function:

getInfo()

ilGlobalCache::getInfo

(

)

Definition at line 389 of file class.ilGlobalCache.php.

                             : array
    {
        return $this->global_cache->getInfo();
    }

getInstallationFailureReason()

ilGlobalCache::getInstallationFailureReason

(

)

Definition at line 306 of file class.ilGlobalCache.php.

                                                  : string
    {
        return $this->global_cache->getInstallationFailureReason();
    }

getInstance()

static ilGlobalCache::getInstance ( ?string  $component )

static

Definition at line 126 of file class.ilGlobalCache.php.

References $component, $service_type, and ILIAS\LTI\ToolProvider\getSettings().

Referenced by arConnectorCache\__construct(), ilCachedObjectDefinition\__construct(), ilCachedLanguage\__construct(), ilMMItemRepository\__construct(), ilCachedObjectDefinition\__destruct(), ilCachedObjectDefinition\flush(), ilMMItemStorage\getCache(), ilMMTypeActionStorage\getCache(), ilMMItemTranslationStorage\getCache(), ilMMCustomItemStorage\getCache(), HTML_Template_IT\getFile(), ilCachedObjectDefinition\getInstance(), HTML_Template_IT\init(), ilAppEventHandler\initListeners(), ilObjectDefinition\readDefinitionData(), ilServicesGlobalCacheTest\testService(), and ilServicesGlobalCacheTest\testValues().

                                                          : \ilGlobalCache
    {
        if (!isset(self::$instances[$component])) {
            $service_type = self::getSettings()->getService();
            $ilGlobalCache = new self($service_type);
            $ilGlobalCache->setComponent($component);
            $ilGlobalCache->initCachingService();

            self::$instances[$component] = $ilGlobalCache;
        }

        return self::$instances[$component];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getServiceType()

ilGlobalCache::getServiceType

(

)

Definition at line 419 of file class.ilGlobalCache.php.

References $service_type.

Referenced by __construct(), and get().

                                    : int
    {
        return $this->service_type;
    }

Here is the caller graph for this function:

getSettings()

static ilGlobalCache::getSettings ( )

static

Definition at line 424 of file class.ilGlobalCache.php.

References ILIAS\LTI\ToolProvider\$settings.

                                        : ilGlobalCacheSettings
    {
        return (self::$settings instanceof ilGlobalCacheSettings ? self::$settings : new ilGlobalCacheSettings());
    }

isActive()

ilGlobalCache::isActive

(

)

Definition at line 265 of file class.ilGlobalCache.php.

References $c, getActive(), getComponent(), and ilGlobalCacheSettings\LOG_LEVEL_CHATTY.

Referenced by delete(), get(), and set().

                              : bool
    {
        $c = $this->getComponent();
        if (isset(self::$active_cache[$c]) && self::$active_cache[$c] !== null) {
            return self::$active_cache[$c];
        }
        if (!self::ACTIVE) {
            self::$active_cache[$c] = false;

            return false;
        }
        if (!$this->getActive()) {
            self::log($c . '-wrapper is inactive...', ilGlobalCacheSettings::LOG_LEVEL_CHATTY);
            self::$active_cache[$c] = false;

            return false;
        }

        $isActive = $this->global_cache->isActive();
        self::log('component ' . $c . ', service is active: '
            . ($isActive ? 'yes' : 'no'), ilGlobalCacheSettings::LOG_LEVEL_CHATTY);
        self::$active_cache[$c] = $isActive;

        return $isActive;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isCacheServiceInstallable()

ilGlobalCache::isCacheServiceInstallable

(

)

Definition at line 301 of file class.ilGlobalCache.php.

                                               : bool
    {
        return $this->global_cache->isInstallable();
    }

isInstallable()

ilGlobalCache::isInstallable

(

)

Definition at line 296 of file class.ilGlobalCache.php.

                                   : bool
    {
        return count(self::getAllInstallableTypes()) > 0;
    }

isValid()

ilGlobalCache::isValid

(

string

$key

)

Definition at line 291 of file class.ilGlobalCache.php.

                                        : bool
    {
        return $this->global_cache->isValid($key);
    }

log()

static ilGlobalCache::log ( string  $message, int  $log_level  )

static

Definition at line 166 of file class.ilGlobalCache.php.

References $DIC, and ILIAS\LTI\ToolProvider\getSettings().

Referenced by HTML_Template_IT\init().

                                                               : void
    {
        if ($log_level <= self::getSettings()->getLogLevel()) {
            global $DIC;
            $ilLog = $DIC[\ilLog::class];
            $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
            $function = $backtrace[1]['function'];
            $class = $backtrace[1]['class'];
            if ($ilLog instanceof ilComponentLogger) {
                $ilLog->alert($class . '::' . $function . '(): ' . $message);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupServiceClassName()

static ilGlobalCache::lookupServiceClassName ( int  $service_type )

static

Definition at line 239 of file class.ilGlobalCache.php.

Referenced by ilGlobalCacheSettings\__toString().

                                                                    : string
    {
        switch ($service_type) {
            case self::TYPE_APC:
                return ilApc::class;
            case self::TYPE_MEMCACHED:
                return ilMemcache::class;
            default:
                return ilStaticCache::class;
        }
    }

Here is the caller graph for this function:

lookupServiceConfigName()

static ilGlobalCache::lookupServiceConfigName ( int  $service_type )

static

Definition at line 251 of file class.ilGlobalCache.php.

Referenced by ilGlobalCacheMetricsCollectedObjective\collectFrom().

                                                                     : string
    {
        switch ($service_type) {
            case self::TYPE_APC:
                return 'apc';
            case self::TYPE_MEMCACHED:
                return 'memcached';
            default:
                return 'static';
        }
    }

Here is the caller graph for this function:

set()

ilGlobalCache::set	(	string	$key,
			$value,
		int	$ttl = null
	)

Parameters

mixed

$value

Exceptions

RuntimeException

Definition at line 327 of file class.ilGlobalCache.php.

References getComponent(), isActive(), and ilGlobalCacheSettings\LOG_LEVEL_CHATTY.

Referenced by ilCachedObjectDefinition\getInstance().

                                                             : bool
    {
        if (!$this->isActive()) {
            return false;
        }
        self::log($key . ' set in component ' . $this->getComponent(), ilGlobalCacheSettings::LOG_LEVEL_CHATTY);
        $this->global_cache->setValid($key);

        return $this->global_cache->set($key, $this->global_cache->serialize($value), $ttl);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setActive()

ilGlobalCache::setActive

(

bool

$active

)

Definition at line 404 of file class.ilGlobalCache.php.

References $active.

Referenced by __construct().

                                           : void
    {
        $this->active = $active;
    }

Here is the caller graph for this function:

setActiveComponents()

static ilGlobalCache::setActiveComponents ( array  $active_components )

static

Definition at line 439 of file class.ilGlobalCache.php.

References $active_components.

                                                                        : void
    {
        self::$active_components = $active_components;
    }

setAvailableComponents()

static ilGlobalCache::setAvailableComponents ( array  $available_components )

static

Definition at line 449 of file class.ilGlobalCache.php.

References $available_components.

                                                                              : void
    {
        self::$available_components = $available_components;
    }

setComponent()

ilGlobalCache::setComponent

(

string

$component

)

Definition at line 394 of file class.ilGlobalCache.php.

References $component.

Referenced by __construct().

                                                   : void
    {
        $this->component = $component;
    }

Here is the caller graph for this function:

setServiceType()

ilGlobalCache::setServiceType

(

int

$service_type

)

Definition at line 414 of file class.ilGlobalCache.php.

References $service_type.

Referenced by __construct().

                                                     : void
    {
        $this->service_type = $service_type;
    }

Here is the caller graph for this function:

setSettings()

static ilGlobalCache::setSettings ( ilGlobalCacheSettings  $settings )

static

Definition at line 429 of file class.ilGlobalCache.php.

References $settings, and ILIAS\LTI\ToolProvider\$settings.

                                                                       : void
    {
        self::$settings = $settings;
    }

setup()

static ilGlobalCache::setup ( ilGlobalCacheSettings  $ilGlobalCacheSettings )

static

Definition at line 120 of file class.ilGlobalCache.php.

References ilGlobalCacheSettings\getActivatedComponents(), and ILIAS\LTI\ToolProvider\setSettings().

Referenced by ilInitialisation\initClientIniFile(), ilServicesGlobalCacheTest\testService(), and ilServicesGlobalCacheTest\testValues().

                                                                              : void
    {
        self::setSettings($ilGlobalCacheSettings);
        self::setActiveComponents($ilGlobalCacheSettings->getActivatedComponents());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$active

bool ilGlobalCache::$active = true

protected

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

Referenced by getActive(), and setActive().

$active_cache

array ilGlobalCache::$active_cache = array()

staticprotected

Definition at line 263 of file class.ilGlobalCache.php.

$active_components

array ilGlobalCache::$active_components = array()

staticprotected

Definition at line 100 of file class.ilGlobalCache.php.

Referenced by setActiveComponents().

$available_components

array ilGlobalCache::$available_components

staticprotected

Initial value:

= array(
        self::COMP_CLNG,
        self::COMP_OBJ_DEF,
        self::COMP_ILCTRL,
        self::COMP_TEMPLATE,
        self::COMP_TPL_BLOCKS,
        self::COMP_TPL_VARIABLES,
        self::COMP_EVENTS,
        self::COMP_GLOBAL_SCREEN,
    )

Definition at line 101 of file class.ilGlobalCache.php.

Referenced by setAvailableComponents().

$available_types

array ilGlobalCache::$available_types

staticprotected

Initial value:

= array(
        self::TYPE_MEMCACHED,
        self::TYPE_APC,
        self::TYPE_STATIC,
    )

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

$component

string ilGlobalCache::$component = null

protected

Definition at line 115 of file class.ilGlobalCache.php.

Referenced by getComponent(), getInstance(), and setComponent().

$global_cache

ilGlobalCacheService ilGlobalCache::$global_cache

protected

Definition at line 114 of file class.ilGlobalCache.php.

$instances

array ilGlobalCache::$instances = null

staticprotected

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

$service_type

int ilGlobalCache::$service_type = ilGlobalCache::TYPE_STATIC

protected

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

Referenced by getInstance(), getServiceType(), and setServiceType().

$settings

ilGlobalCacheSettings ilGlobalCache::$settings = null

staticprotected

Definition at line 118 of file class.ilGlobalCache.php.

Referenced by setSettings().

$type_per_component

array ilGlobalCache::$type_per_component = array()

staticprotected

Definition at line 111 of file class.ilGlobalCache.php.

$types

array ilGlobalCache::$types

staticprotected

Initial value:

= array(
        self::TYPE_MEMCACHED,
        self::TYPE_APC,
        self::TYPE_STATIC,
    )

Definition at line 90 of file class.ilGlobalCache.php.

Referenced by getAllInstallableTypes(), and getAllTypes().

$unique_service_id

string ilGlobalCache::$unique_service_id = null

staticprotected

Definition at line 112 of file class.ilGlobalCache.php.

ACTIVE

const ilGlobalCache::ACTIVE = true

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

COMP_CLNG

const ilGlobalCache::COMP_CLNG = 'clng'

Definition at line 53 of file class.ilGlobalCache.php.

Referenced by ilCachedLanguage\__construct().

COMP_EVENTS

const ilGlobalCache::COMP_EVENTS = 'events'

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

Referenced by ilAppEventHandler\initListeners().

COMP_GLOBAL_SCREEN

const ilGlobalCache::COMP_GLOBAL_SCREEN = 'global_screen'

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

Referenced by arConnectorCache\__construct(), ilMMItemRepository\__construct(), ilMMItemStorage\getCache(), ilMMTypeActionStorage\getCache(), ilMMItemTranslationStorage\getCache(), and ilMMCustomItemStorage\getCache().

COMP_ILCTRL

const ilGlobalCache::COMP_ILCTRL = 'ilctrl'

Definition at line 65 of file class.ilGlobalCache.php.

COMP_OBJ_DEF

const ilGlobalCache::COMP_OBJ_DEF = 'obj_def'

Definition at line 57 of file class.ilGlobalCache.php.

Referenced by ilCachedObjectDefinition\__construct(), ilCachedObjectDefinition\__destruct(), ilCachedObjectDefinition\flush(), ilCachedObjectDefinition\getInstance(), and ilObjectDefinition\readDefinitionData().

COMP_PLUGINS

const ilGlobalCache::COMP_PLUGINS = 'plugins'

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

COMP_RBAC_UA

const ilGlobalCache::COMP_RBAC_UA = 'rbac_ua'

Definition at line 73 of file class.ilGlobalCache.php.

COMP_TEMPLATE

const ilGlobalCache::COMP_TEMPLATE = 'tpl'

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

Referenced by HTML_Template_IT\getFile().

COMP_TPL_BLOCKS

const ilGlobalCache::COMP_TPL_BLOCKS = 'tpl_blocks'

Definition at line 81 of file class.ilGlobalCache.php.

Referenced by HTML_Template_IT\init().

COMP_TPL_VARIABLES

const ilGlobalCache::COMP_TPL_VARIABLES = 'tpl_variables'

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

Referenced by HTML_Template_IT\init().

MSG

const ilGlobalCache::MSG = 'Global Cache not active, can not access cache'

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

TYPE_APC

const ilGlobalCache::TYPE_APC = 3

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

Referenced by ilGlobalCacheSetupAgent\getArrayToConfigTransformation(), and ILIAS\Tests\GlobalCache\Setup\ilGlobalCacheSetupAgentTest\testGetArrayToConfigTransformationWithDataServices().

TYPE_FALLBACK

const ilGlobalCache::TYPE_FALLBACK = self::TYPE_STATIC

Definition at line 49 of file class.ilGlobalCache.php.

TYPE_MEMCACHED

const ilGlobalCache::TYPE_MEMCACHED = 2

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

Referenced by ilGlobalCacheMetricsCollectedObjective\collectFrom(), ilGlobalCacheSetupAgent\getArrayToConfigTransformation(), and ILIAS\Tests\GlobalCache\Setup\ilGlobalCacheSetupAgentTest\testGetArrayToConfigTransformationWithDataServices().

TYPE_STATIC

const ilGlobalCache::TYPE_STATIC = 0

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

Referenced by ilGlobalCacheSetupAgent\getArrayToConfigTransformation(), ilServicesGlobalCacheTest\getSettings(), and ILIAS\Tests\GlobalCache\Setup\ilGlobalCacheSetupAgentTest\testGetArrayToConfigTransformationWithDataServices().

---

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

• Services/GlobalCache/classes/class.ilGlobalCache.php