ilGlobalCacheSetupAgent Class Reference

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 ()
	getNamedObjective (string $name, Setup\Config $config=null)

Protected Member Functions
	getMemcachedServer (array $node)

Protected Attributes
	$refinery

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilGlobalCacheSetupAgent::__construct

(

Refinery\Factory

$refinery

)

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

References $refinery.

      {
        $this->refinery = $refinery;
    }

Member Function Documentation

getArrayToConfigTransformation()

ilGlobalCacheSetupAgent::getArrayToConfigTransformation

(

)

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

References $data, getMemcachedServer(), ilGlobalCache\TYPE_APC, ilGlobalCache\TYPE_MEMCACHED, ilGlobalCache\TYPE_STATIC, and ilGlobalCache\TYPE_XCACHE.

                                                     : Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(function ($data) {
            $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 "static":
                        $settings->setService(\ilGlobalCache::TYPE_STATIC);
                        break;
                    case "xcache":
                        $settings->setService(\ilGlobalCache::TYPE_XCACHE);
                        break;
                    case "memcached":
                        array_walk($data["memcached_nodes"], function (array $node) use ($settings) {
                            $settings->addMemcachedNode($this->getMemcachedServer($node));
                        });
                        $settings->setService(\ilGlobalCache::TYPE_MEMCACHED);
                        break;
                    case "apc":
                        $settings->setService(\ilGlobalCache::TYPE_APC);
                        break;
                    default:
                        throw new \InvalidArgumentException(
                            "Unknown caching service: '{$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 120 of file class.ilGlobalCacheSetupAgent.php.

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

getInstallObjective()

ilGlobalCacheSetupAgent::getInstallObjective

(

Setup\Config

$config = null

)

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

References $config.

                                                                     : Setup\Objective
    {
        return new ilGlobalCacheConfigStoredObjective($config);
    }

getMemcachedServer()

ilGlobalCacheSetupAgent::getMemcachedServer ( array  $node )

protected

Definition at line 87 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 136 of file class.ilGlobalCacheSetupAgent.php.

                                    : array
    {
        return [];
    }

getNamedObjective()

ilGlobalCacheSetupAgent::getNamedObjective	(	string	$name,
		Setup\Config	$config = null
	)

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

                                                                                 : Setup\Objective
    {
        if ($name == "flushAll") {
            return new ilGlobalCacheAllFlushedObjective();
        }
        throw new InvalidArgumentException(
            "There is no named objective '$name'"
        );
    }

getStatusObjective()

ilGlobalCacheSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

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

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

getUpdateObjective()

ilGlobalCacheSetupAgent::getUpdateObjective

(

Setup\Config

$config = null

)

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

References $config.

                                                                    : Setup\Objective
    {
        if ($config !== null) {
            return new ilGlobalCacheConfigStoredObjective($config);
        }
        return new Setup\Objective\NullObjective();
    }

hasConfig()

ilGlobalCacheSetupAgent::hasConfig

(

)

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

                                : bool
    {
        return true;
    }

Field Documentation

$refinery

ilGlobalCacheSetupAgent::$refinery

protected

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

Referenced by __construct().

---

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

• Services/GlobalCache/classes/Setup/class.ilGlobalCacheSetupAgent.php