ILIAS  release_7 Revision v7.30-3-g800a261c036
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
5namespace ILIAS\Setup;
6
8use ILIAS\UI;
9
13interface 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
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}
An exception for terminatinating execution or to throw for unit testing.
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:14
getMigrations()
Get a named map of migrations available for this Agent.
hasConfig()
Does this agent require a configuration?
getNamedObjective(string $name, Config $config=null)
Get a named objective from this agent.
getArrayToConfigTransformation()
Agents must be able to tell how to create a configuration from a nested array.
getInstallObjective(Config $config=null)
Get the goals the agent wants to achieve on setup.
getBuildArtifactObjective()
Get the goal the agent wants to achieve to build artifacts.
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:11
An objective is a desired state of the system that is supposed to be created by the setup.
Definition: Objective.php:15
if($format !==null) $name
Definition: metadata.php:230
if(!array_key_exists('PATH_INFO', $_SERVER)) $config
Definition: metadata.php:68
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...