Collaboration diagram for ilGlobalCache:

Public Member Functions
	isActive ()

	isValid ($key)

	isInstallable ()

	isCacheServiceInstallable ()

	getInstallationFailureReason ()

	exists ($key)

	set ($key, $value, $ttl=null)

	get ($key)

	delete ($key)

	flush ($complete=false)

	getInfo ()

	setComponent ($component)

	getComponent ()

	setActive ($active)

	getActive ()

	setServiceType ($service_type)

	getServiceType ()

Static Public Member Functions
static	setup (ilGlobalCacheSettings $ilGlobalCacheSettings)

static	getInstance ($component)

static	log ($message, $log_level)

static	getAllInstallableTypes ()

static	getAllTypes ($only_available=true)

static	lookupServiceClassName ($service_type)

static	getSettings ()

static	setSettings ($settings)

static	getActiveComponents ()

static	setActiveComponents ($active_components)

static	getAvailableComponents ()

static	setAvailableComponents ($available_components)

Data Fields
const	MSG = 'Global Cache not active, can not access cache'

const	ACTIVE = true

const	TYPE_STATIC = 0

const	TYPE_XCACHE = 1

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_COMPONENT = 'comp'

const	COMP_RBAC_UA = 'rbac_ua'

const	COMP_EVENTS = 'events'

const	COMP_TPL_BLOCKS = 'tpl_blocks'

const	COMP_TPL_VARIABLES = 'tpl_variables'

Protected Member Functions
	__construct ($service_type)

	checkSettings ()

Static Protected Member Functions
static	generateServiceId ()

Protected Attributes
	$global_cache

	$component

	$active = true

	$service_type = ilGlobalCache::TYPE_STATIC

Static Protected Attributes
static	$types

static	$available_types

static	$active_components = array()

static	$available_components

static	$type_per_component = array()

static	$unique_service_id = null

static	$instances

static	$settings

static	$active_cache = array()

Detailed Description

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 14 of file class.ilGlobalCache.php.

Constructor & Destructor Documentation

◆ __construct()

ilGlobalCache::__construct ( $service_type )

protected

Parameters

$service_type

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

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

References $service_type, checkSettings(), generateServiceId(), and setServiceType().

Here is the call graph for this function:

Member Function Documentation

◆ checkSettings()

ilGlobalCache::checkSettings ( )

protected

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

    {
        if (!$this->getSettings() instanceof ilGlobalCacheSettings) {
            $ilGlobalCacheSettings = new ilGlobalCacheSettings();
            $this->setSettings($ilGlobalCacheSettings);
        }
    }

References getSettings(), and setSettings().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilGlobalCache::delete ( $key )

Parameters

$key

Returns: bool

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

    {
        if (!$this->isActive()) {
            return false;
        }
 
        return $this->global_cache->delete($key);
    }

References $key, and isActive().

Here is the call graph for this function:

◆ exists()

ilGlobalCache::exists ( $key )

Parameters

$key

Exceptions

RuntimeException

Returns: bool

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

    {
        if (!$this->global_cache->isActive()) {
            return false;
        }
 
        return $this->global_cache->exists($key);
    }

References $key.

◆ flush()

ilGlobalCache::flush ( $complete = false )

Parameters

bool $complete

Returns: bool

Exceptions

RuntimeException

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

    {
        if ($this->global_cache->isActive()) {
            return $this->global_cache->flush();
        }
 
        return false;
    }

◆ generateServiceId()

static ilGlobalCache::generateServiceId ( )

staticprotected

Returns: string

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

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

References defined.

Referenced by __construct().

Here is the caller graph for this function:

◆ get()

ilGlobalCache::get ( $key )

Parameters

$key

Exceptions

RuntimeException

Returns: mixed

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

    {
        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;
    }

References $key, getComponent(), getServiceType(), isActive(), log(), ilGlobalCacheSettings\LOG_LEVEL_CHATTY, and lookupServiceClassName().

Here is the call graph for this function:

◆ getActive()

ilGlobalCache::getActive ( )

Returns: boolean

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

    {
        return $this->active;
    }

References $active.

