ILIAS  release_8 Revision v8.23
ILIAS\Setup\Agent\NullAgent Class Reference

An agent that just doesn't do a thing. More...

+ Inheritance diagram for ILIAS\Setup\Agent\NullAgent:
+ Collaboration diagram for ILIAS\Setup\Agent\NullAgent:

Public Member Functions

 __construct (Refinery $refinery)
 
 hasConfig ()
 
 getArrayToConfigTransformation ()
 
 getInstallObjective (Config $config=null)
 
 getUpdateObjective (Config $config=null)
 
 getBuildArtifactObjective ()
 
 getStatusObjective (Metrics\Storage $storage)
 
 getMigrations ()
 
 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
 getStatusObjective (Metrics\Storage $storage)
 Get the objective to be achieved when status is requested. More...
 

Protected Attributes

Refinery $refinery
 

Detailed Description

An agent that just doesn't do a thing.

Definition at line 34 of file NullAgent.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Setup\Agent\NullAgent::__construct ( Refinery  $refinery)

Definition at line 38 of file NullAgent.php.

References ILIAS\Setup\Agent\NullAgent\$refinery, and ILIAS\Repository\refinery().

+ Here is the call graph for this function:

Member Function Documentation

◆ getArrayToConfigTransformation()

ILIAS\Setup\Agent\NullAgent::getArrayToConfigTransformation ( )

Implements ILIAS\Setup\Agent.

Definition at line 55 of file NullAgent.php.

55  : Transformation
56  {
57  throw new \LogicException(
58  self::class . " has no config."
59  );
60  }

◆ getBuildArtifactObjective()

ILIAS\Setup\Agent\NullAgent::getBuildArtifactObjective ( )

Implements ILIAS\Setup\Agent.

Definition at line 81 of file NullAgent.php.

81  : Objective
82  {
83  return new NullObjective();
84  }

◆ getInstallObjective()

ILIAS\Setup\Agent\NullAgent::getInstallObjective ( Config  $config = null)

Implements ILIAS\Setup\Agent.

Definition at line 65 of file NullAgent.php.

65  : Objective
66  {
67  return new NullObjective();
68  }

◆ getMigrations()

ILIAS\Setup\Agent\NullAgent::getMigrations ( )

Implements ILIAS\Setup\Agent.

Definition at line 97 of file NullAgent.php.

97  : array
98  {
99  return [];
100  }

◆ getNamedObjectives()

ILIAS\Setup\Agent\NullAgent::getNamedObjectives ( ?Config  $config = null)

Gets all named objectives The keys of the returned array are the commands.

Only the AgentCollection should return an array where the cmd of the named objective is the array key.

Parameters
Config | null$config
Returns
array<string|int, ObjectiveConstructor>

Implements ILIAS\Setup\Agent.

Definition at line 102 of file NullAgent.php.

102  : array
103  {
104  return [];
105  }

◆ getStatusObjective()

ILIAS\Setup\Agent\NullAgent::getStatusObjective ( Metrics\Storage  $storage)

Definition at line 89 of file NullAgent.php.

89  : Objective
90  {
91  return new NullObjective();
92  }

◆ getUpdateObjective()

ILIAS\Setup\Agent\NullAgent::getUpdateObjective ( Config  $config = null)

Implements ILIAS\Setup\Agent.

Definition at line 73 of file NullAgent.php.

73  : Objective
74  {
75  return new NullObjective();
76  }

◆ hasConfig()

ILIAS\Setup\Agent\NullAgent::hasConfig ( )

Implements ILIAS\Setup\Agent.

Definition at line 47 of file NullAgent.php.

47  : bool
48  {
49  return false;
50  }

Field Documentation

◆ $refinery

Refinery ILIAS\Setup\Agent\NullAgent::$refinery
protected

Definition at line 36 of file NullAgent.php.

Referenced by ILIAS\Setup\Agent\NullAgent\__construct().


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