Inheritance diagram for ilGlobalCacheSettings:

Collaboration diagram for ilGlobalCacheSettings:

Public Member Functions
	readFromIniFile (ilIniFile $ilIniFile)

	writeToIniFile (ilIniFile $ilIniFile)

	activateAll ()

	addActivatedComponent ($component)

	resetActivatedComponents ()

	isComponentActivated ($component)

	areAllComponentActivated ()

	getService ()

	setService ($service)

	getActivatedComponents ()

	setActivatedComponents ($activated_components)

	isActive ()

	setActive ($active)

	getLogLevel ()

	setLogLevel ($log_level)

	__toString ()

	addMemcachedNode (ilMemcacheServer $node_id)

	getMemcachedNodes ()

Data Fields
const	LOG_LEVEL_FORCED = -1

const	LOG_LEVEL_NONE = 0

const	LOG_LEVEL_SHY = 1

const	LOG_LEVEL_NORMAL = 2

const	LOG_LEVEL_CHATTY = 3

const	INI_HEADER_CACHE = 'cache'

const	INI_FIELD_ACTIVATE_GLOBAL_CACHE = 'activate_global_cache'

const	INI_FIELD_GLOBAL_CACHE_SERVICE_TYPE = 'global_cache_service_type'

const	INI_HEADER_CACHE_ACTIVATED_COMPONENTS = 'cache_activated_components'

const	INI_FIELD_LOG_LEVEL = 'log_level'

Protected Member Functions
	checkIniHeader (ilIniFile $ilIniFile)

	getLogLevelName ()

	lookupLogLevelName ($level)

Protected Attributes
	$service = ilGlobalCache::TYPE_STATIC

	$activated_components = array()

	$active = false

	$log_level = self::LOG_LEVEL_NONE

	$memcached_nodes = []

Detailed Description

Class ilGlobalCacheSettings.

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

Version: 1.0.0

Definition at line 12 of file class.ilGlobalCacheSettings.php.

Member Function Documentation

◆ __toString()

ilGlobalCacheSettings::__toString ( )

Definition at line 220 of file class.ilGlobalCacheSettings.php.

References $log_level, $service, getActivatedComponents(), getLogLevelName(), getService(), and ilGlobalCache\lookupServiceClassName().