Referenced by isActive().

Here is the caller graph for this function:

◆ getActiveComponents()

static ilGlobalCache::getActiveComponents ( )

static

Returns: array

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

    {
        return self::$active_components;
    }

References $active_components.

◆ getAllInstallableTypes()

static ilGlobalCache::getAllInstallableTypes ( )

static

Returns: ilGlobalCache[]

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

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

References $type, and $types.

◆ getAllTypes()

static ilGlobalCache::getAllTypes ( $only_available = true )

static

Parameters

bool $only_available

Returns: array

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

    {
        $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;
    }

References $type, and $types.

◆ getAvailableComponents()

static ilGlobalCache::getAvailableComponents ( )

static

Returns: array

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

    {
        return self::$available_components;
    }

References $available_components.

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

Here is the caller graph for this function:

◆ getComponent()

ilGlobalCache::getComponent ( )

Returns: string

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

    {
        return $this->component;
    }

References $component.

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

Here is the caller graph for this function:

◆ getInfo()

ilGlobalCache::getInfo ( )

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

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

◆ getInstallationFailureReason()

ilGlobalCache::getInstallationFailureReason ( )

Returns: string

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

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

◆ getInstance()

static ilGlobalCache::getInstance ( $component )

static

Parameters

null $component

Returns: ilGlobalCache

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

    {
        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];
    }

References $component, $service_type, and getSettings().

Referenced by ilCachedComponentData\__construct(), ilCachedCtrl\__construct(), ilCachedComponentData\__destruct(), ilCachedComponentData\flush(), ilCachedCtrl\flush(), ilGlobalCacheQueryWrapper\get(), HTML_Template_IT\getFile(), ilCachedComponentData\getInstance(), ilCachedCtrl\getInstance(), HTML_Template_IT\init(), ilAppEventHandler\initListeners(), ilCachedCtrl\isActive(), and ilObjectDefinition\readDefinitionData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getServiceType()

ilGlobalCache::getServiceType ( )

Returns: int

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

    {
        if ($this->global_cache instanceof ilGlobalCacheService) {
            return $this->global_cache->getServiceType();
        }
 
        return $this->service_type;
    }

References $service_type.

Referenced by get().

Here is the caller graph for this function:

◆ getSettings()

static ilGlobalCache::getSettings ( )

static

Returns: ilGlobalCacheSettings

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

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

Referenced by checkSettings(), and getInstance().

Here is the caller graph for this function:

◆ isActive()

ilGlobalCache::isActive ( )

Returns: bool

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

    {
        if (self::$active_cache[$this->getComponent()] !== null) {
            return self::$active_cache[$this->getComponent()];
        }
        if (!self::ACTIVE) {
            self::$active_cache[$this->getComponent()] = false;
 
            return false;
        }
        if (!$this->getActive()) {
            self::log($this->getComponent() . '-wrapper is inactive...', ilGlobalCacheSettings::LOG_LEVEL_CHATTY);
            self::$active_cache[$this->getComponent()] = false;
 
            return false;
        }
 
        $isActive = $this->global_cache->isActive();
        self::log('component ' . $this->getComponent() . ', service is active: '
                  . ($isActive ? 'yes' : 'no'), ilGlobalCacheSettings::LOG_LEVEL_CHATTY);
        self::$active_cache[$this->getComponent()] = $isActive;
 
        return $isActive;
    }

References getActive(), getComponent(), log(), and ilGlobalCacheSettings\LOG_LEVEL_CHATTY.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isCacheServiceInstallable()

ilGlobalCache::isCacheServiceInstallable ( )

Returns: bool

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

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

◆ isInstallable()

ilGlobalCache::isInstallable ( )

Returns: bool

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

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

◆ isValid()

ilGlobalCache::isValid ( $key )

Parameters

$key

Returns: bool

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

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

References $key.

◆ log()

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

static

Parameters

$message

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

    {
        if ($log_level <= self::getSettings()->getLogLevel()) {
            global $DIC;
            $ilLog = $DIC['ilLog'];
            $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);
            }
        }
    }

References $DIC, $function, $ilLog, and $message.

