ilGlobalCacheSetupAgent Class Reference

Inheritance diagram for ilGlobalCacheSetupAgent:

Collaboration diagram for ilGlobalCacheSetupAgent:

Public Member Functions
	__construct (protected Factory $refinery)
	hasConfig ()
	Does this agent require a configuration? More...
	getArrayToConfigTransformation ()
	Agents must be able to tell how to create a configuration from a nested array. Exceptions LogicException if Agent has no Config More...
	getInstallObjective (?Config $config=null)
	getUpdateObjective (?Config $config=null)
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. Exceptions InvalidArgumentException if Config does not match the Agent. More...
	getStatusObjective (Storage $storage)
	getMigrations ()
	getNamedObjectives (?Config $config=null)
Public Member Functions inherited from ILIAS\Setup\Agent
	getInstallObjective (?Config $config=null)
	Get the goals the agent wants to achieve on setup. More...
	getUpdateObjective (?Config $config=null)
	Get the goal the agent wants to achieve on update. More...
	getStatusObjective (Metrics\Storage $storage)
	Get the objective to be achieved when status is requested. More...
	getNamedObjectives (?Config $config=null)
	Gets all named objectives The keys of the returned array are the commands. More...

Protected Member Functions
	convertNode (array $node)

Detailed Description

Definition at line 32 of file class.ilGlobalCacheSetupAgent.php.

Constructor & Destructor Documentation

__construct()

ilGlobalCacheSetupAgent::__construct

(

protected Factory

$refinery

)

Definition at line 34 of file class.ilGlobalCacheSetupAgent.php.

    {
    }

Member Function Documentation

convertNode()

ilGlobalCacheSetupAgent::convertNode ( array  $node )

protected

Definition at line 102 of file class.ilGlobalCacheSetupAgent.php.

Referenced by getArrayToConfigTransformation(), and ILIAS\Tests\GlobalCache\Setup\TestObj\getMServer().

                                               : Node
    {
        return new Node(
            (string) $node["host"],
            (int) $node["port"],
            (int) $node["weight"]
        );
    }

Here is the caller graph for this function:

getArrayToConfigTransformation()

ilGlobalCacheSetupAgent::getArrayToConfigTransformation

(

)

Agents must be able to tell how to create a configuration from a nested array.

Exceptions

LogicException

if Agent has no Config

Implements ILIAS\Setup\Agent.

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

References $data, convertNode(), null, and ILIAS\Repository\refinery().

                                                    : Transformation
    {
        return $this->refinery->custom()->transformation(function ($data): \ilGlobalCacheSettingsAdapter {
            $settings = new \ilGlobalCacheSettingsAdapter();
            if (
                $data === null ||
                !isset($data["components"]) ||
                !$data["components"] ||
                !isset($data["service"]) ||
                $data["service"] === "none" ||
                (
                    $data["service"] === "memcached" &&
                    (!isset($data["memcached_nodes"]) || count($data["memcached_nodes"]) === 0)
                )
            ) {
                $settings->setActive(false);
            } else {
                $settings->setActive(true);
                switch ($data["service"]) {
                    case "xcache": // xcache has been removed in ILIAS 8, we switch to static cache then
                    case "static":
                        $settings->setService(\ILIAS\Cache\Config::PHPSTATIC);
                        break;
                    case "memcached":
                        array_walk($data["memcached_nodes"], function (array $node) use ($settings): void {
                            $settings->addMemcachedNode($this->convertNode($node));
                        });
                        $settings->setService(\ILIAS\Cache\Config::MEMCACHED);
                        break;
                    case "apc":
                        $settings->setService(\ILIAS\Cache\Config::APCU);
                        break;
                    default:
                        throw new \InvalidArgumentException(
                            sprintf("Unknown caching service: '%s'", $data["service"])
                        );
                }
                $settings->resetActivatedComponents();
                if ($data["components"] === "all") {
                    $settings->activateAll();
                } else {
                    foreach ($data["components"] as $cmp => $active) {
                        if ($active) {
                            $settings->addActivatedComponent($cmp);
                        }
                    }
                }
            }

            return $settings;
        });
    }

Here is the call graph for this function:

getBuildObjective()

ilGlobalCacheSetupAgent::getBuildObjective

(

)

Get the goal the agent wants to achieve to build artifacts.

Exceptions

InvalidArgumentException

if Config does not match the Agent.

Implements ILIAS\Setup\Agent.

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

                                       : Objective
    {
        return new NullObjective();
    }

getInstallObjective()

ilGlobalCacheSetupAgent::getInstallObjective

(

?Config

$config = null

)

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

                                                               : Objective
    {
        if (!$config instanceof ilGlobalCacheSettingsAdapter) {
            throw new UnachievableException('wrong config type, expected ilGlobalCacheSettings');
        }
        return new ilGlobalCacheConfigStoredObjective($config);
    }

getMigrations()

ilGlobalCacheSetupAgent::getMigrations

(

)

Implements ILIAS\Setup\Agent.

Definition at line 152 of file class.ilGlobalCacheSetupAgent.php.

                                   : array
    {
        return [];
    }

getNamedObjectives()

ilGlobalCacheSetupAgent::getNamedObjectives

(

?Config

$config = null

)

Definition at line 157 of file class.ilGlobalCacheSetupAgent.php.

                                                              : array
    {
        $config ??= new ilGlobalCacheSettingsAdapter();
        return [
            'flushAll' => new ObjectiveConstructor(
                'flushes all GlobalCaches.',
                fn(): \ilGlobalCacheAllFlushedObjective => new ilGlobalCacheAllFlushedObjective($config)
            )
        ];
    }

getStatusObjective()

ilGlobalCacheSetupAgent::getStatusObjective

(

Storage

$storage

)

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

                                                        : Objective
    {
        return new ilGlobalCacheMetricsCollectedObjective($storage);
    }

getUpdateObjective()

ilGlobalCacheSetupAgent::getUpdateObjective

(

?Config

$config = null

)

Definition at line 125 of file class.ilGlobalCacheSetupAgent.php.

                                                              : Objective
    {
        if ($config instanceof ilGlobalCacheSettingsAdapter) {
            return new ilGlobalCacheConfigStoredObjective($config);
        }
        return new NullObjective();
    }

hasConfig()

ilGlobalCacheSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 41 of file class.ilGlobalCacheSetupAgent.php.

                               : bool
    {
        return true;
    }

---

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

• components/ILIAS/GlobalCache_/classes/Setup/class.ilGlobalCacheSetupAgent.php