add fieldtype for simple selections (iunterfaces etc.)

src/opnsense/mvc/app/models/OPNsense/Base/FieldTypes/CSVListField.php

@@ -0,0 +1,116 @@
+<?php
+/**
+ *    Copyright (C) 2015 Deciso B.V.
+ *
+ *    All rights reserved.
+ *
+ *    Redistribution and use in source and binary forms, with or without
+ *    modification, are permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice,
+ *       this list of conditions and the following disclaimer.
+ *
+ *    2. Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *
+ *    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ *    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ *    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ *    AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ *    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *    POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+namespace OPNsense\Base\FieldTypes;
+
+use Phalcon\Validation\Validator\Regex;
+
+/**
+ * Class CSVListField
+ * Physical stored as a single entry, stores multiple selections.
+ * @package OPNsense\Base\FieldTypes
+ */
+class CSVListField extends BaseField
+{
+    /**
+     * @var bool marks if this is a data node or a container
+     */
+    protected $internalIsContainer = false;
+
+    /**
+     * item separator
+     * @var string
+     */
+    private $separatorchar = ",";
+
+    /**
+     * selectable options, key/value store.
+     * value = display option
+     */
+    private $selectOptions = array();
+
+    /**
+     * retrieve data including selection options (from setSelectOptions)
+     * @return array
+     */
+    public function getNodeData()
+    {
+        $result = array ();
+        $selectlist = explode($this->separatorchar, $this->__toString());
+
+        foreach ($this->selectOptions as $optKey => $optValue) {
+            $result[$optKey] = array("value"=>$optValue, "selected"=>0);
+        }
+
+        foreach ($selectlist as $optKey) {
+            if (strlen($optKey) > 0) {
+                if (array_key_exists($optKey, $result)) {
+                    $result[$optKey]["selected"] = 1;
+                } else {
+                    $result[$optKey] = array("value"=>$optKey, "selected" => 1);
+                }
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * set all options for this select item.
+     * push a key/value array type to set all options or deliver a comma separated list with keys and optional values
+     * divided by a pipe | sign.
+     * example :    optionA|text for option A, optionB|test for option B
+     * @param array|string $list key/value option list
+     */
+    public function setSelectOptions($list)
+    {
+        if (is_array($list)) {
+            foreach ($list as $optKey => $optValue) {
+                $this->selectOptions[$optKey] = $optValue;
+            }
+        } else {
+            // string list
+            foreach (explode($this->separatorchar, $list) as $option) {
+                if (strpos($option, "|") !== false) {
+                    $tmp = explode("|", $option);
+                    $this->selectOptions[$tmp[0]] = $tmp[1];
+                } else {
+                    $this->selectOptions[$option] = $option;
+                }
+            }
+        }
+    }
+
+    /**
+     * @return array returns validators
+     */
+    public function getValidators()
+    {
+        return array() ;
+    }
+}