ILIAS  release_7 Revision v7.30-3-g800a261c036
All Data Structures Namespaces Files Functions Variables Modules Pages
Agent.php
Go to the documentation of this file.
1 <?php
2 
3 /* Copyright (c) 2019 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */
4 
5 namespace ILIAS\Setup;
6 
8 use ILIAS\UI;
9 
13 interface Agent
14 {
18  public function hasConfig() : bool;
19 
27 
36  public function getInstallObjective(Config $config = null) : Objective;
37 
54  public function getUpdateObjective(Config $config = null) : Objective;
55 
61  public function getBuildArtifactObjective() : Objective;
62 
73  public function getStatusObjective(Metrics\Storage $storage) : Objective;
74 
82  public function getMigrations() : array;
83 
89  public function getNamedObjective(string $name, Config $config = null) : Objective;
90 }
getStatusObjective(Metrics\Storage $storage)
Get the objective to be achieved when status is requested.
getArrayToConfigTransformation()
Agents must be able to tell how to create a configuration from a nested array.
An objective is a desired state of the system that is supposed to be created by the setup...
Definition: Objective.php:14
getUpdateObjective(Config $config=null)
Get the goal the agent wants to achieve on update.
if(!array_key_exists('PATH_INFO', $_SERVER)) $config
Definition: metadata.php:68
getBuildArtifactObjective()
Get the goal the agent wants to achieve to build artifacts.
getInstallObjective(Config $config=null)
Get the goals the agent wants to achieve on setup.
A agent is some component that performs part of the setup process.
Definition: Agent.php:13
hasConfig()
Does this agent require a configuration?
if($format !==null) $name
Definition: metadata.php:230
getMigrations()
Get a named map of migrations available for this Agent.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
getNamedObjective(string $name, Config $config=null)
Get a named objective from this agent.
A transformation is a function from one datatype to another.
A configuration for the setup.
Definition: Config.php:10