Inheritance diagram for ilFileServicesSetupAgent:
Collaboration diagram for ilFileServicesSetupAgent:
Public Member Functions | |
| 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... | |
| Public Member Functions inherited from ILIAS\Setup\Agent\NullAgent | |
| __construct (Refinery $refinery) | |
| 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... | |
| getMigrations () | |
| @inheritDoc More... | |
| getNamedObjectives (?Config $config=null) | |
| Gets all named objectives The keys of the returned array are the commands. 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... | |
Additional Inherited Members | |
| Protected Attributes inherited from ILIAS\Setup\Agent\NullAgent | |
| Refinery | $refinery |
Detailed Description
Definition at line 28 of file class.ilFileServicesSetupAgent.php.
Member Function Documentation
◆ getInstallObjective()
| ilFileServicesSetupAgent::getInstallObjective | ( | ?Config | $config = null | ) |
Get the goals the agent wants to achieve on setup.
The provided configuration is to be used to set according configuration values in the installation.
- Exceptions
-
InvalidArgumentException if Config does not match the Agent..
Implements ILIAS\Setup\Agent.
Definition at line 31 of file class.ilFileServicesSetupAgent.php.
Referenced by getUpdateObjective().
Here is the caller graph for this function:
◆ getUpdateObjective()
| ilFileServicesSetupAgent::getUpdateObjective | ( | ?Config | $config = null | ) |
Get the goal the agent wants to achieve on update.
The provided configuration is to be used to change according configuration values in the installation. If this is not possible for some reason, an according UnachievableException needs to be thrown in the according objective.
The configuration is not to be used to initialize the required environment for the objectives. This must be done via ClientIdReadObjective and depending objectives like ilIniFilesLoadedObjective.
If no configuration is provided the configuration of the component should stay as is.
- Exceptions
-
InvalidArgumentException if Config does not match the Agent..
Implements ILIAS\Setup\Agent.
Definition at line 46 of file class.ilFileServicesSetupAgent.php.
References getInstallObjective().
Here is the call graph for this function:
The documentation for this class was generated from the following file:
- components/ILIAS/FileServices/classes/Setup/class.ilFileServicesSetupAgent.php
