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 (FieldFactory $field_factory, Refinery $refinery, array $agents)

	hasConfig ()
	@inheritdocs More...

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

	getArrayToConfigTransformation ()
	@inheritdocs More...

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

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

	getBuildArtifactObjective ()
	@inheritdocs More...

	hasConfig ()
	Does this agent require a configuration? More...

	getConfigInput (Config $config=null)
	Agents must provide an input to set the configuration if they have 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...

Protected Member Functions
	getXObjective (string $which, Config $config=null)

	checkConfig (Config $config)

	getAgentsWithConfig ()

Protected Attributes
	$field_factory

	$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	(	FieldFactory	$field_factory,
		Refinery	$refinery,
		array	$agents
	)

Definition at line 32 of file AgentCollection.php.

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

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

Member Function Documentation

◆ checkConfig()

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

protected

Definition at line 153 of file AgentCollection.php.

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

References $config.

Referenced by ILIAS\Setup\AgentCollection\getConfigInput(), and ILIAS\Setup\AgentCollection\getXObjective().

Here is the caller graph for this function:

◆ getAgentsWithConfig()

ILIAS\Setup\AgentCollection::getAgentsWithConfig ( )

protected

Definition at line 162 of file AgentCollection.php.

                                             : \Traversable
    {
        foreach ($this->agents as $k => $c) {
            if ($c->hasConfig()) {
                yield $k => $c;
            }
        }
    }

References Vendor\Package\$c.

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

Here is the caller graph for this function:

◆ getArrayToConfigTransformation()

ILIAS\Setup\AgentCollection::getArrayToConfigTransformation ( )

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 87 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 128 of file AgentCollection.php.

                                                : Objective
    {
        $gs = [];
        foreach ($this->agents as $k => $c) {
            $gs[] = $c->getBuildArtifactObjective();
        }
        return new ObjectiveCollection("Collected Build Artifact Objectives", false, ...$gs);
    }

References Vendor\Package\$c.

◆ getConfigInput()

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

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 58 of file AgentCollection.php.

                                                          : Input
    {
        if ($config !== null) {
            $this->checkConfig($config);
        }
 
        $inputs = [];
        foreach ($this->getAgentsWithConfig() as $k => $c) {
            if ($config) {
                $inputs[$k] = $c->getConfigInput($config->getConfig($k));
            } else {
                $inputs[$k] = $c->getConfigInput();
            }
        }
 
        return $this->field_factory->group($inputs)
            ->withAdditionalTransformation(
                $this->refinery->in()->series([
                    $this->refinery->custom()->transformation(function ($v) {
                        return [$v];
                    }),
                    $this->refinery->to()->toNew(ConfigCollection::class)
                ])
            );
    }

References Vendor\Package\$c, $config, ILIAS\Setup\AgentCollection\checkConfig(), and ILIAS\Setup\AgentCollection\getAgentsWithConfig().

Here is the call graph for this function:

◆ getInstallObjective()

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

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 112 of file AgentCollection.php.

                                                               : Objective
    {
        return $this->getXObjective("getInstallObjective", $config);
    }

References $config, and ILIAS\Setup\AgentCollection\getXObjective().

Here is the call graph for this function:

◆ getUpdateObjective()

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

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 120 of file AgentCollection.php.

                                                              : Objective
    {
        return $this->getXObjective("getUpdateObjective", $config);
    }

References $config, and ILIAS\Setup\AgentCollection\getXObjective().

Here is the call graph for this function:

◆ getXObjective()

ILIAS\Setup\AgentCollection::getXObjective	(	string	$which,
		Config	$config = `null`
	)

protected

Definition at line 137 of file AgentCollection.php.

                                                                           : Objective
    {
        $this->checkConfig($config);
 
        $gs = [];
        foreach ($this->agents as $k => $c) {
            if ($c->hasConfig()) {
                $gs[] = call_user_func([$c, $which], $config->getConfig($k));
            } else {
                $gs[] = call_user_func([$c, $which]);
            }
        }
 
        return new ObjectiveCollection("Collected Objectives", false, ...$gs);
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasConfig()

ILIAS\Setup\AgentCollection::hasConfig ( )

@inheritdocs

Implements ILIAS\Setup\Agent.

Definition at line 45 of file AgentCollection.php.

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

References Vendor\Package\$c.

Field Documentation

◆ $agents

ILIAS\Setup\AgentCollection::$agents

protected

Definition at line 30 of file AgentCollection.php.

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

◆ $field_factory

ILIAS\Setup\AgentCollection::$field_factory

protected

Definition at line 20 of file AgentCollection.php.

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

◆ $refinery

ILIAS\Setup\AgentCollection::$refinery

protected

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

◆ getAgentsWithConfig()

◆ getArrayToConfigTransformation()

◆ getBuildArtifactObjective()

◆ getConfigInput()

◆ getInstallObjective()

◆ getUpdateObjective()

◆ getXObjective()

◆ hasConfig()

Field Documentation

◆ $agents

◆ $field_factory

◆ $refinery