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
	getMemcachedServer (array $node)

Protected Attributes
ILIAS Refinery Factory	$refinery

Detailed Description

Definition at line 26 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

◆ getArrayToConfigTransformation()

ilGlobalCacheSetupAgent::getArrayToConfigTransformation ( )

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

References $data, ILIAS\LTI\ToolProvider\$settings, getMemcachedServer(), ILIAS\Repository\refinery(), ilGlobalCache\TYPE_APC, ilGlobalCache\TYPE_MEMCACHED, and ilGlobalCache\TYPE_STATIC.

                                                     : Refinery\Transformation
     {
         return $this->refinery->custom()->transformation(function ($data): \ilGlobalCacheSettings {
             $settings = new \ilGlobalCacheSettings();
             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(\ilGlobalCache::TYPE_STATIC);
                         break;
                     case "memcached":
                         array_walk($data["memcached_nodes"], function (array $node) use ($settings): void {
                             $settings->addMemcachedNode($this->getMemcachedServer($node));
                         });
                         $settings->setService(\ilGlobalCache::TYPE_MEMCACHED);
                         break;
                     case "apc":
                         $settings->setService(\ilGlobalCache::TYPE_APC);
                         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 137 of file class.ilGlobalCacheSetupAgent.php.

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

◆ getInstallObjective()

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

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

References $config.

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

◆ getMemcachedServer()

ilGlobalCacheSetupAgent::getMemcachedServer ( array $node )

protected

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

References ilMemcacheServer\STATUS_ACTIVE, and ilMemcacheServer\STATUS_INACTIVE.

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

                                                       : ilMemcacheServer
     {
         $m = new ilMemcacheServer();
         $m->setStatus(boolval($node["active"]) === true ? ilMemcacheServer::STATUS_ACTIVE : ilMemcacheServer::STATUS_INACTIVE);
         $m->setHost((string) $node["host"]);
         $m->setPort((int) $node["port"]);
         $m->setWeight((int) $node["weight"]);
 
         return $m;
     }

Here is the caller graph for this function:

◆ getMigrations()

ilGlobalCacheSetupAgent::getMigrations ( )

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

                                    : array
     {
         return [];
     }

◆ getNamedObjectives()

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

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

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

◆ getStatusObjective()

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

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

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

◆ getUpdateObjective()

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

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

References $config.

                                                                    : Setup\Objective
     {
         if ($config instanceof ilGlobalCacheSettings) {
             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