ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilStudyProgrammeSetupAgent Class Reference
+ Inheritance diagram for ilStudyProgrammeSetupAgent:
+ Collaboration diagram for ilStudyProgrammeSetupAgent:

Public Member Functions

 getUpdateObjective (?Config $config=null)
 @inheritdocs More...
 
 getStatusObjective (Metrics\Storage $storage)
 @inheritdocs More...
 
 hasConfig ()
 @inheritdocs More...
 
 getArrayToConfigTransformation ()
 @inheritdocs More...
 
 getInstallObjective (?Config $config=null)
 @inheritdocs More...
 
 getBuildObjective ()
 @inheritdocs More...
 
 getMigrations ()
 @inheritDoc 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 30 of file class.ilStudyProgrammeSetupAgent.php.

Member Function Documentation

◆ getArrayToConfigTransformation()

ilStudyProgrammeSetupAgent::getArrayToConfigTransformation ( )

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

Definition at line 71 of file class.ilStudyProgrammeSetupAgent.php.

72 {
73 throw new LogicException('Agent has no config.');
74 }
A transformation is a function from one datatype to another.

◆ getBuildObjective()

ilStudyProgrammeSetupAgent::getBuildObjective ( )

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

Definition at line 81 of file class.ilStudyProgrammeSetupAgent.php.

81 : Objective
82 {
83 return new NullObjective();
84 }
A non-objective, nothing to do to achieve it...
An objective is a desired state of the system that is supposed to be created by the setup.
Definition: Objective.php:31

◆ getInstallObjective()

ilStudyProgrammeSetupAgent::getInstallObjective ( ?Config  $config = null)

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

Definition at line 76 of file class.ilStudyProgrammeSetupAgent.php.

76 : Objective
77 {
78 return new NullObjective();
79 }

◆ getMigrations()

ilStudyProgrammeSetupAgent::getMigrations ( )

@inheritDoc

Reimplemented from ILIAS\Setup\Agent\NullAgent.

Definition at line 86 of file class.ilStudyProgrammeSetupAgent.php.

86 : array
87 {
88 return [];
89 }

◆ getStatusObjective()

ilStudyProgrammeSetupAgent::getStatusObjective ( Metrics\Storage  $storage)

◆ getUpdateObjective()

ilStudyProgrammeSetupAgent::getUpdateObjective ( ?Config  $config = null)

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

Definition at line 34 of file class.ilStudyProgrammeSetupAgent.php.

34 : Objective
35 {
36 return new ObjectiveCollection(
37 'Database is updated for component/ILIAS/StudyProgramme',
38 false,
39 // ILIAS 10
42 ),
45 ),
46 );
47 }
This class attempt to achieve a set of database update steps.

◆ hasConfig()

ilStudyProgrammeSetupAgent::hasConfig ( )

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

Definition at line 66 of file class.ilStudyProgrammeSetupAgent.php.

66 : bool
67 {
68 return false;
69 }

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