ILIAS  release_9 Revision v9.13-25-g2c18ec4c24f
ilFileServicesSetupAgent Class Reference
+ 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
 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...
 
 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...
 
 getNamedObjectives (?Config $config=null)
 Gets all named objectives The keys of the returned array are the commands. More...
 

Detailed Description

Definition at line 30 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
InvalidArgumentExceptionif Config does not match the Agent..

Implements ILIAS\Setup\Agent.

Definition at line 32 of file class.ilFileServicesSetupAgent.php.

Referenced by getUpdateObjective().

32  : Objective
33  {
34  return new ObjectiveCollection(
35  "Check for several PHP-Extensions needed by FileServices.",
36  true,
38  new PHPExtensionLoadedCondition("imagick"),
39  new PHPExtensionLoadedCondition("zip"),
42  )
43  );
44  }
A objective collection is a objective that is achieved once all subobjectives are achieved...
An objective is a desired state of the system that is supposed to be created by the setup...
Definition: Objective.php:30
+ 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
InvalidArgumentExceptionif Config does not match the Agent..

Implements ILIAS\Setup\Agent.

Definition at line 46 of file class.ilFileServicesSetupAgent.php.

References getInstallObjective().

46  : Objective
47  {
48  return $this->getInstallObjective($config);
49  }
getInstallObjective(Config $config=null)
Get the goals the agent wants to achieve on setup.
An objective is a desired state of the system that is supposed to be created by the setup...
Definition: Objective.php:30
+ Here is the call graph for this function:

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