Adding upstream version 1.0.2.upstream/1.0.2upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 165 insertions, 0 deletions

diff --git a/library/Icingadb/Common/BaseListItem.php b/library/Icingadb/Common/BaseListItem.php
new file mode 100644
index 0000000..c552bb6
--- /dev/null
+++ b/library/Icingadb/Common/BaseListItem.php
@@ -0,0 +1,165 @@
+<?php
+
+/* Icinga DB Web | (c) 2020 Icinga GmbH | GPLv2 */
+
+namespace Icinga\Module\Icingadb\Common;
+
+use Icinga\Module\Icingadb\Common\BaseItemList;
+use ipl\Html\BaseHtmlElement;
+use ipl\Html\Html;
+use ipl\Html\HtmlElement;
+use ipl\Stdlib\Filter\Rule;
+use ipl\Web\Filter\QueryString;
+
+/**
+ * Base class for list items
+ */
+abstract class BaseListItem extends BaseHtmlElement
+{
+    protected $baseAttributes = ['class' => 'list-item'];
+
+    /** @var object The associated list item */
+    protected $item;
+
+    /** @var BaseItemList The list where the item is part of */
+    protected $list;
+
+    protected $tag = 'li';
+
+    /**
+     * Create a new list item
+     *
+     * @param object       $item
+     * @param BaseItemList $list
+     */
+    public function __construct($item, BaseItemList $list)
+    {
+        $this->item = $item;
+        $this->list = $list;
+
+        $this->addAttributes($this->baseAttributes);
+
+        $this->init();
+    }
+
+    abstract protected function assembleHeader(BaseHtmlElement $header);
+
+    abstract protected function assembleMain(BaseHtmlElement $main);
+
+    protected function assembleFooter(BaseHtmlElement $footer)
+    {
+    }
+
+    protected function assembleCaption(BaseHtmlElement $caption)
+    {
+    }
+
+    protected function assembleIconImage(BaseHtmlElement $iconImage)
+    {
+    }
+
+    protected function assembleTitle(BaseHtmlElement $title)
+    {
+    }
+
+    protected function assembleVisual(BaseHtmlElement $visual)
+    {
+    }
+
+    protected function createCaption(): BaseHtmlElement
+    {
+        $caption = Html::tag('section', ['class' => 'caption']);
+
+        $this->assembleCaption($caption);
+
+        return $caption;
+    }
+
+    protected function createHeader(): BaseHtmlElement
+    {
+        $header = Html::tag('header');
+
+        $this->assembleHeader($header);
+
+        return $header;
+    }
+
+    protected function createMain(): BaseHtmlElement
+    {
+        $main = Html::tag('div', ['class' => 'main']);
+
+        $this->assembleMain($main);
+
+        return $main;
+    }
+
+    protected function createFooter(): BaseHtmlElement
+    {
+        $footer = new HtmlElement('footer');
+
+        $this->assembleFooter($footer);
+
+        return $footer;
+    }
+
+    /**
+     * @return ?BaseHtmlElement
+     */
+    protected function createIconImage()
+    {
+        if (! $this->list->hasIconImages()) {
+            return null;
+        }
+
+        $iconImage = HtmlElement::create('div', [
+            'class' => 'icon-image',
+        ]);
+
+        $this->assembleIconImage($iconImage);
+
+        return $iconImage;
+    }
+
+    protected function createTimestamp()
+    {
+    }
+
+    protected function createTitle(): BaseHtmlElement
+    {
+        $title = HTML::tag('div', ['class' => 'title']);
+
+        $this->assembleTitle($title);
+
+        return $title;
+    }
+
+    /**
+     * @return ?BaseHtmlElement
+     */
+    protected function createVisual()
+    {
+        $visual = Html::tag('div', ['class' => 'visual']);
+
+        $this->assembleVisual($visual);
+
+        return $visual;
+    }
+
+    /**
+     * Initialize the list item
+     *
+     * If you want to adjust the list item after construction, override this method.
+     */
+    protected function init()
+    {
+    }
+
+    protected function assemble()
+    {
+        $this->add([
+            $this->createVisual(),
+            $this->createIconImage(),
+            $this->createMain()
+        ]);
+    }
+}