summaryrefslogtreecommitdiffstats
path: root/library/Icinga/Data/Inspectable.php
diff options
context:
space:
mode:
Diffstat (limited to 'library/Icinga/Data/Inspectable.php')
-rw-r--r--library/Icinga/Data/Inspectable.php20
1 files changed, 20 insertions, 0 deletions
diff --git a/library/Icinga/Data/Inspectable.php b/library/Icinga/Data/Inspectable.php
new file mode 100644
index 0000000..d40ce57
--- /dev/null
+++ b/library/Icinga/Data/Inspectable.php
@@ -0,0 +1,20 @@
+<?php
+/* Icinga Web 2 | (c) 2015 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Data;
+
+/**
+ * An object for which the user can retrieve status information
+ *
+ * This interface is useful for providing summaries or diagnostic information about objects
+ * to users.
+ */
+interface Inspectable
+{
+ /**
+ * Inspect this object to gain extended information about its health
+ *
+ * @return Inspection The inspection result
+ */
+ public function inspect();
+}