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

Public Member Functions

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

Member Function Documentation

◆ getArrayToConfigTransformation()

ilCourseObjectiveSetupAgent::getArrayToConfigTransformation ( )

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

Definition at line 51 of file ilCourseObjectiveSetupAgent.php.

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

◆ getBuildObjective()

ilCourseObjectiveSetupAgent::getBuildObjective ( )

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

Definition at line 61 of file ilCourseObjectiveSetupAgent.php.

61 : Objective
62 {
63 return new Objective\NullObjective();
64 }
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()

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

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

Definition at line 56 of file ilCourseObjectiveSetupAgent.php.

56 : Objective
57 {
58 return new Objective\NullObjective();
59 }

◆ getStatusObjective()

ilCourseObjectiveSetupAgent::getStatusObjective ( Metrics\Storage  $storage)

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

Definition at line 42 of file ilCourseObjectiveSetupAgent.php.

42 : Objective
43 {
44 return new ObjectiveCollection(
45 'Database is updated for component/ILIAS/Course',
46 true,
48 );
49 }
A objective collection is a objective that is achieved once all subobjectives are achieved.
This class attempt to achieve a set of database update steps.

◆ getUpdateObjective()

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

@inheritdocs

Reimplemented from ILIAS\Setup\Agent\NullAgent.

Definition at line 33 of file ilCourseObjectiveSetupAgent.php.

33 : Objective
34 {
35 return new ObjectiveCollection(
36 'Database is updated for component/ILIAS/Course',
37 false,
39 );
40 }

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