Document DetailviewExtensionHook

refs #2104

Signed-off-by: Eric Lippmann <eric.lippmann@icinga.com>

modules/monitoring/doc/01-hooks/01-detailviewextension.md

@@ -0,0 +1,76 @@
+# <a id="detailviewextension"></a> Detail View Extension Hook
+
+## About
+
+This hook can be used to easily extend the detail view of monitored objects (hosts and services).
+
+## How it works
+
+### Directory structure
+
+* `icingaweb2/modules/example`
+    * `library/Example/ProvidedHook/Monitoring/DetailviewExtension/Simple.php`
+    * `run.php`
+
+### Files
+
+#### run.php
+
+```php
+<?php
+/** @var \Icinga\Application\Modules\Module $this */
+
+$this->provideHook(
+    'monitoring/DetailviewExtension',
+    'Icinga\Module\Example\ProvidedHook\Monitoring\DetailviewExtension\Simple'
+);
+```
+
+#### Simple.php
+
+```php
+<?php
+namespace Icinga\Module\Example\ProvidedHook\Monitoring\DetailviewExtension;
+
+use Icinga\Module\Monitoring\Hook\DetailviewExtensionHook;
+use Icinga\Module\Monitoring\Object\MonitoredObject;
+
+class Simple extends DetailviewExtensionHook
+{
+    public function getHtmlForObject(MonitoredObject $object)
+    {
+        $stats = array();
+        foreach (str_split($object->name) as $c) {
+            if (isset($stats[$c])) {
+                ++$stats[$c];
+            } else {
+                $stats[$c] = 1;
+            }
+        }
+
+        ksort($stats);
+
+        $view = $this->getView();
+
+        $thead = '';
+        $tbody = '';
+        foreach ($stats as $c => $amount) {
+            $thead .= '<th>' . $view->escape($c) . '</th>';
+            $tbody .= '<td>' . $amount . '</td>';
+        }
+
+        return '<h2>'
+            . $view->escape(sprintf($view->translate('A %s named "%s"'), $object->getType(), $object->name))
+            . '</h2>'
+            . '<h3>Character stats</h3>'
+            . '<table>'
+            . '<thead>' . $thead . '</thead>'
+            . '<tbody>' . $tbody . '</tbody>'
+            . '</table>';
+    }
+}
+```
+
+## How it looks like
+
+![Screenshot](res/detailviewextension-01.png)