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

	getBuildObjective ()
	@inheritdocs More...

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

	getAgents ()

	getNamedObjectives (?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...

	getBuildObjective ()
	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...

	getNamedObjectives (?Config $config=null)
	Gets all named objectives The keys of the returned array are the commands. More...

Protected Member Functions
	getKey (Migration $migration)

	checkConfig (Config $config)

Protected Attributes
Refinery	$refinery

array	$agents

Detailed Description

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

Definition at line 30 of file AgentCollection.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 39 of file AgentCollection.php.

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

References ILIAS\Setup\AgentCollection\$agents, ILIAS\Setup\AgentCollection\$refinery, and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

◆ checkConfig()

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

protected

Definition at line 214 of file AgentCollection.php.

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

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

Here is the caller graph for this function:

◆ getAgent()

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

Definition at line 47 of file AgentCollection.php.

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

◆ getAgents()

ILIAS\Setup\AgentCollection::getAgents ( )

Returns: Agent[]

Definition at line 226 of file AgentCollection.php.

                               : array
    {
        return $this->agents;
    }

References ILIAS\Setup\AgentCollection\$agents.

◆ getArrayToConfigTransformation()

ILIAS\Setup\AgentCollection::getArrayToConfigTransformation ( )

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 85 of file AgentCollection.php.

                                                    : Transformation
    {
        return $this->refinery->in()->series([
            $this->refinery->custom()->transformation(function ($in): array {
                $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(fn($v): array => [$v]),
            $this->refinery->to()->toNew(ConfigCollection::class)
        ]);
    }

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

Here is the call graph for this function:

◆ getBuildObjective()

ILIAS\Setup\AgentCollection::getBuildObjective ( )

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 159 of file AgentCollection.php.

                                       : Objective
    {
        return new ObjectiveCollection(
            "Collected Build Artifact Objectives",
            false,
            ...array_values(array_map(
                fn(Agent $v): \ILIAS\Setup\Objective => $v->getBuildObjective(),
                $this->agents
            ))
        );
    }

References ILIAS\Setup\Agent\getBuildObjective().

Here is the call graph for this function:

◆ getInstallObjective()

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

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 108 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 ILIAS\Setup\AgentCollection\checkConfig(), and ILIAS\Setup\Agent\hasConfig().

Here is the call graph for this function:

◆ getKey()

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

protected

Definition at line 208 of file AgentCollection.php.

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

◆ getNamedObjectives()

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

@inheritDoc

Implements ILIAS\Setup\Agent.

Definition at line 232 of file AgentCollection.php.

                                                              : array
    {
        if (!is_null($config)) {
            $this->checkConfig($config);
        }
 
        $agents = $this->agents;
        $namedObjectives = [];
 
        foreach ($agents as $k => $agent) {
            if ($config) {
                $objectives = $agent->getNamedObjectives($config->maybeGetConfig($k));
            } else {
                $objectives = $agent->getNamedObjectives();
            }
            foreach ($objectives as $name => $constructor) {
                $namedObjectives["$k.$name"] = $constructor;
            }
        }
 
        ksort($namedObjectives);
        return $namedObjectives;
    }

References ILIAS\Setup\AgentCollection\$agents, $objectives, 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 174 of file AgentCollection.php.

                                                                : Objective
    {
        return new ObjectiveCollection(
            "Collected Status Objectives",
            false,
            ...array_values(array_map(
                fn(string $k, Agent $v): \ILIAS\Setup\Objective => $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 134 of file AgentCollection.php.

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

References 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 72 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 59 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 52 of file AgentCollection.php.

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

Field Documentation

◆ $agents

array ILIAS\Setup\AgentCollection::$agents

protected

Definition at line 37 of file AgentCollection.php.

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

◆ $refinery

Refinery ILIAS\Setup\AgentCollection::$refinery

protected

Definition at line 32 of file AgentCollection.php.

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

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

components/ILIAS/Setup/src/AgentCollection.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkConfig()

◆ getAgent()

◆ getAgents()

◆ getArrayToConfigTransformation()

◆ getBuildObjective()

◆ getInstallObjective()

◆ getKey()

◆ getNamedObjectives()

◆ getStatusObjective()

◆ getUpdateObjective()

◆ hasConfig()

◆ withAdditionalAgent()

◆ withRemovedAgent()

Field Documentation

◆ $agents

◆ $refinery