Referenced by writeToIniFile().

     {
         $service = 'Service: ' . ($this->getService() > 0 ? ilGlobalCache::lookupServiceClassName($this->getService()) : 'none');
         $activated = 'Activated Components: ' . implode(', ', $this->getActivatedComponents());
         $log_level = 'Log Level: ' . $this->getLogLevelName();
 
         return implode("\n", array( '', '', $service, $activated, $log_level, '' ));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ activateAll()

ilGlobalCacheSettings::activateAll ( )

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

References addActivatedComponent(), and ilGlobalCache\getAvailableComponents().

     {
         foreach (ilGlobalCache::getAvailableComponents() as $comp) {
             $this->addActivatedComponent($comp);
         }
     }

Here is the call graph for this function:

◆ addActivatedComponent()

ilGlobalCacheSettings::addActivatedComponent ( $component )

Parameters

$component

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

Referenced by activateAll(), and readFromIniFile().

     {
         $this->activated_components[] = $component;
         $this->activated_components = array_unique($this->activated_components);
     }

Here is the caller graph for this function:

◆ addMemcachedNode()

ilGlobalCacheSettings::addMemcachedNode ( ilMemcacheServer $node_id )

Definition at line 256 of file class.ilGlobalCacheSettings.php.

                                                                 : void
     {
         $this->memcached_nodes[] = $node_id;
     }

◆ areAllComponentActivated()

ilGlobalCacheSettings::areAllComponentActivated ( )

Returns: bool

Definition at line 128 of file class.ilGlobalCacheSettings.php.

References ilGlobalCache\getAvailableComponents().

     {
         return count($this->activated_components) == count(ilGlobalCache::getAvailableComponents());
     }

Here is the call graph for this function:

◆ checkIniHeader()

ilGlobalCacheSettings::checkIniHeader ( ilIniFile $ilIniFile )

protected

Parameters

ilIniFile $ilIniFile

Definition at line 191 of file class.ilGlobalCacheSettings.php.

References ilIniFile\addGroup(), and ilIniFile\readGroup().

Referenced by readFromIniFile().

     {
         if (!$ilIniFile->readGroup(self::INI_HEADER_CACHE)) {
             $ilIniFile->addGroup(self::INI_HEADER_CACHE);
         }
         if (!$ilIniFile->readGroup(self::INI_HEADER_CACHE_ACTIVATED_COMPONENTS)) {
             $ilIniFile->addGroup(self::INI_HEADER_CACHE_ACTIVATED_COMPONENTS);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActivatedComponents()

ilGlobalCacheSettings::getActivatedComponents ( )

Returns: array

Definition at line 155 of file class.ilGlobalCacheSettings.php.

References $activated_components.

Referenced by __toString(), and ilGlobalCache\setup().

     {
         return $this->activated_components;
     }

Here is the caller graph for this function:

◆ getLogLevel()

ilGlobalCacheSettings::getLogLevel ( )

Returns: int

Definition at line 205 of file class.ilGlobalCacheSettings.php.

References $log_level.

Referenced by getLogLevelName(), and writeToIniFile().

     {
         return $this->log_level;
     }

Here is the caller graph for this function:

◆ getLogLevelName()

ilGlobalCacheSettings::getLogLevelName ( )

protected

Returns: string

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

References getLogLevel(), and lookupLogLevelName().

Referenced by __toString().

     {
         return $this->lookupLogLevelName($this->getLogLevel());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMemcachedNodes()

ilGlobalCacheSettings::getMemcachedNodes ( )

Returns: ilMemcacheServer[]

Definition at line 264 of file class.ilGlobalCacheSettings.php.

References $memcached_nodes.

                                         : array
     {
         return $this->memcached_nodes;
     }

◆ getService()

ilGlobalCacheSettings::getService ( )

Returns: int

Definition at line 137 of file class.ilGlobalCacheSettings.php.

References $service.

Referenced by __toString(), and writeToIniFile().

     {
         return $this->service;
     }

Here is the caller graph for this function:

◆ isActive()

ilGlobalCacheSettings::isActive ( )

Returns: boolean

Definition at line 173 of file class.ilGlobalCacheSettings.php.

References $active.

Referenced by readFromIniFile(), and writeToIniFile().

     {
         return $this->active;
     }

Here is the caller graph for this function:

◆ isComponentActivated()

ilGlobalCacheSettings::isComponentActivated ( $component )

Parameters

$component

Returns: bool

Definition at line 119 of file class.ilGlobalCacheSettings.php.

Referenced by writeToIniFile().

     {
         return in_array($component, $this->activated_components);
     }

Here is the caller graph for this function:

◆ lookupLogLevelName()

ilGlobalCacheSettings::lookupLogLevelName ( $level )

protected

Parameters

$level

Returns: string

Definition at line 244 of file class.ilGlobalCacheSettings.php.

Referenced by getLogLevelName().

     {
         $r = new ReflectionClass($this);
         foreach ($r->getConstants() as $k => $v) {
             if (strpos($k, 'LOG_LEVEL') === 0 and $v == $level) {
                 return $k;
             }
         }
 
         return '';
     }

Here is the caller graph for this function:

◆ readFromIniFile()

ilGlobalCacheSettings::readFromIniFile ( ilIniFile $ilIniFile )

Parameters

ilIniFile $ilIniFile

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

References addActivatedComponent(), checkIniHeader(), isActive(), ilIniFile\readGroup(), ilIniFile\readVariable(), resetActivatedComponents(), setActive(), setLogLevel(), and setService().

     {
         $this->checkIniHeader($ilIniFile);
         $this->setActive($ilIniFile->readVariable(self::INI_HEADER_CACHE, self::INI_FIELD_ACTIVATE_GLOBAL_CACHE));
         $this->setService($ilIniFile->readVariable(self::INI_HEADER_CACHE, self::INI_FIELD_GLOBAL_CACHE_SERVICE_TYPE));
         $this->setLogLevel($ilIniFile->readVariable(self::INI_HEADER_CACHE, self::INI_FIELD_LOG_LEVEL));
         if (!$this->isActive()) {
             $this->resetActivatedComponents();
         } else {
             $cache_components = $ilIniFile->readGroup(self::INI_HEADER_CACHE_ACTIVATED_COMPONENTS);
             if (is_array($cache_components)) {
                 foreach ($cache_components as $comp => $v) {
                     if ($v) {
                         $this->addActivatedComponent($comp);
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

◆ resetActivatedComponents()

ilGlobalCacheSettings::resetActivatedComponents ( )

Definition at line 108 of file class.ilGlobalCacheSettings.php.

Referenced by readFromIniFile().

     {
         $this->activated_components = array();
     }

Here is the caller graph for this function:

◆ setActivatedComponents()

ilGlobalCacheSettings::setActivatedComponents ( $activated_components )

Parameters

array $activated_components

Definition at line 164 of file class.ilGlobalCacheSettings.php.

References $activated_components.

     {
         $this->activated_components = $activated_components;
     }

◆ setActive()

ilGlobalCacheSettings::setActive ( $active )

Parameters

boolean $active

Definition at line 182 of file class.ilGlobalCacheSettings.php.

References $active.

Referenced by readFromIniFile().

     {
         $this->active = $active;
     }

Here is the caller graph for this function:

◆ setLogLevel()

ilGlobalCacheSettings::setLogLevel ( $log_level )

Parameters

int $log_level

Definition at line 214 of file class.ilGlobalCacheSettings.php.

References $log_level.

Referenced by readFromIniFile().

     {
         $this->log_level = $log_level;
     }

Here is the caller graph for this function:

◆ setService()

ilGlobalCacheSettings::setService ( $service )

Parameters

int $service

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

References $service.

Referenced by readFromIniFile().

     {
         $this->service = $service;
     }

Here is the caller graph for this function:

◆ writeToIniFile()

ilGlobalCacheSettings::writeToIniFile ( ilIniFile $ilIniFile )

Parameters

ilIniFile $ilIniFile

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

References __toString(), ilIniFile\addGroup(), ilGlobalCache\getAvailableComponents(), getLogLevel(), getService(), isActive(), isComponentActivated(), ilGlobalCache\log(), ilIniFile\removeGroup(), ilIniFile\setVariable(), and ilIniFile\write().

     {
         $ilIniFile->setVariable(self::INI_HEADER_CACHE, self::INI_FIELD_ACTIVATE_GLOBAL_CACHE, $this->isActive() ? '1' : '0');
         $ilIniFile->setVariable(self::INI_HEADER_CACHE, self::INI_FIELD_GLOBAL_CACHE_SERVICE_TYPE, $this->getService());
         $ilIniFile->setVariable(self::INI_HEADER_CACHE, self::INI_FIELD_LOG_LEVEL, $this->getLogLevel());
 
         $ilIniFile->removeGroup(self::INI_HEADER_CACHE_ACTIVATED_COMPONENTS);
         $ilIniFile->addGroup(self::INI_HEADER_CACHE_ACTIVATED_COMPONENTS);
         foreach (ilGlobalCache::getAvailableComponents() as $comp) {
             $ilIniFile->setVariable(self::INI_HEADER_CACHE_ACTIVATED_COMPONENTS, $comp, $this->isComponentActivated($comp) ? '1' : '0');
         }
         if ($ilIniFile->write()) {
             ilGlobalCache::log('saved new settings: ' . $this->__toString(), self::LOG_LEVEL_FORCED);
         }
     }