Inheritance diagram for ilGlobalCacheSettingsAdapter:

Collaboration diagram for ilGlobalCacheSettingsAdapter:

Public Member Functions
	__construct (private readonly ?ilIniFile $client_ini=null, private readonly ?ilDBInterface $db=null)

	getConfig ()

	toConfig ()

	readFromIniFile (ilIniFile $client_ini)

	getNodesRepository ()

	storeToIniFile (ilIniFile $client_ini)

	setActive (bool $active)

	setService (string $service)

	addMemcachedNode (Node $node)

	getMemcachedNodes ()

	resetActivatedComponents ()

	activateAll ()

	addActivatedComponent (string $component)

Private Attributes
Config	$config = null
	@readonly More...

bool	$active = true

string	$service = Config::PHPSTATIC

array	$components = []

array	$nodes = []

Detailed Description

Author: Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

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

Constructor & Destructor Documentation

◆ __construct()

ilGlobalCacheSettingsAdapter::__construct	(	private readonly ?ilIniFile	$client_ini = `null`,
		private readonly ?ilDBInterface	$db = `null`
	)

Definition at line 40 of file class.ilGlobalCacheSettingsAdapter.php.

      {
        if ($this->client_ini !== null) {
            $this->readFromIniFile($this->client_ini);
        }
        $this->config = $this->toConfig();
    }

References readFromIniFile(), and toConfig().

Here is the call graph for this function:

Member Function Documentation

◆ activateAll()

ilGlobalCacheSettingsAdapter::activateAll ( )

Definition at line 151 of file class.ilGlobalCacheSettingsAdapter.php.

                                 : void
    {
        $this->components = ['*'];
    }

◆ addActivatedComponent()

ilGlobalCacheSettingsAdapter::addActivatedComponent ( string $component )

Definition at line 156 of file class.ilGlobalCacheSettingsAdapter.php.

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

◆ addMemcachedNode()

ilGlobalCacheSettingsAdapter::addMemcachedNode ( Node $node )

Definition at line 136 of file class.ilGlobalCacheSettingsAdapter.php.

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

Referenced by readFromIniFile().

Here is the caller graph for this function:

◆ getConfig()

ilGlobalCacheSettingsAdapter::getConfig ( )

Definition at line 50 of file class.ilGlobalCacheSettingsAdapter.php.

                               : Config
    {
        return $this->config ?? $this->toConfig();
    }

References toConfig().

Here is the call graph for this function:

◆ getMemcachedNodes()

ilGlobalCacheSettingsAdapter::getMemcachedNodes ( )

Definition at line 141 of file class.ilGlobalCacheSettingsAdapter.php.

                                       : array
    {
        return $this->nodes;
    }

References $nodes.

◆ getNodesRepository()

ilGlobalCacheSettingsAdapter::getNodesRepository ( )

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

                                        : ilMemcacheNodesRepository
    {
        return new ilMemcacheNodesRepository($this->db);
    }

Referenced by readFromIniFile(), storeToIniFile(), and toConfig().

Here is the caller graph for this function:

◆ readFromIniFile()

ilGlobalCacheSettingsAdapter::readFromIniFile ( ilIniFile $client_ini )

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

                                                          : bool
    {
        $this->active = (bool) $client_ini->readVariable('cache', 'activate_global_cache');
        $service_type = $client_ini->readVariable('cache', 'global_cache_service_type');
        if (is_numeric($service_type)) {
            $service_type = match ((int) $service_type) {
                0 => Config::PHPSTATIC,
                2 => Config::MEMCACHED,
                3 => Config::APCU,
                default => Config::PHPSTATIC,
            };
        }
        $this->service = $service_type;
        $read_group = $client_ini->readGroup('cache_activated_components');
 
        $this->components = array_unique(
            array_map(static function (string $component): string {
                if ($component === 'all') {
                    return '*';
                }
                return $component;
            }, array_keys($read_group))
        );
        $this->nodes = [];
        if ($this->db !== null) {
            $repo = $this->getNodesRepository();
            foreach ($repo->getNodes() as $node) {
                $this->addMemcachedNode($node);
            }
        }
 
        return true;
    }

References addMemcachedNode(), and getNodesRepository().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetActivatedComponents()

ilGlobalCacheSettingsAdapter::resetActivatedComponents ( )

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

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

◆ setActive()

ilGlobalCacheSettingsAdapter::setActive ( bool $active )

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

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

References $active.

◆ setService()

ilGlobalCacheSettingsAdapter::setService ( string $service )

Definition at line 131 of file class.ilGlobalCacheSettingsAdapter.php.

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

References $service.

◆ storeToIniFile()

ilGlobalCacheSettingsAdapter::storeToIniFile ( ilIniFile $client_ini )

Definition at line 104 of file class.ilGlobalCacheSettingsAdapter.php.

                                                         : bool
    {
        $client_ini->setVariable('cache', 'activate_global_cache', $this->active ? '1' : '0');
        $client_ini->setVariable('cache', 'global_cache_service_type', $this->service);
        $client_ini->removeGroup('cache_activated_components');
        $client_ini->addGroup('cache_activated_components');
        foreach ($this->components as $component) {
            $client_ini->setVariable('cache_activated_components', $component, '1');
        }
 
        // store nodes to db
        if ($this->db !== null) {
            $repo = $this->getNodesRepository();
            $repo->deleteAll();
            foreach ($this->nodes as $node) {
                $repo->store($node);
            }
        }
 
        return $client_ini->write();
    }

References getNodesRepository(), and ilIniFile\write().

Here is the call graph for this function:

◆ toConfig()

ilGlobalCacheSettingsAdapter::toConfig ( )

Definition at line 55 of file class.ilGlobalCacheSettingsAdapter.php.

                              : Config
    {
        return new Config(
            $this->service,
            $this->active,
            $this->components,
            $this->getNodesRepository()
        );
    }