ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
Agent.php
Go to the documentation of this file.
1<?php
2
19declare(strict_types=1);
20
21namespace ILIAS\Setup;
22
24use ILIAS\UI;
25
29interface Agent
30{
34 public function hasConfig(): bool;
35
43
52 public function getInstallObjective(?Config $config = null): Objective;
53
70 public function getUpdateObjective(?Config $config = null): Objective;
71
77 public function getBuildObjective(): Objective;
78
89 public function getStatusObjective(Metrics\Storage $storage): Objective;
90
98 public function getMigrations(): array;
99
109 public function getNamedObjectives(?Config $config = null): array;
110}
A transformation is a function from one datatype to another.
A agent is some component that performs part of the setup process.
Definition: Agent.php:30
getInstallObjective(?Config $config=null)
Get the goals the agent wants to achieve on setup.
getMigrations()
Get a named map of migrations available for this Agent.
hasConfig()
Does this agent require a configuration?
getNamedObjectives(?Config $config=null)
Gets all named objectives The keys of the returned array are the commands.
getBuildObjective()
Get the goal the agent wants to achieve to build artifacts.
getArrayToConfigTransformation()
Agents must be able to tell how to create a configuration from a nested array.
getStatusObjective(Metrics\Storage $storage)
Get the objective to be achieved when status is requested.
getUpdateObjective(?Config $config=null)
Get the goal the agent wants to achieve on update.
A configuration for the setup.
Definition: Config.php:27
An objective is a desired state of the system that is supposed to be created by the setup.
Definition: Objective.php:31
Storage is simple key/value store without further schema definition.
Definition: Storage.php:30
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...