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 ()

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ checkSettings()

ilGlobalCache::checkSettings ( )

protected

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

References getSettings(), and setSettings().

Referenced by __construct().

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

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

References isActive().

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

Here is the call graph for this function:

◆ exists()

ilGlobalCache::exists ( $key )

Parameters

$key

Exceptions

RuntimeException

Returns: bool

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

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

◆ flush()

ilGlobalCache::flush ( $complete = false )

Parameters

bool $complete

Returns: bool

Exceptions

RuntimeException

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

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

◆ generateServiceId()

static ilGlobalCache::generateServiceId ( )

staticprotected

Returns: string

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

References ilGlobalCacheSettings\LOG_LEVEL_NORMAL.

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

◆ get()

ilGlobalCache::get ( $key )

Parameters

$key

Exceptions

RuntimeException

Returns: mixed

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

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

                                   {
                 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:

◆ getActive()

ilGlobalCache::getActive ( )

Returns: boolean

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

References $active.

Referenced by isActive().

                                     {
                 return $this->active;
         }

Here is the caller graph for this function:

◆ getActiveComponents()

static ilGlobalCache::getActiveComponents ( )

static

Returns: array

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

                                                      {
                 return self::$active_components;
         }

◆ getAllInstallableTypes()

static ilGlobalCache::getAllInstallableTypes ( )

static

Returns: ilGlobalCache[]

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

References $types.

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

◆ getAllTypes()

static ilGlobalCache::getAllTypes ( )

static

Returns: ilGlobalCache[]

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

References $types.

Referenced by ilSetupGUI\displayDatabase().

                                              {
                 $types = array();
                 foreach (self::$types as $type) {
                         $obj = new self($type);
                         $obj->initCachingService();
                         $types[$type] = $obj;
                 }
 
                 return $types;
         }

Here is the caller graph for this function:

◆ getAvailableComponents()

static ilGlobalCache::getAvailableComponents ( )

static

Returns: array

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

Referenced by ilSetupGUI\displayDatabase(), and ilGlobalCacheSettings\writeToIniFile().

                                                         {
                 return self::$available_components;
         }

Here is the caller graph for this function:

◆ getComponent()

ilGlobalCache::getComponent ( )

Returns: string

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

References $component.

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

                                        {
                 return $this->component;
         }

Here is the caller graph for this function:

◆ getInfo()

ilGlobalCache::getInfo ( )

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

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

◆ getInstallationFailureReason()

ilGlobalCache::getInstallationFailureReason ( )

Returns: string

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

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

◆ getInstance()

static ilGlobalCache::getInstance ( $component )

static

Parameters

null $component

Returns: ilGlobalCache

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

References $component, and $service_type.

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

                                                        {
                 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 caller graph for this function:

◆ getServiceType()

ilGlobalCache::getServiceType ( )

Returns: int

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

References $service_type.

Referenced by __construct(), and get().

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

Here is the caller graph for this function:

◆ getSettings()

static ilGlobalCache::getSettings ( )

static

Returns: ilGlobalCacheSettings

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

Referenced by checkSettings().

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

Here is the caller graph for this function:

◆ isActive()

ilGlobalCache::isActive ( )

Returns: bool

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isCacheServiceInstallable()

ilGlobalCache::isCacheServiceInstallable ( )

Returns: bool

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

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

◆ isInstallable()

ilGlobalCache::isInstallable ( )

Returns: bool

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

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

◆ isValid()

ilGlobalCache::isValid ( $key )

Parameters

$key

Returns: bool

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

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

◆ log()

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

static

Parameters

$message

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

References $ilLog.

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

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

Here is the caller graph for this function:

◆ lookupServiceClassName()

static ilGlobalCache::lookupServiceClassName ( $service_type )

static

Parameters

$service_type

Returns: string

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

References $service_type.

Referenced by ilGlobalCacheSettings\__toString().

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

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

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

                                                        {
                 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:

◆ setActive()

ilGlobalCache::setActive ( $active )

Parameters

boolean $active

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

References $active.

Referenced by __construct().

                                            {
                 $this->active = $active;
         }

Here is the caller graph for this function:

◆ setActiveComponents()

static ilGlobalCache::setActiveComponents ( $active_components )

static

Parameters

array $active_components

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

References $active_components.

                                                                        {
                 self::$active_components = $active_components;
         }

◆ setAvailableComponents()

static ilGlobalCache::setAvailableComponents ( $available_components )

static

Parameters

array $available_components

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

References $available_components.

                                                                              {
                 self::$available_components = $available_components;
         }

◆ setComponent()

ilGlobalCache::setComponent ( $component )

Parameters

string $component

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

References $component.

Referenced by __construct().

                                                  {
                 $this->component = $component;
         }

Here is the caller graph for this function:

◆ setServiceType()

ilGlobalCache::setServiceType ( $service_type )

Parameters

int $service_type

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

References $service_type.

Referenced by __construct().

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

Here is the caller graph for this function:

◆ setSettings()

static ilGlobalCache::setSettings ( $settings )

static

Parameters

ilGlobalCacheSettings $settings

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

References $settings.

Referenced by checkSettings().

                                                       {
                 self::$settings = $settings;
         }

Here is the caller graph for this function:

◆ setup()

static ilGlobalCache::setup ( ilGlobalCacheSettings $ilGlobalCacheSettings )

static

Parameters

ilGlobalCacheSettings $ilGlobalCacheSettings

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

References ilGlobalCacheSettings\getActivatedComponents().

Referenced by ilInitialisation\initClientIniFile().

                                                                                    {
                 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

ilGlobalCache::$active = true

protected

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

Referenced by getActive(), and setActive().

◆ $active_cache

ilGlobalCache::$active_cache = array()

staticprotected

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

◆ $active_components

ilGlobalCache::$active_components = array()

staticprotected

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

Referenced by 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 49 of file class.ilGlobalCache.php.

Referenced by setAvailableComponents().

◆ $component

ilGlobalCache::$component

protected

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

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

◆ $global_cache

ilGlobalCache::$global_cache

protected

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

◆ $instances

ilGlobalCache::$instances

staticprotected

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

◆ $service_type

ilGlobalCache::$service_type = ilGlobalCache::TYPE_STATIC

protected

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

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

◆ $settings

ilGlobalCache::$settings

staticprotected

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

Referenced by setSettings().

◆ $type_per_component

ilGlobalCache::$type_per_component = array()

staticprotected

Definition at line 62 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 66 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.

◆ 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 ilSetupGUI\displayDatabase().

◆ 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.

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

◆ $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