ILIAS  release_10 Revision v10.1-43-ga1241a92c2f
ilResourceStorageSetupAgent Class Reference

Class ilResourceStorageSetupAgent. More...

+ Inheritance diagram for ilResourceStorageSetupAgent:
+ Collaboration diagram for ilResourceStorageSetupAgent:

Public Member Functions

 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)
 
 getUpdateObjective (Config $config=null)
 
 getBuildObjective ()
 Get the goal the agent wants to achieve to build artifacts. More...
 
 getStatusObjective (Metrics\Storage $storage)
 
 getMigrations ()
 
- Public Member Functions inherited from ILIAS\Setup\Agent
 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...
 
 getStatusObjective (Metrics\Storage $storage)
 Get the objective to be achieved when status is requested. More...
 
 getNamedObjectives (?Config $config=null)
 Gets all named objectives The keys of the returned array are the commands. More...
 

Detailed Description

Member Function Documentation

◆ getArrayToConfigTransformation()

ilResourceStorageSetupAgent::getArrayToConfigTransformation ( )

Agents must be able to tell how to create a configuration from a nested array.

Exceptions
LogicExceptionif Agent has no Config

Implements ILIAS\Setup\Agent.

Definition at line 41 of file class.ilResourceStorageSetupAgent.php.

42  {
43  throw new \LogicException("Agent has no config.");
44  }
A transformation is a function from one datatype to another.

◆ getBuildObjective()

ilResourceStorageSetupAgent::getBuildObjective ( )

Get the goal the agent wants to achieve to build artifacts.

Exceptions
InvalidArgumentExceptionif Config does not match the Agent.

Implements ILIAS\Setup\Agent.

Definition at line 73 of file class.ilResourceStorageSetupAgent.php.

73  : Objective
74  {
76  }
An objective is a desired state of the system that is supposed to be created by the setup...
Definition: Objective.php:30

◆ getInstallObjective()

ilResourceStorageSetupAgent::getInstallObjective ( Config  $config = null)

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

46  : Objective
47  {
48  return new ObjectiveCollection(
49  'IRSS Installation',
50  false,
54  )
55  );
56  }
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
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

◆ getMigrations()

ilResourceStorageSetupAgent::getMigrations ( )
Returns
[]

Implements ILIAS\Setup\Agent.

Definition at line 91 of file class.ilResourceStorageSetupAgent.php.

91  : array
92  {
93  return [];
94  }

◆ getStatusObjective()

ilResourceStorageSetupAgent::getStatusObjective ( Metrics\Storage  $storage)

Definition at line 78 of file class.ilResourceStorageSetupAgent.php.

78  : Objective
79  {
80  return new ObjectiveCollection(
81  'Component ResourceStorage',
82  true,
85  );
86  }
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
Class ilResourceStorageDB90.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

◆ getUpdateObjective()

ilResourceStorageSetupAgent::getUpdateObjective ( Config  $config = null)

Definition at line 58 of file class.ilResourceStorageSetupAgent.php.

58  : Objective
59  {
60  return new ObjectiveCollection(
61  'IRSS Update',
62  false,
66  ),
69  )
70  );
71  }
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
Class ilResourceStorageDB90.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

◆ hasConfig()

ilResourceStorageSetupAgent::hasConfig ( )

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 36 of file class.ilResourceStorageSetupAgent.php.

36  : bool
37  {
38  return false;
39  }

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