Referenced by get(), HTML_Template_IT\init(), isActive(), set(), and ilGlobalCacheSettings\writeToIniFile().

Here is the caller graph for this function:

◆ lookupServiceClassName()

static ilGlobalCache::lookupServiceClassName ( $service_type )

static

Parameters

$service_type

Returns: string

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

    {
        switch ($service_type) {
            case self::TYPE_APC:
                return 'ilApc';
                break;
            case self::TYPE_MEMCACHED:
                return 'ilMemcache';
                break;
            case self::TYPE_XCACHE:
                return 'ilXcache';
                break;
            default:
                return 'ilStaticCache';
                break;
        }
    }

References $service_type, TYPE_APC, TYPE_MEMCACHED, and TYPE_XCACHE.

Referenced by ilGlobalCacheSettings\__toString(), and get().

Here is the caller graph for this function:

◆ set()

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

Parameters

	$key
	$value
null	$ttl

Exceptions

RuntimeException

Returns: bool

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

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

References $key, getComponent(), isActive(), log(), and ilGlobalCacheSettings\LOG_LEVEL_CHATTY.

Here is the call graph for this function:

◆ setActive()

ilGlobalCache::setActive ( $active )

Parameters

boolean $active

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

    {
        $this->active = $active;
    }

References $active.

◆ setActiveComponents()

static ilGlobalCache::setActiveComponents ( $active_components )

static

Parameters

array $active_components

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

    {
        self::$active_components = $active_components;
    }

References $active_components.

Referenced by setup().

Here is the caller graph for this function:

◆ setAvailableComponents()

static ilGlobalCache::setAvailableComponents ( $available_components )

static

Parameters

array $available_components

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

    {
        self::$available_components = $available_components;
    }

References $available_components.

◆ setComponent()

ilGlobalCache::setComponent ( $component )

Parameters

string $component

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

    {
        $this->component = $component;
    }

References $component.

◆ setServiceType()

ilGlobalCache::setServiceType ( $service_type )

Parameters

int $service_type

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

    {
        if ($this->global_cache instanceof ilGlobalCacheService) {
            $this->global_cache->setServiceType($service_type);
        }
        $this->service_type = $service_type;
    }

References $service_type.

Referenced by __construct().

Here is the caller graph for this function:

◆ setSettings()

static ilGlobalCache::setSettings ( $settings )

static

Parameters

ilGlobalCacheSettings $settings

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

    {
        self::$settings = $settings;
    }

References $settings.

Referenced by checkSettings(), and setup().

Here is the caller graph for this function:

◆ setup()

static ilGlobalCache::setup ( ilGlobalCacheSettings $ilGlobalCacheSettings )

static

Parameters

ilGlobalCacheSettings $ilGlobalCacheSettings

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

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

References ilGlobalCacheSettings\getActivatedComponents(), setActiveComponents(), and setSettings().

Referenced by ilInitialisation\initClientIniFile().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $active

ilGlobalCache::$active = true

protected

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

Referenced by getActive(), and setActive().

◆ $active_cache

ilGlobalCache::$active_cache = array()

staticprotected

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

◆ $active_components

ilGlobalCache::$active_components = array()

staticprotected

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

Referenced by getActiveComponents(), and setActiveComponents().

◆ $available_components

ilGlobalCache::$available_components

staticprotected

Initial value:

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

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

Referenced by getAvailableComponents(), and setAvailableComponents().

◆ $available_types

ilGlobalCache::$available_types

staticprotected

Initial value:

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

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

◆ $component

ilGlobalCache::$component

protected

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

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

◆ $global_cache

ilGlobalCache::$global_cache

protected

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

◆ $instances

ilGlobalCache::$instances

staticprotected

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

◆ $service_type

ilGlobalCache::$service_type = ilGlobalCache::TYPE_STATIC

protected

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

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

◆ $settings

ilGlobalCache::$settings

staticprotected

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

Referenced by setSettings().

◆ $type_per_component

ilGlobalCache::$type_per_component = array()

staticprotected

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

◆ $types

ilGlobalCache::$types

staticprotected

Initial value:

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

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

