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 (int $service)

	getActivatedComponents ()

	setActivatedComponents (array $activated_components)

	isActive ()

	setActive (bool $active)

	getLogLevel ()

	setLogLevel (int $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 (int $level)

Protected Attributes
int	$service = ilGlobalCache::TYPE_STATIC

array	$activated_components = []

bool	$active = false

int	$log_level = self::LOG_LEVEL_NONE

array	$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 26 of file class.ilGlobalCacheSettings.php.

Member Function Documentation

◆ __toString()

ilGlobalCacheSettings::__toString ( )

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

                                : string
    {
        $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", ['', '', $service, $activated, $log_level, '']);
    }

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

Here is the call graph for this function:

◆ activateAll()

ilGlobalCacheSettings::activateAll ( )

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

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

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

Here is the call graph for this function:

◆ addActivatedComponent()

ilGlobalCacheSettings::addActivatedComponent ( $component )

Parameters

mixed $component

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

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

Referenced by activateAll(), and readFromIniFile().

Here is the caller graph for this function:

◆ addMemcachedNode()

ilGlobalCacheSettings::addMemcachedNode ( ilMemcacheServer $node_id )

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

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

◆ areAllComponentActivated()

ilGlobalCacheSettings::areAllComponentActivated ( )

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

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

References ilGlobalCache\getAvailableComponents().

Here is the call graph for this function:

◆ checkIniHeader()

ilGlobalCacheSettings::checkIniHeader ( ilIniFile $ilIniFile )

protected

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

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

Referenced by readFromIniFile().

Here is the caller graph for this function:

◆ getActivatedComponents()

ilGlobalCacheSettings::getActivatedComponents ( )

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

                                            : array
    {
        return $this->activated_components;
    }

References $activated_components.

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

Here is the caller graph for this function:

◆ getLogLevel()

ilGlobalCacheSettings::getLogLevel ( )

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

                                 : int
    {
        return $this->log_level;
    }

References $log_level.

Referenced by getLogLevelName(), and writeToIniFile().

Here is the caller graph for this function:

◆ getLogLevelName()

ilGlobalCacheSettings::getLogLevelName ( )

protected

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

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

References getLogLevel(), and lookupLogLevelName().

Referenced by __toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMemcachedNodes()

ilGlobalCacheSettings::getMemcachedNodes ( )

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

                                       : array
    {
        return $this->memcached_nodes;
    }

References $memcached_nodes.

◆ getService()

ilGlobalCacheSettings::getService ( )

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

                                : int
    {
        return $this->service;
    }

References $service.

Referenced by __toString(), and writeToIniFile().

Here is the caller graph for this function:

◆ isActive()

ilGlobalCacheSettings::isActive ( )

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

                              : bool
    {
        return $this->active;
    }

References $active.

Referenced by readFromIniFile(), and writeToIniFile().

Here is the caller graph for this function:

◆ isComponentActivated()

ilGlobalCacheSettings::isComponentActivated ( $component )

Parameters

mixed $component

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

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

Referenced by writeToIniFile().

Here is the caller graph for this function:

◆ lookupLogLevelName()

ilGlobalCacheSettings::lookupLogLevelName ( int $level )

protected

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

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

Referenced by getLogLevelName().

Here is the caller graph for this function:

◆ readFromIniFile()

ilGlobalCacheSettings::readFromIniFile ( ilIniFile $ilIniFile )

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

                                                         : void
    {
        $this->checkIniHeader($ilIniFile);
        $this->setActive(
            $ilIniFile->readVariable(
                self::INI_HEADER_CACHE,
                self::INI_FIELD_ACTIVATE_GLOBAL_CACHE
            )
        );
        $this->setService(
            (int)$ilIniFile->readVariable(
                self::INI_HEADER_CACHE,
                self::INI_FIELD_GLOBAL_CACHE_SERVICE_TYPE
            )
        );
        $this->setLogLevel(
            (int) $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);
                    }
                }
            }
        }
    }

References addActivatedComponent(), checkIniHeader(), isActive(), resetActivatedComponents(), setActive(), setLogLevel(), and setService().

Here is the call graph for this function:

◆ resetActivatedComponents()

ilGlobalCacheSettings::resetActivatedComponents ( )

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

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

Referenced by readFromIniFile().

Here is the caller graph for this function:

◆ setActivatedComponents()

ilGlobalCacheSettings::setActivatedComponents ( array $activated_components )

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

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

References $activated_components.

◆ setActive()

ilGlobalCacheSettings::setActive ( bool $active )

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

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

References $active.

Referenced by readFromIniFile().

Here is the caller graph for this function:

◆ setLogLevel()

ilGlobalCacheSettings::setLogLevel ( int $log_level )

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

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

References $log_level.

Referenced by readFromIniFile().

Here is the caller graph for this function:

◆ setService()

ilGlobalCacheSettings::setService ( int $service )

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

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

References $service.

Referenced by readFromIniFile().

Here is the caller graph for this function:

◆ writeToIniFile()

ilGlobalCacheSettings::writeToIniFile ( ilIniFile $ilIniFile )

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

                                                        : bool
    {
        $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'
            );
        }
        return $ilIniFile->write();
    }