ILIAS  trunk Revision v11.0_alpha-1866-gfa368f7776e
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
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 (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 42 of file class.ilResourceStorageSetupAgent.php.

43  {
44  throw new \LogicException("Agent has no config.");
45  }
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 74 of file class.ilResourceStorageSetupAgent.php.

74  : Objective
75  {
77  }
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 47 of file class.ilResourceStorageSetupAgent.php.

47  : Objective
48  {
49  return new ObjectiveCollection(
50  'IRSS Installation',
51  false,
55  )
56  );
57  }
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 92 of file class.ilResourceStorageSetupAgent.php.

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

◆ getStatusObjective()

ilResourceStorageSetupAgent::getStatusObjective ( Storage  $storage)

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

79  : Objective
80  {
81  return new ObjectiveCollection(
82  'Component ResourceStorage',
83  true,
86  );
87  }
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 59 of file class.ilResourceStorageSetupAgent.php.

59  : Objective
60  {
61  return new ObjectiveCollection(
62  'IRSS Update',
63  false,
67  ),
70  )
71  );
72  }
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 37 of file class.ilResourceStorageSetupAgent.php.

37  : bool
38  {
39  return false;
40  }

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