An agent that is just a collection of some other agents. More...

Inheritance diagram for ILIAS\Setup\AgentCollection:

Collaboration diagram for ILIAS\Setup\AgentCollection:

Public Member Functions
	__construct (Refinery $refinery, array $agents)

	getAgent (string $key)

	withRemovedAgent (string $key)

	withAdditionalAgent (string $key, Agent $agent)

	hasConfig ()
	@inheritdocs More...

	getArrayToConfigTransformation ()
	@inheritdocs More...

	getInstallObjective (Config $config=null)
	@inheritdocs More...

	getUpdateObjective (Config $config=null)
	@inheritdocs More...

	getBuildArtifactObjective ()
	@inheritdocs More...

	getStatusObjective (Metrics\Storage $storage)
	@inheritdocs More...

	getNamedObjective (string $name, Config $config=null)
	@inheritDoc More...

Public Member Functions inherited from ILIAS\Setup\Agent
	hasConfig ()
	Does this agent require a configuration? More...

	getArrayToConfigTransformation ()
	Agents must be able to tell how to create a configuration from a nested array. More...

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

	getBuildArtifactObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...

	getStatusObjective (Metrics\Storage $storage)
	Get the objective to be achieved when status is requested. More...

	getMigrations ()
	Get a named map of migrations available for this Agent. More...

	getNamedObjective (string $name, Config $config=null)
	Get a named objective from this agent. More...

Protected Member Functions
	getKey (Setup\Migration $migration)

	checkConfig (Config $config)

Protected Attributes
	$refinery

	$agents

Detailed Description

An agent that is just a collection of some other agents.

Definition at line 15 of file AgentCollection.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Setup\AgentCollection::__construct	(	Refinery	$refinery,
		array	$agents
	)

Definition at line 27 of file AgentCollection.php.

      {
        $this->refinery = $refinery;
        $this->agents = $agents;
    }

References ILIAS\Setup\AgentCollection\$agents, and ILIAS\Setup\AgentCollection\$refinery.

Member Function Documentation

◆ checkConfig()

ILIAS\Setup\AgentCollection::checkConfig ( Config $config )

protected

Definition at line 237 of file AgentCollection.php.

    {
        if (!($config instanceof ConfigCollection)) {
            throw new \InvalidArgumentException(
                "Expected ConfigCollection for configuration."
            );
        }
    }

References $config.

Referenced by ILIAS\Setup\AgentCollection\getInstallObjective(), ILIAS\Setup\AgentCollection\getNamedObjective(), and ILIAS\Setup\AgentCollection\getUpdateObjective().

Here is the caller graph for this function:

◆ getAgent()

ILIAS\Setup\AgentCollection::getAgent ( string $key )

Definition at line 35 of file AgentCollection.php.

                                          : ?Agent
    {
        return $this->agents[$key] ?? null;
    }

◆ getArrayToConfigTransformation()

ILIAS\Setup\AgentCollection::getArrayToConfigTransformation ( )

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 73 of file AgentCollection.php.

                                                     : Transformation
    {
        return $this->refinery->in()->series([
            $this->refinery->custom()->transformation(function ($in) {
                $out = [];
                foreach ($this->agents as $key => $agent) {
                    if (!$agent->hasConfig()) {
                        continue;
                    }
                    $val = $in[$key] ?? null;
                    $transformation = $agent->getArrayToConfigTransformation();
                    $out[$key] = $transformation($val);
                }
                return $out;
            }),
            $this->refinery->custom()->transformation(function ($v) {
                return [$v];
            }),
            $this->refinery->to()->toNew(ConfigCollection::class)
        ]);
    }

References $in, and $out.

◆ getBuildArtifactObjective()

ILIAS\Setup\AgentCollection::getBuildArtifactObjective ( )

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 149 of file AgentCollection.php.

                                                : Objective
    {
        return new ObjectiveCollection(
            "Collected Build Artifact Objectives",
            false,
            ...array_values(array_map(
                function (Agent $v) {
                    return $v->getBuildArtifactObjective();
                },
                $this->agents
            ))
        );
    }

References ILIAS\Setup\AgentCollection\$agents, and ILIAS\Setup\Agent\getBuildArtifactObjective().

Here is the call graph for this function:

◆ getInstallObjective()

ILIAS\Setup\AgentCollection::getInstallObjective ( Config $config = null )

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 98 of file AgentCollection.php.

                                                               : Objective
    {
        if (!is_null($config)) {
            $this->checkConfig($config);
        }
 
        return new ObjectiveCollection(
            "Collected Install Objectives",
            false,
            ...array_values(array_map(
                function (string $k, Agent $v) use ($config) {
                    if ($v->hasConfig()) {
                        return $v->getInstallObjective($config->getConfig($k));
                    } else {
                        return $v->getInstallObjective();
                    }
                },
                array_keys($this->agents),
                array_values($this->agents)
            ))
        );
    }