Referenced by getAllInstallableTypes(), and getAllTypes().

◆ $unique_service_id

ilGlobalCache::$unique_service_id = null

staticprotected

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

◆ ACTIVE

const ilGlobalCache::ACTIVE = true

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

◆ COMP_CLNG

const ilGlobalCache::COMP_CLNG = 'clng'

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

◆ COMP_COMPONENT

const ilGlobalCache::COMP_COMPONENT = 'comp'

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

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

◆ COMP_EVENTS

const ilGlobalCache::COMP_EVENTS = 'events'

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

Referenced by ilAppEventHandler\initListeners().

◆ COMP_ILCTRL

const ilGlobalCache::COMP_ILCTRL = 'ilctrl'

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

Referenced by ilCachedCtrl\__construct(), ilCachedCtrl\flush(), ilCachedCtrl\getInstance(), and ilCachedCtrl\isActive().

◆ COMP_OBJ_DEF

const ilGlobalCache::COMP_OBJ_DEF = 'obj_def'

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

◆ COMP_PLUGINS

const ilGlobalCache::COMP_PLUGINS = 'plugins'

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

◆ COMP_RBAC_UA

const ilGlobalCache::COMP_RBAC_UA = 'rbac_ua'

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

◆ COMP_TEMPLATE

const ilGlobalCache::COMP_TEMPLATE = 'tpl'

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

Referenced by HTML_Template_IT\getFile().

◆ COMP_TPL_BLOCKS

const ilGlobalCache::COMP_TPL_BLOCKS = 'tpl_blocks'

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

Referenced by HTML_Template_IT\init().

◆ COMP_TPL_VARIABLES

const ilGlobalCache::COMP_TPL_VARIABLES = 'tpl_variables'

Definition at line 32 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 16 of file class.ilGlobalCache.php.

◆ TYPE_APC

const ilGlobalCache::TYPE_APC = 3

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

Referenced by lookupServiceClassName().

◆ TYPE_FALLBACK

const ilGlobalCache::TYPE_FALLBACK = self::TYPE_STATIC

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

◆ TYPE_MEMCACHED

const ilGlobalCache::TYPE_MEMCACHED = 2

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

Referenced by lookupServiceClassName().

◆ TYPE_STATIC

const ilGlobalCache::TYPE_STATIC = 0

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

◆ TYPE_XCACHE

const ilGlobalCache::TYPE_XCACHE = 1

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

Referenced by lookupServiceClassName().

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

Services/GlobalCache/classes/class.ilGlobalCache.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkSettings()

◆ delete()

◆ exists()

◆ flush()

◆ generateServiceId()

◆ get()

◆ getActive()

◆ getActiveComponents()

◆ getAllInstallableTypes()

◆ getAllTypes()

◆ getAvailableComponents()

◆ getComponent()

◆ getInfo()

◆ getInstallationFailureReason()

◆ getInstance()

◆ getServiceType()

◆ getSettings()

◆ isActive()

◆ isCacheServiceInstallable()

◆ isInstallable()

◆ isValid()

◆ log()

◆ lookupServiceClassName()

◆ set()

◆ setActive()

◆ setActiveComponents()

◆ setAvailableComponents()

◆ setComponent()

◆ setServiceType()

◆ setSettings()

◆ setup()

Field Documentation

◆ $active

◆ $active_cache

◆ $active_components

◆ $available_components

◆ $available_types

◆ $component

◆ $global_cache

◆ $instances

◆ $service_type

◆ $settings

◆ $type_per_component

◆ $types

◆ $unique_service_id

◆ ACTIVE

◆ COMP_CLNG

◆ COMP_COMPONENT

◆ COMP_EVENTS

◆ COMP_ILCTRL

◆ COMP_OBJ_DEF

◆ COMP_PLUGINS

◆ COMP_RBAC_UA

◆ COMP_TEMPLATE

◆ COMP_TPL_BLOCKS

◆ COMP_TPL_VARIABLES

◆ MSG

◆ TYPE_APC

◆ TYPE_FALLBACK

◆ TYPE_MEMCACHED

◆ TYPE_STATIC

◆ TYPE_XCACHE