A agent is some component that performs part of the setup process. More...
Inheritance diagram for ILIAS\Setup\Agent:
Collaboration diagram for ILIAS\Setup\Agent:
Public Member Functions | |
| 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... | |
Detailed Description
A agent is some component that performs part of the setup process.
Member Function Documentation
◆ getArrayToConfigTransformation()
| ILIAS\Setup\Agent::getArrayToConfigTransformation | ( | ) |
Agents must be able to tell how to create a configuration from a nested array.
Implemented in ILIAS\Setup\AgentCollection.
◆ getBuildArtifactObjective()
| ILIAS\Setup\Agent::getBuildArtifactObjective | ( | ) |
Get the goal the agent wants to achieve to build artifacts.
Implemented in ILIAS\Setup\AgentCollection.
Referenced by ILIAS\Setup\CLI\BuildArtifactsCommand\getObjective().
Here is the caller graph for this function:
◆ getConfigInput()
| ILIAS\Setup\Agent::getConfigInput | ( | Config | $config = null | ) |
Agents must provide an input to set the configuration if they have a configuration.
- Exceptions
-
InvalidArgumentException if Config does not match the Agent.. LogicException if Agent has no Config
Implemented in ILIAS\Setup\AgentCollection.
◆ getInstallObjective()
| ILIAS\Setup\Agent::getInstallObjective | ( | Config | $config = null | ) |
Get the goals the agent wants to achieve on setup.
Implemented in ILIAS\Setup\AgentCollection.
Referenced by ILIAS\Setup\CLI\InstallCommand\getObjective().
Here is the caller graph for this function:
◆ getUpdateObjective()
| ILIAS\Setup\Agent::getUpdateObjective | ( | Config | $config = null | ) |
Get the goal the agent wants to achieve on update.
Implemented in ILIAS\Setup\AgentCollection.
Referenced by ILIAS\Setup\CLI\InstallCommand\getObjective(), and ILIAS\Setup\CLI\UpdateCommand\getObjective().
Here is the caller graph for this function:
◆ hasConfig()
| ILIAS\Setup\Agent::hasConfig | ( | ) |
Does this agent require a configuration?
Implemented in ILIAS\Setup\AgentCollection.
Referenced by ILIAS\Setup\CLI\BaseCommand\readAgentConfig().
Here is the caller graph for this function:
The documentation for this interface was generated from the following file:
- src/Setup/Agent.php
