Add class BadgeNavigationItemRenderer

refs #5600

library/Icinga/Web/Navigation/Renderer/BadgeNavigationItemRenderer.php

@@ -0,0 +1,118 @@
+<?php
+/* Icinga Web 2 | (c) 2013-2015 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Web\Navigation\Renderer;
+
+use Icinga\Web\Navigation\NavigationItem;
+
+/**
+ * Abstract base class for a NavigationItem with a status badge
+ */
+abstract class BadgeNavigationItemRenderer extends NavigationItemRenderer
+{
+    const STATE_OK = 'ok';
+    const STATE_CRITICAL = 'critical';
+    const STATE_WARNING = 'warning';
+    const STATE_PENDING = 'pending';
+    const STATE_UNKNOWN = 'unknown';
+
+    /**
+     * The tooltip text for the badge
+     *
+     * @var string 
+     */
+    protected $title;
+
+    /**
+     * The state identifier being used
+     *
+     * The state identifier defines the background color of the badge.
+     *
+     * @var string 
+     */
+    protected $state;
+
+    /**
+     * Set the tooltip text for the badge
+     *
+     * @param   string  $title
+     *
+     * @return  $this
+     */
+    public function setTitle($title)
+    {
+        $this->title = $title;
+        return $this;
+    }
+
+    /**
+     * Return the tooltip text for the badge
+     *
+     * @return  string
+     */
+    public function getTitle()
+    {
+        return $this->title;
+    }
+
+    /**
+     * Set the state identifier to use
+     *
+     * @param   string  $state
+     *
+     * @return  $this
+     */
+    public function setState($state)
+    {
+        $this->state = $state;
+        return $this;
+    }
+
+    /**
+     * Return the state identifier to use
+     *
+     * @return  string
+     */
+    public function getState()
+    {
+        return $this->state;
+    }
+
+    /**
+     * Return the amount of items represented by the badge
+     *
+     * @return  int
+     */
+    abstract public function getCount();
+
+    /**
+     * Render the given navigation item as HTML anchor with a badge
+     *
+     * @param   NavigationItem  $item
+     *
+     * @return  string
+     */
+    public function render(NavigationItem $item = null)
+    {
+        return $this->renderBadge() . parent::render($item);
+    }
+
+    /**
+     * Render the badge
+     *
+     * @return  string
+     */
+    protected function renderBadge()
+    {
+        if (($count = $this->getCount()) > 0) {
+            return sprintf(
+                '<div title="%s" class="badge-container"><span class="badge badge-%s">%s</span></div>',
+                $this->getView()->escape($this->getTitle()),
+                $this->getView()->escape($this->getState()),
+                $count
+            );
+        }
+
+        return '';
+    }
+}