ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
All Data Structures Namespaces Files Functions Variables Modules Pages
NullObjective.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 
7 use ILIAS\UI;
8 
12 class NullObjective implements Objective
13 {
14  const LABEL = "Nothing to do.";
15 
16  public function getHash() : string
17  {
18  return "null-objective";
19  }
20 
21  public function getLabel() : string
22  {
23  return self::LABEL;
24  }
25 
26  public function isNotable() : bool
27  {
28  return false;
29  }
30 
31  /*
32  * @inheritdocs
33  */
34  public function getPreconditions(Environment $environment) : array
35  {
36  return [];
37  }
38 
42  public function achieve(Environment $environment) : Environment
43  {
44  return $environment;
45  }
46 }
An objective is a desired state of the system that is supposed to be created by the setup...
Definition: Objective.php:14
achieve(Environment $environment)
isNotable()
Get to know if this is an interesting objective for a human.
getHash()
Get a hash for this objective.
A non-objective, nothing to do to achieve it...
getPreconditions(Environment $environment)
Objectives might depend on other objectives.
getLabel()
Get a label that describes this objective.
An environment holds resources to be used in the setup process.
Definition: Environment.php:11