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

Class ilUICoreSetupAgent. More...

+ Inheritance diagram for ilUICoreSetupAgent:
+ Collaboration diagram for ilUICoreSetupAgent:

Public Member Functions

 hasConfig ()
 
 getArrayToConfigTransformation ()
 
 getInstallObjective (Config $config=null)
 
 getUpdateObjective (Config $config=null)
 
 getBuildObjective ()
 
 getStatusObjective (Storage $storage)
 
 getMigrations ()
 
 getNamedObjectives (?Config $config=null)
 

Detailed Description

Member Function Documentation

◆ getArrayToConfigTransformation()

ilUICoreSetupAgent::getArrayToConfigTransformation ( )

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

35  {
36  throw new LogicException(self::class . " has no Config.");
37  }
A transformation is a function from one datatype to another.

◆ getBuildObjective()

ilUICoreSetupAgent::getBuildObjective ( )

Definition at line 60 of file class.ilUICoreSetupAgent.php.

Referenced by getNamedObjectives().

60  : Objective
61  {
62  return new ObjectiveCollection(
63  'buildIlCtrlArtifacts',
64  false,
68  );
69  }
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 ilCtrlSecurityArtifactObjective.
Class ilCtrlStructureArtifactObjective.
+ Here is the caller graph for this function:

◆ getInstallObjective()

ilUICoreSetupAgent::getInstallObjective ( Config  $config = null)

Definition at line 42 of file class.ilUICoreSetupAgent.php.

42  : Objective
43  {
44  return new NullObjective();
45  }
An objective is a desired state of the system that is supposed to be created by the setup...
Definition: Objective.php:30
A non-objective, nothing to do to achieve it...

◆ getMigrations()

ilUICoreSetupAgent::getMigrations ( )

Definition at line 82 of file class.ilUICoreSetupAgent.php.

82  : array
83  {
84  return [];
85  }

◆ getNamedObjectives()

ilUICoreSetupAgent::getNamedObjectives ( ?Config  $config = null)

Definition at line 90 of file class.ilUICoreSetupAgent.php.

References getBuildObjective(), and getUpdateObjective().

90  : array
91  {
92  return [
93  'buildIlCtrlArtifacts' => new ObjectiveConstructor(
94  'builds all necessary ilCtrl artifacts.',
95  function () {
96  return $this->getBuildObjective();
97  }
98  ),
99 
100  'updateIlCtrlDatabase' => new ObjectiveConstructor(
101  'executes all ilCtrl database update steps.',
102  function () {
103  return $this->getUpdateObjective();
104  }
105  ),
106  ];
107  }
getUpdateObjective(Config $config=null)
+ Here is the call graph for this function:

◆ getStatusObjective()

ilUICoreSetupAgent::getStatusObjective ( Storage  $storage)

Definition at line 74 of file class.ilUICoreSetupAgent.php.

74  : Objective
75  {
76  return new NullObjective();
77  }
An objective is a desired state of the system that is supposed to be created by the setup...
Definition: Objective.php:30
A non-objective, nothing to do to achieve it...

◆ getUpdateObjective()

ilUICoreSetupAgent::getUpdateObjective ( Config  $config = null)

Definition at line 50 of file class.ilUICoreSetupAgent.php.

Referenced by getNamedObjectives().

50  : Objective
51  {
54  );
55  }
An objective is a desired state of the system that is supposed to be created by the setup...
Definition: Objective.php:30
Class ilCtrlDatabaseUpdateSteps holds the database update- steps affecting ilCtrl tables...
+ Here is the caller graph for this function:

◆ hasConfig()

ilUICoreSetupAgent::hasConfig ( )

Definition at line 26 of file class.ilUICoreSetupAgent.php.

26  : bool
27  {
28  return false;
29  }

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