summaryrefslogtreecommitdiffstats
path: root/modules/setup/library/Setup/Step.php
diff options
context:
space:
mode:
Diffstat (limited to 'modules/setup/library/Setup/Step.php')
-rw-r--r--modules/setup/library/Setup/Step.php31
1 files changed, 31 insertions, 0 deletions
diff --git a/modules/setup/library/Setup/Step.php b/modules/setup/library/Setup/Step.php
new file mode 100644
index 0000000..4b9afcc
--- /dev/null
+++ b/modules/setup/library/Setup/Step.php
@@ -0,0 +1,31 @@
+<?php
+/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Module\Setup;
+
+/**
+ * Class to implement functionality for a single setup step
+ */
+abstract class Step
+{
+ /**
+ * Apply this step's configuration changes
+ *
+ * @return bool
+ */
+ abstract public function apply();
+
+ /**
+ * Return a HTML representation of this step's configuration changes supposed to be made
+ *
+ * @return string
+ */
+ abstract public function getSummary();
+
+ /**
+ * Return a textual summary of all configuration changes made
+ *
+ * @return ?array
+ */
+ abstract public function getReport();
+}