ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ILIAS\Imprint\Setup\ImprintUpdateAgent Class Reference
+ Inheritance diagram for ILIAS\Imprint\Setup\ImprintUpdateAgent:
+ Collaboration diagram for ILIAS\Imprint\Setup\ImprintUpdateAgent:

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 (?Setup\Config $config=null)
 
 getUpdateObjective (?Setup\Config $config=null)
 
 getBuildObjective ()
 Get the goal the agent wants to achieve to build artifacts. More...
 
 getStatusObjective (Setup\Metrics\Storage $storage)
 
 getMigrations ()
 Get a named map of migrations available for this Agent. 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...
 

Detailed Description

Definition at line 28 of file ImprintUpdateAgent.php.

Member Function Documentation

◆ getArrayToConfigTransformation()

ILIAS\Imprint\Setup\ImprintUpdateAgent::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 37 of file ImprintUpdateAgent.php.

37 : Refinery\Transformation
38 {
39 throw new LogicException('Agent has no config.');
40 }

◆ getBuildObjective()

ILIAS\Imprint\Setup\ImprintUpdateAgent::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 55 of file ImprintUpdateAgent.php.

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

◆ getInstallObjective()

ILIAS\Imprint\Setup\ImprintUpdateAgent::getInstallObjective ( ?Setup\Config  $config = null)

Definition at line 42 of file ImprintUpdateAgent.php.

42 : Setup\Objective
43 {
44 return new Setup\Objective\NullObjective();
45 }

◆ getMigrations()

ILIAS\Imprint\Setup\ImprintUpdateAgent::getMigrations ( )

Get a named map of migrations available for this Agent.

Should also return Migrations that have run completely.

Returns
array<string,Migration>|Migration[]

Implements ILIAS\Setup\Agent.

Definition at line 65 of file ImprintUpdateAgent.php.

65 : array
66 {
67 return [];
68 }

◆ getStatusObjective()

ILIAS\Imprint\Setup\ImprintUpdateAgent::getStatusObjective ( Setup\Metrics\Storage  $storage)

Definition at line 60 of file ImprintUpdateAgent.php.

60 : Setup\Objective
61 {
62 return new Setup\Objective\NullObjective();
63 }

◆ getUpdateObjective()

ILIAS\Imprint\Setup\ImprintUpdateAgent::getUpdateObjective ( ?Setup\Config  $config = null)

Definition at line 47 of file ImprintUpdateAgent.php.

47 : Setup\Objective
48 {
50 'impr',
51 'Legal Notice'
52 ));
53 }

◆ hasConfig()

ILIAS\Imprint\Setup\ImprintUpdateAgent::hasConfig ( )

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 32 of file ImprintUpdateAgent.php.

32 : bool
33 {
34 return false;
35 }

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