References $config, ILIAS\Setup\AgentCollection\checkConfig(), and ILIAS\Setup\Agent\hasConfig().

Here is the call graph for this function:

◆ getKey()

ILIAS\Setup\AgentCollection::getKey ( Setup\Migration $migration )

protected

Definition at line 231 of file AgentCollection.php.

                                                          : string
    {
        $names = explode("\\", get_class($migration));
        return array_pop($names);
    }

◆ getNamedObjective()

ILIAS\Setup\AgentCollection::getNamedObjective	(	string	$name,
		Config	$config = `null`
	)

@inheritDoc

Implements ILIAS\Setup\Agent.

Definition at line 205 of file AgentCollection.php.

                                                                           : Objective
    {
        $names = explode(".", $name);
        $front = array_shift($names);
        if (!isset($this->agents[$front])) {
            throw new \InvalidArgumentException(
                "Can't find named objective '$name'."
            );
        }
 
        if ($config) {
            $this->checkConfig($config);
            $config = $config->maybeGetConfig($front);
        }
 
        try {
            return $this->agents[$front]->getNamedObjective(implode(".", $names), $config);
        } catch (\InvalidArgumentException $e) {
            throw new \InvalidArgumentException(
                "Can't find named objective '$name'.",
                0,
                $e
            );
        }
    }

References $config, Vendor\Package\$e, $name, and ILIAS\Setup\AgentCollection\checkConfig().

Here is the call graph for this function:

◆ getStatusObjective()

ILIAS\Setup\AgentCollection::getStatusObjective ( Metrics\Storage $storage )

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 166 of file AgentCollection.php.

                                                                 : Objective
    {
        return new ObjectiveCollection(
            "Collected Status Objectives",
            false,
            ...array_values(array_map(
                function (string $k, Agent $v) use ($storage) {
                    return $v->getStatusObjective(
                        new Metrics\StorageOnPathWrapper($k, $storage)
                    );
                },
                array_keys($this->agents),
                array_values($this->agents)
            ))
        );
    }

References ILIAS\Setup\Agent\getStatusObjective().

Here is the call graph for this function:

◆ getUpdateObjective()

ILIAS\Setup\AgentCollection::getUpdateObjective ( Config $config = null )

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 124 of file AgentCollection.php.

                                                              : Objective
    {
        if ($config) {
            $this->checkConfig($config);
        }
 
        return new ObjectiveCollection(
            "Collected Update Objectives",
            false,
            ...array_values(array_map(
                function (string $k, Agent $v) use ($config) {
                    if ($config) {
                        return $v->getUpdateObjective($config->maybeGetConfig($k));
                    }
                    return $v->getUpdateObjective();
                },
                array_keys($this->agents),
                array_values($this->agents)
            ))
        );
    }

References $config, ILIAS\Setup\AgentCollection\checkConfig(), and ILIAS\Setup\Agent\getUpdateObjective().

Here is the call graph for this function:

◆ hasConfig()

ILIAS\Setup\AgentCollection::hasConfig ( )

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 60 of file AgentCollection.php.

                                : bool
    {
        foreach ($this->agents as $c) {
            if ($c->hasConfig()) {
                return true;
            }
        }
        return false;
    }

References $c.

◆ withAdditionalAgent()

ILIAS\Setup\AgentCollection::withAdditionalAgent	(	string	$key,
		Agent	$agent
	)

Definition at line 47 of file AgentCollection.php.

                                                                   : AgentCollection
    {
        if (isset($this->agents[$key])) {
            throw new \LogicException("An agent with the name '$key' already exists.");
        }
        $clone = clone $this;
        $clone->agents[$key] = $agent;
        return $clone;
    }

◆ withRemovedAgent()

ILIAS\Setup\AgentCollection::withRemovedAgent ( string $key )

Definition at line 40 of file AgentCollection.php.

                                                  : AgentCollection
    {
        $clone = clone $this;
        unset($clone->agents[$key]);
        return $clone;
    }

Field Documentation

◆ $agents

ILIAS\Setup\AgentCollection::$agents

protected

Definition at line 25 of file AgentCollection.php.

Referenced by ILIAS\Setup\AgentCollection\__construct(), and ILIAS\Setup\AgentCollection\getBuildArtifactObjective().

◆ $refinery

ILIAS\Setup\AgentCollection::$refinery

protected

Definition at line 20 of file AgentCollection.php.

Referenced by ILIAS\Setup\AgentCollection\__construct().

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

src/Setup/AgentCollection.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkConfig()

◆ getAgent()

◆ getArrayToConfigTransformation()

◆ getBuildArtifactObjective()

◆ getInstallObjective()

◆ getKey()

◆ getNamedObjective()

◆ getStatusObjective()

◆ getUpdateObjective()

◆ hasConfig()

◆ withAdditionalAgent()

◆ withRemovedAgent()

Field Documentation

◆ $agents

◆ $refinery