Inheritance diagram for ilGlobalCacheSetupAgent:

Collaboration diagram for ilGlobalCacheSetupAgent:

Public Member Functions
	__construct (Refinery\Factory $refinery)

	hasConfig ()

	getArrayToConfigTransformation ()

	getInstallObjective (Setup\Config $config=null)

	getUpdateObjective (Setup\Config $config=null)

	getBuildArtifactObjective ()

	getStatusObjective (Setup\Metrics\Storage $storage)

	getMigrations ()

	getNamedObjectives (?Config $config=null)

Protected Member Functions
	convertNode (array $node)

Protected Attributes
ILIAS Refinery Factory	$refinery

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilGlobalCacheSetupAgent::__construct ( Refinery\Factory $refinery )

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

References $refinery, and ILIAS\Repository\refinery().

       {
         $this->refinery = $refinery;
     }

Here is the call graph for this function:

Member Function Documentation

◆ convertNode()

ilGlobalCacheSetupAgent::convertNode ( array $node )

protected

Definition at line 101 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 ( )

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

References $data, ILIAS\LTI\ToolProvider\$settings, convertNode(), and ILIAS\Repository\refinery().

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

◆ getBuildArtifactObjective()

ilGlobalCacheSetupAgent::getBuildArtifactObjective ( )

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

                                                : Setup\Objective
     {
         return new Setup\Objective\NullObjective();
     }

◆ getInstallObjective()

ilGlobalCacheSetupAgent::getInstallObjective ( Setup\Config $config = null )

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

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

◆ getMigrations()

ilGlobalCacheSetupAgent::getMigrations ( )

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

                                    : array
     {
         return [];
     }

◆ getNamedObjectives()

ilGlobalCacheSetupAgent::getNamedObjectives ( ?Config $config = null )

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

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

◆ getStatusObjective()

ilGlobalCacheSetupAgent::getStatusObjective ( Setup\Metrics\Storage $storage )

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

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

◆ getUpdateObjective()

ilGlobalCacheSetupAgent::getUpdateObjective ( Setup\Config $config = null )

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

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

◆ hasConfig()

ilGlobalCacheSetupAgent::hasConfig ( )

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

                                : bool
     {
         return true;
     }

Field Documentation

◆ $refinery

ILIAS Refinery Factory ilGlobalCacheSetupAgent::$refinery