From 950745d4e91f2ffe67dceaad4526b07cfa441818 Mon Sep 17 00:00:00 2001
From: Thomas Gelf <thomas@gelf.net>
Date: Fri, 4 Mar 2016 18:08:37 +0100
Subject: [PATCH] Form/Element: introduce new element for sets

---
 .../views/helpers/FormExtensibleSet.php       | 212 ++++++++++++++++++
 .../Web/Form/Element/ExtensibleSet.php        |  34 +++
 .../Director/Web/Form/Element/FormElement.php |   9 +
 3 files changed, 255 insertions(+)
 create mode 100644 application/views/helpers/FormExtensibleSet.php
 create mode 100644 library/Director/Web/Form/Element/ExtensibleSet.php
 create mode 100644 library/Director/Web/Form/Element/FormElement.php

diff --git a/application/views/helpers/FormExtensibleSet.php b/application/views/helpers/FormExtensibleSet.php
new file mode 100644
index 00000000..befc9d46
--- /dev/null
+++ b/application/views/helpers/FormExtensibleSet.php
@@ -0,0 +1,212 @@
+<?php
+
+/**
+ * View helper for extensible sets
+ *
+ * Avoid complaints about class names:
+ * @codingStandardsIgnoreStart
+ */
+class Zend_View_Helper_FormExtensibleSet extends Zend_View_Helper_FormElement
+{
+    /**
+     * Generates an 'extensible set' element.
+     *
+     * @codingStandardsIgnoreEnd
+     *
+     * @param string|array $name If a string, the element name.  If an
+     * array, all other parameters are ignored, and the array elements
+     * are used in place of added parameters.
+     *
+     * @param mixed $value The element value.
+     *
+     * @param array $attribs Attributes for the element tag.
+     *
+     * @return string The element XHTML.
+     */
+    public function formExtensibleSet($name, $value = null, $attribs = null)
+    {
+        $info = $this->_getInfo($name, $value, $attribs);
+        extract($info); // name, value, attribs, options, listsep, disable
+
+        if (array_key_exists('multiOptions', $attribs)) {
+            $multiOptions = $attribs['multiOptions'];
+        } else {
+            $multiOptions = null;
+        }
+
+        if (array_key_exists('sorted', $attribs)) {
+            $sorted = (bool) $attribs['sorted'];
+        } else {
+            $sorted = false;
+        }
+
+        $disableStr = ' disabled="disabled"';
+
+        // build the element
+        $disabled = '';
+        if ($disable) {
+            // disabled
+            $disabled = $disableStr;
+        }
+
+        $elements = array();
+        $v = $this->view;
+        $values = array('group a', 'group b');
+        $name = $v->escape($name);
+        $id = $v->escape($id);
+
+        $cnt = 0;
+        $total = 0;
+        if (is_array($value)) {
+            $total = count($value);
+
+            foreach ($value as $val) {
+                if (! strlen($val)) {
+                    continue;
+                }
+
+                if ($multiOptions !== null) {
+                    if (array_key_exists($val, $multiOptions)) {
+                        unset($multiOptions[$val]);
+                    } else {
+                        continue; // Value no longer valid
+                    }
+                }
+
+                $suff = '_' . $cnt;
+                $htm = '<li><span class="inline-buttons">';
+
+                if ($sorted) {
+                    $htm .= $this->renderDownButton($name, $cnt, ($cnt === $total - 1 ? $disableStr : $disabled))
+                          . $this->renderUpButton($name, $cnt, ($cnt === 0 ? $disableStr : $disabled));
+                }
+                $htm .= $this->renderDeleteButton($name, $cnt, $disabled)
+                      . '</span>'
+                      . '<input type="text"'
+                      . ' name="' . $name . '[]"'
+                      . ' id="' . $id . $suff . '"'
+                      . ' value="' . $v->escape($val) . '"'
+                      . $disabled
+                      . $this->_htmlAttribs($attribs)
+                      . ' />'
+                      . '</li>';
+
+                $elements[] = $htm;
+                $cnt++;
+            }
+        }
+
+        $suff = '_' . $cnt;
+        if ($multiOptions) {
+            if (count($multiOptions) > 1 || strlen(key($multiOptions))) {
+                $htm = '<li>'
+                     . '<span class="inline-buttons">'
+                     . $this->renderAddButton($name, $disabled)
+                     . '</span>'
+                     . $v->formSelect(
+                         $name . '[]',
+                         null,
+                         array(
+                             'class'    => 'autosubmit' . ($cnt === 0 ? '' : ' extend-set'),
+                             'multiple' => false
+                         ),
+                         $multiOptions
+                     );
+
+                $elements[] = $htm;
+            }
+        } else {
+
+            $elements[] = '<li><input type="text"'
+                    . ' name="' . $name . '_add"'
+                    . ($cnt === 0 ? '' : ' class="extend-set"')
+                    . ' id="' . $id . $suff . '"'
+                    . ' placeholder="' . $v->translate('Add a new one...') . '"'
+                    . $disabled
+                    . $this->_htmlAttribs($attribs)
+                    . $this->getClosingBracket()
+                    . $this->renderAddButton($name, $disabled)
+                    . '</li>';
+        }
+
+        return '<ul class="extensible-set">' . "\n  "
+             . implode("\n  ", $elements)
+             . "</ul>\n";
+    }
+
+    public function moveUp($key)
+    {
+        var_dump("$key up");
+    }
+
+    public function moveDown($key)
+    {
+        var_dump("$key down");
+    }
+
+    public function removeKey($key)
+    {
+        var_dump("$key remove");
+    }
+
+    private function renderText($name, $id, $suff, $attribs, $disabled)
+    {
+        $v = $this->view;
+
+        return '<input type="text"'
+            . ' name="' . $name . '[]"'
+            . ' id="' . $id . $suff . '"'
+            . ' value="' . $v->escape($val) . '"'
+            . $disabled
+            . $this->_htmlAttribs($attribs)
+            . ' />';
+    }
+
+    private function renderAddButton($name, $disabled)
+    {
+        $v = $this->view;
+
+        return '<input type="submit" class="related-action"'
+            . ' name="' . $name . '_ADD"'
+            . ' value="&#xe805;"'
+            . ' title="' . $v->translate('Remove this entry') . '"'
+            . $disabled
+            . ' />';
+    }
+
+    private function renderDeleteButton($name, $cnt, $disabled)
+    {
+        $v = $this->view;
+
+        return '<input type="submit" class="related-action"'
+            . ' name="' . $name . '_' . $cnt . '__REMOVE' . '"'
+            . ' value="&#xe804;"'
+            . ' title="' . $v->translate('Remove this entry') . '"'
+            . $disabled
+            . ' />';
+    }
+
+    private function renderUpButton($name, $cnt, $disabled)
+    {
+        $v = $this->view;
+
+        return '<input type="submit" class="related-action"'
+            . ' name="' . $name . '_' . $cnt . '__MOVE_UP"'
+            . ' value="&#xe825;"'
+            . ' title="' . $v->translate('Move up') . '"'
+            . $disabled
+            . ' />';
+    }
+
+    private function renderDownButton($name, $cnt, $disabled)
+    {
+        $v = $this->view;
+
+        return '<input type="submit" class="related-action"'
+            . ' name="' . $name . '_' . $cnt . '__MOVE_DOWN"'
+            . ' value="&#xe828;"'
+            . ' title="' . $v->translate('Move down') . '"'
+            . $disabled
+            . ' />';
+    }
+}
diff --git a/library/Director/Web/Form/Element/ExtensibleSet.php b/library/Director/Web/Form/Element/ExtensibleSet.php
new file mode 100644
index 00000000..3b4ec311
--- /dev/null
+++ b/library/Director/Web/Form/Element/ExtensibleSet.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace Icinga\Module\Director\Web\Form\Element;
+
+/**
+ * Input control for extensible sets
+ */
+class ExtensibleSet extends FormElement
+{
+    /**
+     * Default form view helper to use for rendering
+     * @var string
+     */
+    public $helper = 'formExtensibleSet';
+
+   // private $multiOptions;
+
+    public function isValid($value, $context = null)
+    {
+        if ($value === null) {
+            $value = array();
+        }
+
+        $value = array_filter($value, 'strlen');
+        $this->setValue($value);
+        if ($this->isRequired() && empty($value)) {
+            // TODO: translate
+            $this->addError('You are required to choose at least one element');
+            return false;
+        }
+
+        return true;
+    }
+}
diff --git a/library/Director/Web/Form/Element/FormElement.php b/library/Director/Web/Form/Element/FormElement.php
new file mode 100644
index 00000000..c3278596
--- /dev/null
+++ b/library/Director/Web/Form/Element/FormElement.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Icinga\Module\Director\Web\Form\Element;
+
+use Zend_Form_Element_Xhtml;
+
+class FormElement extends Zend_Form_Element_Xhtml
+{
+}